查询集群节点信息
最近更新时间: 2024-10-18 10:38:36
1. 接口描述
接口请求域名： tke.api3.fincloud.tencent.cn。
查询集群下节点实例信息
默认接口请求频率限制：20次/秒。
接口更新时间：2021-04-29 11:45:57。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeClusterInstances |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-05-25 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| ClusterId | 是 | 否 | String | 集群ID |
| Offset | 否 | 否 | Int64 | 偏移量，默认为0。用来控制分页的参数；Limit 为单次返回的最多条目数量，Offset 为偏移量。当相应结果是列表形式时，如果数量超过了 Limit 所限定的值，那么只返回 Limit 个值。 |
| Limit | 否 | 否 | Int64 | 返回数量，默认为20，最大值为100。用来控制分页的参数；Limit 为单次返回的最多条目数量，Offset 为偏移量。当相应结果是列表形式时，如果数量超过了 Limit 所限定的值，那么只返回 Limit 个值。 |
| InstanceIds | 否 | 否 | Array of String | 需要获取的节点实例Id列表。如果为空，表示拉取集群下所有节点实例。 |
| InstanceRole | 否 | 否 | String | 节点角色, 分为：MASTER_ETCD, WORKER。传空则为获取全部角色 |
| Filters | 否 | 否 | Array of Filter | 此参数对外不可见。 过滤条件列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Uint64 | 集群中实例总数 |
| InstanceSet | Instance | 集群中实例列表 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | |
| InternalError.DbAffectivedRows | |
| InvalidParameter.ClusterNotFound | |
| InternalError.Db | |
| FailedOperation | |
| InternalError.InitMasterFailed | |
| InternalError.Param | |
| InternalError.PublicClusterOpNotSupport | |
| ResourceNotFound |