tencent cloud

APIs

DocumentationAPIsCloud Security CenterContainer Asset Management APIsInstallClusterAgent

InstallClusterAgent

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

1. API Description

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

Install Agent for cluster container security (parallel container installation method).

capi layer processing process:

  1. Query the DB cluster list by ClusterCaMD5List (only used for resolving the appid ownership of each cluster, not for existence/type verification)
  2. Group by appid and pass through to the access side ClusterInstall RPC

Description (container asset revision 2026 H1): This API is a passthrough API. The capi layer does not verify the existence, data type, or format of ClusterCaMD5. ClusterCaMD5 values that miss in the DB are silently skipped with no error reported.

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: InstallClusterAgent.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
ClusterCaMD5List.N Yes Array of String

cluster CA certificate MD5 list (single/batch unified)
Purpose: specify the cluster where the container security Agent needs to be installed (parallel container method)
Value reference: obtain it through the ClusterCaMD5 field in the response of the DescribeClusterListV2 API
Description: The capi layer does not verify the existence or type of this field. It passes it through to the access side ClusterInstall RPC as cluster_CA_MD5
MemberId.N No Array of String

Group account member id

3. Output Parameters

Parameter Name Type Description
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 Install a Single Cluster Container Security Agent

Import one ClusterCaMD5 for container security Agent cluster installation.

Input Example

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

{
    "ClusterCaMD5List": [
        "e3b0c44298fc1c149afbf4c8996fb924"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "c368eae2-8739-4cc2-b4f8-8f4284a93b41"
    }
}

Example2 Batch Install Multiple Cluster Container Security Agents

Import multiple ClusterCaMD5 for container security Agent batch installation.

Input Example

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

{
    "ClusterCaMD5List": [
        "e3b0c44298fc1c149afbf4c8996fb924",
        "d41d8cd98f00b204e9800998ecf8427e"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "d479fbf3-9840-4dd3-c5f9-9f5395ba4c52"
    }
}

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: CreatePodServiceListExportJobNext Topic: CreateClusterContainerListExportJob

Help and Support

Was this page helpful?

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

Feedback