查询集群节点信息

最近更新时间:2019-08-22 19:31:49

1. 接口描述

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

查询集群下节点实例信息

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

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

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类型。

3. 输出参数

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

4. 示例

示例1 查询集群实例信息

查询集群实例信息

输入示例

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

输出示例

{
  "Response": {
    "TotalCount": 1,
    "InstanceSet": [
      {
        "InstanceId": "ins-gsk7l6vw",
        "InstanceRole": "WORKER",
        "InstanceState": "running",
        "FailedReason": ""
      }
    ],
    "RequestId": "82f2fe9c-c5fa-4077-9236-f1341180a696"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InternalError.Db db错误。
InternalError.DbAffectivedRows DB影响函数错误。
InternalError.InitMasterFailed 初始化master失败。
InternalError.Param Param。
InternalError.PublicClusterOpNotSupport 集群不支持当前操作。
InvalidParameter 参数错误
LimitExceeded 超过配额限制