tencent cloud

APIs

DocumentationAPIsCloud Security CenterContainer Asset Management APIsDescribeClusterInstallCommand

DescribeClusterInstallCommand

Download
Focus Mode
Font Size
Last updated: 2026-09-01 10:19:37

1. API Description

Domain name for API request: csip.intl.tencentcloudapi.com.

Query the cluster installation command

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeClusterInstallCommand.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
IsCloud Yes Boolean

Whether it is Tencent Cloud. true: use the parallel container daemonset yaml installation branch; false: use the host agent installation command branch
MemberId.N No Array of String

Group account member id
NetType No String

Network type
Enumeration values:
basic: basic network
private: VPC
public: public network
direct: direct connect
RegionCode No String

Region code (required when NetType=direct; used by the Tencent Cloud branch for special region mirror repository replacement)
VpcId No String

VPC ID (required when NetType=direct)
Parameter format: in the form of vpc-xxxxxxxx
ExpireDate No String

Expiration time
Parameter format: yyyy-MM-dd (for example, 2026-12-31)
Purpose: For the Tencent Cloud branch, it is the expiration time of the cos download link for the daemonset yaml; for the non-Tencent Cloud branch, it is the expiration time of the agent installation token
TagIds.N No Array of Integer

List of csip tag IDs (for non-Tencent Cloud branches, associate installation tags)
ClusterCustomParameters.N No Array of ClusterCustomParameters

Cluster custom parameters (Tencent Cloud branch used for replacing daemonset template placeholders)
Vip No String

Integration VIP (used by non-Tenant Cloud branches; automatically applied for by the DC service when NetType=direct and Vip is not passed)

3. Output Parameters

Parameter Name Type Description
Command String

Access command.
URL String

File download link integration
FileContent String

Integrate file content
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Query the cluster installation command

Input Example

POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterInstallCommand
<Common request parameters>

{
    "IsCloud": true,
    "NetType": "public",
    "ClusterCustomParameters": [
        {
            "Name": "k8s_name",
            "Values": [
                "my-cluster"
            ]
        }
    ],
    "VpcId": "vpc-********"
}

Output Example

{
    "Response": {
        "Command": "kubectl apply -f 'https://csip-test-**********.cos-internal.ap-guangzhou.tencentcos.cn/ota-server/httpapi-files/damenset-********/agent-daemonset-********************.y******Am**********************S***5***-*********n*i***A***G*OBmLhro********L*****************202*************************%2F*************************0260622T045526Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&response-content-disposition=attachment&X-Amz-Signature=768077aa5485163ac72a769950fca7b732ff58f3046ec5a5f73b263c9f61692d'",
        "FileContent": "LS0tCmFwaVZlcnNpb246IHYxCmtpbmQ6IE5hbWVzcGFjZQptZXRhZGF0YToKIC************************Bp***************************pem**************************OiB**************************WV*******************************************************************************************************************JdCiAgICByZX*vdXJjZXM6IFsiKiJdCiAgICB2ZXJ*s: ["get", "list", "watch", "create", "update", "patch", "delete"]

---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
  name: tcss-admin-rb
  namespace: tcss
subjects:
  - kind: ServiceAccount
    name: tcss-agent
    namespace: tcss
    apiGroup: ""
roleRef:
  kind: Role
  name: tcss-admin
  apiGroup: rbac.authorization.k8s.io

---
apiVersion: v1
kind: ServiceAccount
metadata:
  name: tcss-agent
  namespace: tcss
secrets:
  - name: tcss-agent-secret

---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: security-clusterrole
rules:
  - apiGroups: ["", "v1"]
    resources:
      [
        "namespaces",
        "pods",
        "nodes",
        "services",
        "serviceaccounts",
        "configmaps",
        "componentstatuses",
      ]
    verbs: ["get", "list", "watch"]
  - apiGroups:
      [
        "apps",
        "batch",
        "extensions",
        "rbac.authorization.k8s.io",
        "networking.k8s.io",
        "cilium.io",
      ]
    resources: ["*"]
    verbs: ["get", "list", "watch"]
  - apiGroups: ["networking.k8s.io"]
    resources: ["networkpolicies"]
    verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
  - apiGroups: ["apiextensions.k8s.io"]
    resources: ["customresourcedefinitions"]
    verbs: ["list", "get", "create"]
  - apiGroups: ["apiextensions.k8s.io"]
    resourceNames:
      ["tracingpolicies.cilium.io", "tracingpoliciesnamespaced.cilium.io"]
    resources: ["customresourcedefinitions"]
    verbs: ["list", "get", "update"]

---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: security-clusterrolebinding
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: security-clusterrole
subjects:
  - kind: ServiceAccount
    name: tcss-agent
    namespace: tcss
  - kind: User
    name: tcss
    apiGroup: rbac.authorization.k8s.io

---
apiVersion: v1
kind: Secret
metadata:
  name: tcss-agent-secret
  namespace: tcss
  annotations:
    kubernetes.io/service-account.name: tcss-agent
type: kubernetes.io/service-account-token

---
apiVersion: batch/v1
kind: Job
metadata:
  name: init-tcss-agent
  namespace: tcss
spec:
  template:
    spec:
      serviceAccountName: tcss-agent
      tolerations:
        - operator: Exists
      affinity:
        nodeAffinity:
          requiredDuringSchedulingIgnoredDuringExecution:
            nodeSelectorTerms:
              - matchExpressions:
                  - key: type
                    operator: NotIn
                    values:
                      - virtual-kubelet
      containers:
        - image: ccr.ccs.tencentyun.com/yunjing_agent/agent:latest
          imagePullPolicy: Always
          name: init-tcss-agent
          command: ["/home/work/yunjing-agent"]
          args: ["-token", "", "-vip", "", "-cc"]
          resources:
            limits:
              cpu: 100m
              memory: 512Mi
            requests:
              cpu: 100m
              memory: 128Mi
          env:
            - name: user_tags
              value: "default"
            - name: k8s_name
              value: "my-cluster"
            - name: appid
              value: "260083796"
          securityContext:
            privileged: true
          volumeMounts:
            - mountPath: /run/secrets/kubernetes.io/tcss-agent
              name: token-projection
      securityContext: {}
      hostPID: true
      hostNetwork: true
      restartPolicy: Never
      volumes:
        - name: token-projection
          secret:
            secretName: tcss-agent-secret
  backoffLimit: 5

---
apiVersion: apps/v1
kind: DaemonSet
metadata:
  labels:
    k8s-app: yunjing-agent
  name: yunjing-agent
  namespace: tcss
  annotations:
    config.kubernetes.io/depends-on: batch/v1/namespaces/tcss/jobs/init-tcss-secrets
spec:
  updateStrategy:
    type: RollingUpdate
    rollingUpdate:
      maxUnavailable: 20%
  selector:
    matchLabels:
      k8s-app: yunjing-agent
  template:
    metadata:
      annotations:
        eks.tke.cloud.tencent.com/ds-injection: "true"
      labels:
        k8s-app: yunjing-agent
    spec:
      tolerations:
        - operator: Exists
      affinity:
        nodeAffinity:
          requiredDuringSchedulingIgnoredDuringExecution:
            nodeSelectorTerms:
              - matchExpressions:
                  - key: type
                    operator: NotIn
                    values:
                      - virtual-kubelet
      containers:
        - image: ccr.ccs.tencentyun.com/yunjing_agent/agent:latest
          imagePullPolicy: Always
          name: yunjing-agent
          command: ["/home/work/yunjing-agent"]
          args: ["-d", "-token", "", "-vip", ""]
          resources:
            limits:
              cpu: 250m
              memory: 512Mi
            requests:
              cpu: 100m
              memory: 128Mi
          securityContext:
            privileged: true
          terminationMessagePath: /dev/termination-log
          terminationMessagePolicy: File
      dnsPolicy: ClusterFirst
      restartPolicy: Always
      schedulerName: default-scheduler
      securityContext: {}
      terminationGracePeriodSeconds: 30
      hostNetwork: true
      hostPID: true
      hostIPC: true

---
apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    k8s-app: tcss-asset
  name: tcss-asset
  namespace: tcss
spec:
  selector:
    matchLabels:
      k8s-app: tcss-asset
  replicas: 1
  template:
    metadata:
      labels:
        k8s-app: tcss-asset
      annotations:
        eks.tke.cloud.tencent.com/ds-injection: "true"
    spec:
      serviceAccountName: tcss-agent
      tolerations:
        - operator: Exists
      affinity:
        nodeAffinity:
          requiredDuringSchedulingIgnoredDuringExecution:
            nodeSelectorTerms:
              - matchExpressions:
                  - key: type
                    operator: NotIn
                    values:
                      - virtual-kubelet
      containers:
        - image: ccr.ccs.tencentyun.com/yunjing_agent/agent:latest
          imagePullPolicy: Always
          name: tcss-asset
          command: ["/home/work/yunjing-agent"]
          args: ["-asset"]
          resources:
            limits:
              cpu: 100m
              memory: 256Mi
            requests:
              cpu: 50m
              memory: 64Mi
          securityContext:
            privileged: true
          terminationMessagePath: /dev/termination-log
          terminationMessagePolicy: File
      dnsPolicy: ClusterFirst
      restartPolicy: Always
      schedulerName: default-scheduler
      securityContext: {}
      terminationGracePeriodSeconds: 30
      hostPID: true
",
        "URL": "https://csip-test-**********.cos-internal.ap-guangzhou.tencentcos.cn/ota-server/httpapi-files/damenset-20260622/agent-daemonset-*****************126.yaml?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=************************************%******0622*********ng**************************-Am**D************************mz-Expires=86400&X-Amz-SignedHeaders=host&response-content-disposition=attachment&X-Amz-Signature=768077aa5485163ac72a769950fca7b732ff58f3046ec5a5f73b263c9f61692d",
        "RequestId": "c09ed746-4afd-48e9-be75-5c4a53954508"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter Parameter error.
Previous Topic: UninstallClusterAgentNext Topic: DescribeSkillScanAlertDetail

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback