1. 接口描述
接口请求域名： cdwch.tencentcloudapi.com 。
集群详情页中显示集群状态、流程进度等
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstanceState。 |
| Version | 是 | String | 公共参数，本接口取值：2020-09-15。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群实例名称 示例值：- |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceState | String | 集群状态，例如：Serving 示例值：- |
| FlowCreateTime | String | 集群操作创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| FlowName | String | 集群操作名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| FlowProgress | Float | 集群操作进度 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| InstanceStateDesc | String | 集群状态描述，例如：运行中 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| FlowMsg | String | 集群流程错误信息，例如：“创建失败，资源不足” 注意：此字段可能返回 null，表示取不到有效值。 示例值：- |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取集群状态
需要展现集群状态以及操作进度
输入示例
https://cdwch.tencentcloudapi.com/?Action=DescribeInstanceState
&InstanceId=cdwch-exs8Mnql
&<公共请求参数>输出示例
{
"Response": {
"InstanceState": "Serving",
"InstanceStateDesc": "运行中",
"FlowCreateTime": "",
"FlowName": "",
"FlowProgress": 0,
"FlowMsg": "创建流程失败",
"RequestId": "xxxx-xxxx-xxxx-xxxx"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。