1. 接口描述
接口请求域名： tke.tencentcloudapi.com 。
查询 TKE 节点池列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeNodePools。 |
| Version | 是 | String | 公共参数，本接口取值：2022-05-01。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ClusterId | 是 | String | 集群 ID 示例值：cls-xxxxxxxx |
| Filters.N | 否 | Array of Filter | 查询过滤条件： · NodePoolsName 按照【节点池名】进行过滤。 类型：String 必选：否 · NodePoolsId 按照【节点池id】进行过滤。 类型：String 必选：否 · tags 按照【标签键值对】进行过滤。 类型：String 必选：否 · tag:tag-key 按照【标签键值对】进行过滤。 类型：String 必选：否 |
| Offset | 否 | Integer | 偏移量，默认0 示例值：0 |
| Limit | 否 | Integer | 最大输出条数，默认20，最大为100 示例值：20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| NodePools | Array of NodePool | 节点池列表 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalCount | Integer | 资源总数 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询 TKE 节点池列表
查询 TKE 节点池列表
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNodePools
<公共请求参数>
{
"ClusterId": "cls-h8atd7dj",
"Filters": [
{
"Name": "NodePoolsName",
"Values": [
"cputest"
]
}
],
"Offset": 0,
"Limit": 0
}输出示例
{
"Response": {
"NodePools": [
{
"Annotations": [],
"ClusterId": "cls-h8atd7dj",
"CreatedAt": "2023-01-15 17:55:38 +0000 UTC",
"DeletionProtection": false,
"External": null,
"Labels": [],
"LifeState": "normal",
"Name": "cputest",
"Native": null,
"NodePoolId": "np-rbl9quwv",
"Regular": {
"AutoscalingGroupId": "asg-mv6aoc57",
"AutoscalingGroupStatus": "disabled",
"DesiredNodesNum": 0,
"InstanceAdvancedSettings": {
"DesiredPodNumber": 32,
"ExtraArgs": {
"Kubelet": null
},
"PreStartUserScript": "",
"RuntimeConfig": {
"RuntimeRootDir": "",
"RuntimeType": "docker",
"RuntimeVersion": "19.3"
},
"UserScript": ""
},
"LaunchConfigurationId": "asc-ay1hkbqh",
"MaxNodesNum": 1,
"MinNodesNum": 0,
"NodeCountSummary": {
"AutoscalingAdded": {
"Initializing": 0,
"Joining": 0,
"Normal": 0,
"Total": 0
},
"ManuallyAdded": {
"Initializing": 0,
"Joining": 0,
"Normal": 0,
"Total": 0
}
},
"NodePoolOs": "ubuntu20.04x86_64"
},
"Super": null,
"Tags": [],
"Taints": [],
"Type": "Regular",
"Unschedulable": false
},
{
"Annotations": [],
"ClusterId": "cls-h8att7dj",
"CreatedAt": "2023-11-16 20:56:55 +0000 UTC",
"DeletionProtection": true,
"External": {
"NodesNum": 1,
"RuntimeConfig": {
"RuntimeRootDir": null,
"RuntimeType": "docker",
"RuntimeVersion": "docker-19.3"
}
},
"Labels": [
{
"Name": "node.kubernetes.io/instance-type",
"Value": "external"
},
{
"Name": "tke.cloud.tencent.com/cbs-mountable",
"Value": "false"
},
{
"Name": "externalnode.tke.cloud.tencent.com/version",
"Value": "v2"
}
],
"LifeState": "Running",
"Name": "cpu",
"Native": null,
"NodePoolId": "np-llfflb19",
"Regular": null,
"Super": null,
"Tags": [],
"Taints": [],
"Type": "External",
"Unschedulable": false
},
{
"Annotations": [],
"ClusterId": "cls-h8att7dj",
"CreatedAt": "2023-11-16 20:56:54 +0000 UTC",
"DeletionProtection": true,
"External": {
"NodesNum": 4,
"RuntimeConfig": {
"RuntimeRootDir": null,
"RuntimeType": "docker",
"RuntimeVersion": "docker-19.3"
}
},
"Labels": [
{
"Name": "externalnode.tke.cloud.tencent.com/version",
"Value": "v2"
},
{
"Name": "node.kubernetes.io/instance-type",
"Value": "external"
},
{
"Name": "nvidia-device-enable",
"Value": "enable"
},
{
"Name": "tke.cloud.tencent.com/cbs-mountable",
"Value": "false"
}
],
"LifeState": "Running",
"Name": "gpu",
"Native": null,
"NodePoolId": "np-iw0qds8t",
"Regular": null,
"Super": null,
"Tags": [],
"Taints": [],
"Type": "External",
"Unschedulable": false
}
],
"RequestId": "354c45c4-0eb2-464d-82f8-3dd55ca88a80",
"TotalCount": 3
}
}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 | 资源不存在。 |
| ResourceNotFound.ClusterNotFound | 集群不存在。 |
| ResourceUnavailable.ClusterState | 集群状态不支持该操作。 |
