tencent cloud

1. API Description

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

This API is used to install an add-on on the target cluster.

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

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.

3. Output Parameters

4. Example

Example1 Install the cbs Component

When installing the cbs component, it is supported to configure custom parameters through RawValues. For example, to set tolerance scheduling, you can encode {"tolerations":[{"effect":"NoExecute","key":"gpu-not-ready","operator":"Equal","tolerationSeconds":300,"value":"true"},{"key":"ip-not-ready","operator":"Exists"}]} in base64 and put it into the RawValues parameter. The custom parameters supported by the cbs component are described as follows:: { "tolerations": [ { "effect": "string, for example: NoExecute", "key": "string, tag key, for example: gpu-not-ready", "operator": "string, for example: Equal", "tolerationSeconds": "int, for example: 300", "value": "string, tag value, for example: true" }, { "key": "string, tag key, for example: ip-not-ready", "operator": "string, for example: Exists" } ] }

Input Example

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

{
    "ClusterId": "cls-12345678",
    "AddonName": "cbs",
    "RawValues": "eyJ0b2xlcmF0aW9ucyI6W3siZWZmZWN0IjoiTm9FeGVjdXRlIiwia2V5IjoiZ3B1LW5vdC1yZWFkeSIsIm9wZXJhdG9yIjoiRXF1YWwiLCJ0b2xlcmF0aW9uU2Vjb25kcyI6MzAwLCJ2YWx1ZSI6InRydWUifSx7ImtleSI6ImlwLW5vdC1yZWFkeSIsIm9wZXJhdG9yIjoiRXhpc3RzIn1dfQ=="
}

Output Example

{
    "Response": {
        "RequestId": "b583f05e-d4f4-4963-8082-b651605hg432"
    }
}

Example2 Install the eniipamd Component

When installing the eniipamd component, it is supported to configure custom parameters through RawValues. For example, to add a security group, you can encode {"vpcCni":{"securityGroups":{"securityGroups":["sg-qbc3zefo"]}}} in base64 and put it into the RawValues parameter.The custom parameters supported by the eniipamd component are described as follows:{"clusterId": "string, Cluster ID, for example: cls-12345678", "vpcCni": {"vpcId": "string, the ID of the VPC, such as: vpc-qbc3zefo","enableVpcCni": "bool, whether to enable VPC CNI, for example: true", "routeEni": {"ipMinWarmTarget": "int, the minimum prebound value for the auxiliary IP of the shared network interface of the new nodes, for example: 5","ipMaxWarmTarget": "int, the maximum pre-bound value of auxiliary IP for shared network interface of new nodes, for example: 5" }, "ipam": {"subnetIds": "array, subnet ID list used for IP address allocation, for example: [\"subnet-qbc3zefo\"]" }, "securityGroups": {"enableSecurityGroups": "bool, whether to enable security groups, for example: true", "securityGroups": "array, security group IDs, for example: [\"sg-qbc3zefo\"]" } }, "agent": { "kubeClient": {"masterAddr": "string, primary node address of kubeClient, for example: 169.254.128.54:60002" } }}

Input Example

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

{
    "ClusterId": "cls-12345678",
    "AddonName": "eniipamd",
    "RawValues": "eyJ2cGNDbmkiOnsic2VjdXJpdHlHcm91cHMiOnsic2VjdXJpdHlHcm91cHMiOlsic2ctMTIzNDU2NzgiXX19fQ=="
}

Output Example

{
    "Response": {
        "RequestId": "b583f05e-d4f4-4963-8082-b651605jh275"
    }
}

Example3 Install the tcr Component

When installing the tcr component, it is supported to configure custom parameters through RawValues, such as imagePullSecretsCrs. The custom parameters supported by the tcr component are described as follows:{ "global": { "imagePullSecretsCrs": [ {"name": "string, the name of imagePullSecretsCr, for example: tcr-qbc3zefo-public","namespaces": "string, the scope of application for password-free access. For example: * indicates all namespaces.","serviceAccounts": "string, the scope of the password-free feature role, for example: * indicates all k8s service accounts","type": "string, must be 'docker'","dockerUsername": "string, the login username for the mirror repository","dockerPassword": "string, image repository login password","dockerServer": "string, the address of the image registry server" } ] }}

Input Example

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

{
    "ClusterId": "cls-12345678",
    "AddonName": "tcr",
    "RawValues": "eyJnbG9iYWwiOnsiaW1hZ2VQdWxsU2VjcmV0c0NycyI6W3sibmFtZSI6InRjci1kZzI4NGltcS1wdWJsaWMiLCJuYW1lc3BhY2VzIjoiKiIsInNlcnZpY2VBY2NvdW50cyI6IioiLCJ0eXBlIjoiZG9ja2VyIiwiZG9ja2VyVXNlcm5hbWUiOiIxMDAwMTQzNjQ4MjIiLCJkb2NrZXJQYXNzd29yZCI6IjEyMzQ1Njc4IiwiZG9ja2VyU2VydmVyIjoibmljb2thbmctdGNyLWd6LnRlbmNlbnRjbG91ZGNyLmNvbSJ9XX19"
}

Output Example

{
    "Response": {
        "RequestId": "b583f05e-d4f4-4963-8082-b651605ca765"
    }
}

Example4 Install the tke-log-agent Component

When installing the tke-log-agent component, it is supported to configure custom parameters through RawValues. For example, to enable kafkalistener, you can encode {"kafkalistener":{"enabled":true}} in base64 and put it into the RawValues parameter. The custom parameters supported by the tke-log-agent component are described as follows:{ "global": {"clsHost": "string, cls service domain name, for example: ap-chengdu.cls.tencentyun.com", "cluster": {"clustertype": "string, cluster management type, for example: MANAGED_CLUSTER or INDEPENDENT_CLUSTER","kubeminor": "string, cluster edition, for example: minor 30.0","kubeversion": "string, the k8s version of the cluster, for example: 1.30.0","type": "string, cluster type, for example: tke or eks" },"clusterID": "string, Cluster ID, for example: cls-12345678","hostNetwork": "bool, whether to use hostNetwork, for example: false","localRegion": "string, the region of the cluster, for example: ap-chengdu","registry": "string, mirror repository, for example: ccr.ccs.tencentyun.com","sources": "string, authentication method, for example: norm" }, "kafkalistener": {"enabled": "bool, whether to enable kafka listener, for example: true" }, "logAgent": {"enabled": "bool, whether to enable logAgent, for example: true" }, "loglistener": {"enabled": "bool, whether to enable loglistener, for example: false" }, "provisioner": {"replicaCount": "int, the number of cls-provisioner replicas, for example: 2","sources": "string, the authentication method for cls-provisioner, for example: norm" }}

Input Example

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

{
    "ClusterId": "cls-12345678",
    "AddonName": "tke-log-agent",
    "RawValues": "eyJrYWZrYWxpc3RlbmVyIjp7ImVuYWJsZWQiOnRydWV9fQ=="
}

Output Example

{
    "Response": {
        "RequestId": "b583f05e-d4f4-4963-8082-b651605ca427"
    }
}

5. Developer Resources

SDK

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

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.