Domain name for API request: tke.tencentcloudapi.com.
This API is used to obtain the authentication information of a TKE Edge cluster.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeTKEEdgeClusterCredential. |
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 |
Parameter Name | Type | Description |
---|---|---|
Addresses | Array of IPAddress | Access address of the cluster Note: This field may return null , indicating that no valid values can be obtained. |
Credential | ClusterCredential | Cluster authentication information |
PublicLB | EdgeClusterPublicLB | Public network access information of the cluster |
InternalLB | EdgeClusterInternalLB | Private network access information of the cluster |
CoreDns | String | CoreDns deployment information of the cluster |
HealthRegion | String | Multi-region health check deployment information of the cluster |
Health | String | Health check deployment information of the cluster |
GridDaemon | String | Whether to deploy GridDaemon to support headless service |
UnitCluster | String | Access kins clusters over the public network |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to obtain access authentication information of an edge cluster, including the kubeconfig file.
https://tke.tencentcloudapi.com/?Action=DescribeTKEEdgeClusterCredential
&ClusterId=cls-1234abcd
&<Common request parameters>
{
"Response": {
"Addresses": [
{
"Type": "advertise",
"Ip": "169.254.128.200",
"Port": 60002
},
{
"Type": "public",
"Ip": "100.98.109.15",
"Port": 11126
}
],
"Credential": {
"CACert": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FULQo=",
"Token": "WBnCe69iqui0HuEZJ0Yac2hvwxQ1jG0j"
},
"CoreDns": "yes",
"HealthRegion": "yes",
"Health": "yes",
"UnitCluster": "yes",
"GridDaemon": "yes",
"PublicLB": {
"Enabled": true,
"AllowFromCidrs": [
"160/254.0.0/16"
]
},
"InternalLB": {
"SubnetId": [
"vpc-12345"
],
"Enabled": true
},
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}
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 |
---|---|
FailedOperation | Operation failed. |
InternalError | Internal error. |
InvalidParameter | Parameter error. |
LimitExceeded | Quota limit is exceeded. |
MissingParameter | Missing parameter. |
ResourceInUse | The resource is occupied. |
ResourceNotFound | The resource does not exist. |
ResourceUnavailable | Resource is unavailable |
UnauthorizedOperation | Unauthorized operation. |
UnknownParameter | Unknown parameter. |
UnsupportedOperation | Unsupported operation. |
Was this page helpful?