用户指南

最佳实践

API 文档

查询集群节点信息

最近更新时间:2021-08-04 08:08:59

我的收藏

1. 接口描述

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

查询集群下节点实例信息

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:tke.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeClusterInstances。
Version String 公共参数,本接口取值:2018-05-25。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 集群ID
Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
InstanceIds.N Array of String 需要获取的节点实例Id列表。如果为空,表示拉取集群下所有节点实例。
InstanceRole String 节点角色, MASTER, WORKER, ETCD, MASTER_ETCD,ALL, 默认为WORKER。默认为WORKER类型。
Filters.N Array of Filter 过滤条件列表;Name的可选值为nodepool-id、nodepool-instance-type;Name为nodepool-id表示根据节点池id过滤机器,Value的值为具体的节点池id,Name为nodepool-instance-type表示节点加入节点池的方式,Value的值为MANUALLY_ADDED(手动加入节点池)、AUTOSCALING_ADDED(伸缩组扩容方式加入节点池)、ALL(手动加入节点池 和 伸缩组扩容方式加入节点池)

3. 输出参数

参数名称 类型 描述
TotalCount Integer 集群中实例总数
InstanceSet Array of Instance 集群中实例列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询集群实例信息

查询集群实例信息

输入示例

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

输出示例

{
"Response": {
  "InstanceSet": [
    {
      "InstanceAdvancedSettings": {
        "DockerGraphPath": "xx",
        "Labels": [
          {
            "Name": "xx",
            "Value": "xx"
          }
        ],
        "ExtraArgs": {
          "Kubelet": [
            "xx"
          ]
        },
        "Unschedulable": 0,
        "UserScript": "xx",
        "MountTarget": "xx",
        "DataDisks": [
          {
            "DiskPartition": "xx",
            "DiskType": "xx",
            "DiskSize": 0,
            "FileSystem": "xx",
            "AutoFormatAndMount": true,
            "MountTarget": "xx"
          }
        ]
      },
      "InstanceId": "xx",
      "InstanceRole": "xx",
      "LanIP": "xx",
      "DrainStatus": "xx",
      "AutoscalingGroupId": "xx",
      "InstanceState": "xx",
      "CreatedTime": "xx",
      "NodePoolId": "xx",
      "FailedReason": "xx"
    }
  ],
  "TotalCount": 1,
  "RequestId": "xx"
}
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.Db db错误。
InternalError.DbAffectivedRows DB错误。
InternalError.InitMasterFailed 初始化master失败。
InternalError.Param Param。
InternalError.PublicClusterOpNotSupport 集群不支持当前操作。
InvalidParameter.ClusterNotFound 集群ID不存在。
InvalidParameter.Param 参数错误。
ResourceUnavailable.ClusterState 集群状态不支持该操作。
目录