1. 接口描述
接口请求域名： tke.tencentcloudapi.com 。
查询节点池列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeClusterNodePools。 |
| Version | 是 | String | 公共参数，本接口取值：2018-05-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ClusterId | 是 | String | ClusterId（集群id） 示例值：cls-xxxxxx |
| Filters.N | 否 | Array of Filter | · "Name":"NodePoolsName","Values": ["test"] 按照【节点池名】进行过滤。 类型：String 必选：否 · "Name":"NodePoolsId","Values": ["np-d2mb2zb"] 按照【节点池id】进行过滤。 类型：String 必选：否 · "Name":"Tags","Values": ["abc:1"] 按照【标签键值对】进行过滤。 类型：String 必选：否 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| NodePoolSet | Array of NodePool | NodePools（节点池列表） 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalCount | Integer | 资源总数 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询节点池列表
查询节点池列表
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterNodePools
<公共请求参数>
{
"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
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.DbRecordNotFound | 记录未找到。 |
| InternalError.Param | Param。 |
| InternalError.UnexpectedInternal | 未知的内部错误。 |
| InvalidParameter.Param | 参数错误。 |
| ResourceNotFound.ClusterNotFound | 集群不存在。 |
