Domain name for API request: tke.tencentcloudapi.com.
This API is used to obtain the cluster kubeconfig file. Different sub-accounts have their own kubeconfig files. The kubeconfig file contains the kube-apiserver client certificate of the corresponding sub-account. By default, the client certificate is created when this API is called for the first time, and the certificate is valid for 20 years with no permissions granted. For the cluster owner or primary account, the cluster-admin permission is granted by default.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: tke.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: DescribeClusterKubeconfig. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-05-25. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| ClusterId | Yes | String | Cluster ID |
| Parameter Name | Type | Description |
|---|---|---|
| Kubeconfig | String | Sub-account kubeconfig file, used to access the cluster kube-apiserver directly |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://tke.tencentcloudapi.com/?Action=DescribeClusterKubeconfig
&ClusterId=cls-65r1c5nu
&<Common request parameters>
{
"Response": {
"Kubeconfig": "xxx",
"RequestId": "33483fde-efec-4d3c-8ff6-340d9dbc2d01"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| InternalError.CamNoAuth | You do not have permissions. |
| InternalError.Db | DB error. |
| InternalError.KubernetesClientBuildError | Failed to create the kubernetes client. |
| InternalError.KubernetesCreateOperationError | Failed to create the kubernetes resource. |
| InternalError.KubernetesDeleteOperationError | Failed to delete the kubernetes resource. |
| InternalError.UnexpectedInternal | Unknown internal error. |
| InternalError.WhitelistUnexpectedError | Unknown allowlist error |
| InvalidParameter | Parameter error. |
| InvalidParameter.ClusterNotFound | The cluster ID does not exist. |
| InvalidParameter.Param | Invalid parameter. |
| ResourceNotFound.ClusterNotFound | The cluster does not exist. |
| ResourceNotFound.KubernetesResourceNotFound | The kubernetes resource does not exist. |
| UnauthorizedOperation.CamNoAuth | The API has no CAM permissions. |
Was this page helpful?