DescribeClusterKubeconfig

最后更新时间：2024-11-14 14:53:30

1. API Description

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.

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: DescribeClusterKubeconfig.
Version	Yes	String	Common Params. The value used for this API: 2018-05-25.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
ClusterId	Yes	String	Cluster ID
IsExtranet	No	Boolean	Defaults to `false`, which means to obtain the kubeconfig of private network

3. Output Parameters

Parameter Name	Type	Description
Kubeconfig	String	Sub-account kubeconfig file can be used to access the cluster kube-apiserver directly (if the "IsExtranet" parameter is false, it returns the kubeconfig for private network access, and the server will be a default domain name if the private network is not enabled; if the "IsExtranet" parameter is true, it returns the kubeconfig for public network access, and the server will be a default domain name if the public network is not enabled. The default domain name is not accessible by default and needs to be handled by the user).
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 Obtaining the cluster kubeconfig file

This example shows you how 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.

Input Example

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

{
    "ClusterId": "cls-65r1c5nu"
}

Output Example

{
    "Response": {
        "Kubeconfig": "[REDACTED]",
        "RequestId": "33483fde-efec-4d3c-8ff6-340d9dbc2d01"
    }
}

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

Tencent Cloud CLI 3.0

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
FailedOperation.ComponentClientHttp	Internal HTTP client error.
FailedOperation.KubeCommon	Kubernetes API error.
FailedOperation.KubernetesClientBuildError	Failed to create the Kubernetes client.
FailedOperation.UnexpectedError	Unexpected error.
InternalError	Internal error.
InternalError.CamNoAuth	You do not have permissions.
InternalError.ComponentClientHttp	Internal HTTP client error
InternalError.Db	DB error.
InternalError.KubeClientConnection	Failed to connect to the user’s Kubernetes cluster.
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	The resource does not exist.
ResourceNotFound.ClusterNotFound	The cluster does not exist.
ResourceNotFound.KubernetesResourceNotFound	The kubernetes resource does not exist.
ResourceUnavailable.ClusterInAbnormalStat	Abnormal cluster status.
UnauthorizedOperation.CamNoAuth	The API has no CAM permissions.

tencent cloud

Recent Pages