Domain name for API request: tke.tencentcloudapi.com.
This API is used to query the node pool list
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: DescribeClusterNodePools. |
Version | Yes | String | Common Params. The value used for this API: 2018-05-25. |
Region | No | String | Common Params. This parameter is not required for this API. |
ClusterId | Yes | String | ClusterId (cluster ID) |
Filters.N | No | Array of Filter | · NodePoolsName Filters by the node pool name Type: String Required: No · NodePoolsId Filters by the node pool ID Type: String Required: No · tags Filters by key-value pairs of tags Type: String Required: No · tag:tag-key Filters by key-value pairs of tags Type: String Required: No |
Parameter Name | Type | Description |
---|---|---|
NodePoolSet | Array of NodePool | NodePools (node pool list) Note: this field may return null , indicating that no valid value is obtained. |
TotalCount | Integer | Total resources |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterNodePools
<Common request parameters>
{
"ClusterId": "cls-xxxxxx"
}
{
"Response": {
"NodePoolSet": [
{
"AutoscalingGroupId": "",
"AutoscalingGroupStatus": "",
"ClusterInstanceId": "cls-69hshd30",
"DeletionProtection": false,
"DesiredNodesNum": 1,
"DesiredPodNum": 0,
"ImageId": "",
"Labels": [],
"LaunchConfigurationId": "",
"LifeState": "normal",
"MaxNodesNum": 1,
"MinNodesNum": 0,
"Name": "test",
"NodeCountSummary": {
"AutoscalingAdded": {
"Initializing": 0,
"Joining": 0,
"Normal": 0,
"Total": 0
},
"ManuallyAdded": {
"Initializing": 0,
"Joining": 0,
"Normal": 0,
"Total": 1
}
},
"NodePoolId": "np-5tx2l4de",
"NodePoolOs": "",
"OsCustomizeType": "",
"Tags": null,
"Taints": [],
"UserScript": ""
}
],
"RequestId": "efb810cb-d5a2-4147-88ec-cd1e28c5202e",
"TotalCount": 1
}
}
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.DbRecordNotFound | Record not found. |
InternalError.Param | Parameter error. |
InternalError.UnexpectedInternal | Unknown internal error. |
InvalidParameter.Param | Invalid parameter. |
ResourceNotFound.ClusterNotFound | The cluster does not exist. |
Was this page helpful?