Domain name for API request: tke.tencentcloudapi.com.
This API is used to query the list of TKE Edge clusters.
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: DescribeTKEEdgeClusters. |
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. This API only supports: ap-beijing, ap-guangzhou, ap-nanjing, ap-shanghai, ap-singapore. |
ClusterIds.N | No | Array of String | Cluster ID list (when it is empty, all clusters under the account are obtained) |
Offset | No | Integer | Offset. Default value: 0 |
Limit | No | Integer | Maximum number of output entries. Default value: 20 |
Filters.N | No | Array of Filter | Filter conditions. Values: ClusterName and tags in the format of ["key1:value1","key2:value2"]. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Total number of clusters |
Clusters | Array of EdgeCluster | Cluster information list |
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. |
This example shows you how to query the cluster list to obtain it.
https://tke.tencentcloudapi.com/?Action=DescribeTKEEdgeClusters
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"Clusters": [
{
"ClusterId": "abc",
"ClusterName": "abc",
"VpcId": "abc",
"PodCIDR": "abc",
"ServiceCIDR": "abc",
"K8SVersion": "abc",
"Status": "abc",
"ClusterDesc": "abc",
"CreatedTime": "abc",
"EdgeClusterVersion": "abc",
"MaxNodePodNum": 0,
"ClusterAdvancedSettings": {
"ExtraArgs": {
"KubeAPIServer": [
"abc"
],
"KubeControllerManager": [
"abc"
],
"KubeScheduler": [
"abc"
]
},
"Runtime": "abc",
"ProxyMode": "abc"
},
"Level": "abc",
"AutoUpgradeClusterLevel": true,
"ChargeType": "abc",
"EdgeVersion": "abc",
"TagSpecification": {
"ResourceType": "abc",
"Tags": [
{
"Key": "abc",
"Value": "abc"
}
]
}
}
],
"RequestId": "abc"
}
}
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. |
InternalError.CamNoAuth | You do not have permissions. |
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. |
本页内容是否解决了您的问题?