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 | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
ClusterId | Yes | String | ClusterId (cluster ID) |
Filters.N | No | Array of Filter | · "Name":"NodePoolsName","Values": ["test"] Filter by [Node Pool Name]. Type: String Required: No · "Name":"NodePoolsId","Values": ["np-d2mb2zb"] Filter by [Node Pool ID]. Type: String Required: No · "Name":"Tags","Values": ["abc:1"] Filter 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, 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 node pool list.
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": "asg-xxx",
"AutoscalingGroupStatus": "disabled",
"ClusterInstanceId": "cls-xxxx",
"DataDisks": null,
"DeletionProtection": true,
"DesiredNodesNum": 2,
"DesiredPodNum": 64,
"DockerGraphPath": "",
"ExtraArgs": {
"Kubelet": []
},
"GPUArgs": {
"CUDA": {
"Name": "",
"Version": ""
},
"CUDNN": {
"DevName": "",
"DocName": "",
"Name": "",
"Version": ""
},
"CustomDriver": {
"Address": ""
},
"Driver": {
"Name": "",
"Version": ""
},
"MIGEnable": false
},
"ImageId": "",
"Labels": [],
"Annotations": [],
"LaunchConfigurationId": "asc-xxx",
"LifeState": "normal",
"MaxNodesNum": 3,
"MinNodesNum": 0,
"Name": "xxx",
"NodeCountSummary": {
"AutoscalingAdded": {
"Initializing": 0,
"Joining": 0,
"Normal": 2,
"Total": 2
},
"ManuallyAdded": {
"Initializing": 0,
"Joining": 0,
"Normal": 1,
"Total": 1
}
},
"NodePoolId": "np-xxx",
"NodePoolOs": "tlinux_xxx",
"OsCustomizeType": "GENERAL",
"PreStartUserScript": "#!/bin/sh\ntouch /tmp/before",
"RuntimeConfig": {
"RuntimeType": "containerd",
"RuntimeVersion": "1.6.x"
},
"Tags": null,
"Taints": [],
"Unschedulable": 0,
"UserScript": "#!/bin/sh\ntouch /tmp/after"
}
],
"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. |
本页内容是否解决了您的问题?