用户指南

最佳实践

API 文档

查询节点池详情

最近更新时间:2021-10-21 11:40:16

我的收藏

1. 接口描述

接口请求域名: tke.tencentcloudapi.com 。

查询节点池详情

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeClusterNodePoolDetail。
Version String 公共参数,本接口取值:2018-05-25。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 集群id
NodePoolId String 节点池id

3. 输出参数

参数名称 类型 描述
NodePool NodePool 节点池详情
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询节点池详情

输入示例

https://tke.tencentcloudapi.com/?Action=DescribeClusterNodePoolDetail
&ClusterId=cls-xxxxxx
&NodePoolId=np-xxxxxxxx
&<公共请求参数>

输出示例

{
  "Response": {
    "NodePool": {
      "AutoscalingGroupId": "asg-xxx",
      "AutoscalingGroupStatus": "enabled",
      "ClusterInstanceId": "cls-xxx",
      "DesiredNodesNum": 0,
      "Labels": [],
      "LaunchConfigurationId": "asc-xxx",
      "LifeState": "normal",
      "MaxNodesNum": 1,
      "MinNodesNum": 0,
      "Name": "test",
      "NodeCountSummary": {
        "AutoscalingAdded": {
          "Initializing": 0,
          "Joining": 0,
          "Normal": 0,
          "Total": 0
        },
        "ManuallyAdded": {
          "Initializing": 0,
          "Joining": 0,
          "Normal": 1,
          "Total": 1
        }
      },
      "NodePoolId": "np-xxxxx",
      "Taints": []
    },
    "RequestId": "xxx"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.ClusterNotFound 集群未找到。
InternalError.DbRecordNotFound 记录未找到。
InternalError.UnexpectedInternal 未知的内部错误。
InvalidParameter.Param 参数错误。
ResourceNotFound.ClusterNotFound 集群不存在。
目录