腾讯云数据仓库 TCHouse-P 获取集群实例状态

1. 接口描述

接口请求域名： cdwpg.tencentcloudapi.com 。

集群详情页中显示集群状态、流程进度等

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInstanceState。
Version	是	String	公共参数，本接口取值：2020-12-30。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	否	String	集群实例名称示例值：cdwpg-cdsxxxx
InstanceIds.N	否	Array of String	集群实例名称列表（批量查询，优先于 InstanceId；上限100，超出截断）示例值：["cdwpg-********"]

3. 输出参数

参数名称	类型	描述
BackupOpenStatus	Integer	集群备份任务开启状态2 示例值：0
BackupStatus	Integer	集群备份任务开启状态示例值：0
FlowCreateTime	String	集群操作创建时间示例值：2023-04-10 15:30:00
FlowMsg	String	集群流程错误信息，例如：“创建失败，资源不足” 示例值：Error:...
FlowName	String	集群操作名称示例值：create
FlowProgress	Float	集群操作进度示例值：75
InstanceState	String	集群状态，例如：Serving 示例值：Serving
InstanceStateDesc	String	集群状态描述，例如：运行中示例值：运行中
ProcessName	String	当前步骤的名称，例如：”购买资源中“ 示例值：create
InstanceStates	Array of InstanceStateItem	批量实例状态列表（InstanceIds 入参时返回，每项含 InstanceId 与状态字段）
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取集群状态

需要展现集群状态以及操作进度

输入示例

POST / HTTP/1.1
Host: cdwpg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceState
<公共请求参数>

{
    "InstanceId": "cdwpg-exs8Mnql",
    "InstanceIds": [
        "cdwpg-********"
    ]
}

输出示例

{
    "Response": {
        "BackupStatus": 0,
        "FlowCreateTime": "",
        "FlowMsg": "",
        "FlowName": "",
        "FlowProgress": 0,
        "InstanceState": "Serving",
        "InstanceStateDesc": "运行中",
        "ProcessName": "",
        "RequestId": "07fc03a7-0e42-4a21-b10d-ed0ceda4ab27"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

获取集群实例状态

本页目录：