DescribeClusterInstances
最近更新时间: 2025-10-20 17:06:16
1. 接口描述
接口请求域名： tsf.api3.fincloud.tencent.cn。
查询集群实例
默认接口请求频率限制：20次/秒。
接口更新时间：2019-07-02 21:21:48。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeClusterInstances |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-03-26 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| SearchWord | 否 | 否 | String | 搜索字段 |
| ClusterId | 是 | 否 | String | 集群ID |
| OrderBy | 否 | 否 | String | 排序字段 |
| OrderType | 否 | 否 | Int64 | 排序类型 |
| Offset | 否 | 否 | Int64 | 偏移量 |
| Limit | 否 | 否 | Int64 | 分页个数 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | TsfPageInstance | 此参数对外不可见。 集群机器实例分页信息 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.ContainergroupKuberneteConnectError | 连接TKE服务失败。 |
| InvalidParameter.ParamError | 参数错误。 |
| ResourceNotFound.ClusterNotExist | 无法获取命名空间所属集群。 |
| FailedOperation.InstanceUpdateFailed | 机器实例更新失败。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
| FailedOperation.TsfPrivilegeError | TSF权限模块异常，请联系系统管理员。。 |
| InternalError.CloudApiProxyError | TSF云API请求调用失败。 |
| InternalError.UnhandledException | [%s]模块未处理异常。。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |