腾讯云数据仓库 TCHouse-P 获取集群精简信息列表

1. 接口描述

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

获取集群实例列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSimpleInstances。
Version	是	String	公共参数，本接口取值：2020-12-30。
Region	是	String	公共参数，详见产品支持的地域列表。
SearchInstanceId	否	String	用集群id搜索示例值：cdwpg-fsds123xxs
SearchInstanceName	否	String	用集群名字搜索示例值：cdwpg_test001
Offset	否	Integer	分页参数，第一页为0，第二页为10 示例值：0
Limit	否	Integer	分页参数，分页步长，默认为10 示例值：10
SearchTags.N	否	Array of String	用标签列表搜索示例值：k1

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	集群列表总数示例值：2
InstancesList	Array of InstanceSimpleInfoNew	集群列表详情示例值：[{"ID":1094,"InstanceId":"cdwpg-rzshdeh1",...."Zone":"ap-chongqing-1"},{ID":1089,"InstanceId":"cdwpg-9jcyk7yp",...."Zone":"ap-chongqing-1"}]
ErrorMsg	String	错误信息示例值：Error:...
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 集群列表new

集群列表

输入示例

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

{}

输出示例

{
    "Response": {
        "ErrorMsg": "",
        "InstancesList": [
            {
                "AccessInfo": "[{\"address\":\"10.0.16.19:9000\",\"protocol\":\"tcp\"}]",
                "CreateTime": "2025-03-19 16:37:38",
                "ExpireTime": "0000.00.00 00:00:00",
                "Region": "ap-beijing",
                "RegionId": 8,
                "RegionDesc": "ap-beijing",
                "Zone": "ap-beijing-6",
                "ZoneId": 800005,
                "ZoneDesc": "ap-beijing-6",
                "ID": 1094,
                "InstanceId": "cdwpg-rzshdeh1",
                "InstanceName": "hugogao_test",
                "PayMode": "POSTPAID_BY_HOUR",
                "RenewFlag": false,
                "SubnetId": "subnet-rdlodajk",
                "Version": "3.16.9.4",
                "VpcId": "vpc-1asw4o73"
            },
            {
                "AccessInfo": "[{\"address\":\"10.0.16.27:9000\",\"protocol\":\"tcp\"}]",
                "CreateTime": "2025-02-20 11:37:11",
                "ExpireTime": "0000.00.00 00:00:00",
                "ID": 1089,
                "InstanceId": "cdwpg-9jcyk7yp",
                "InstanceName": "demo_tim",
                "Region": "ap-beijing",
                "RegionId": 8,
                "RegionDesc": "ap-beijing",
                "Zone": "ap-beijing-6",
                "ZoneId": 800005,
                "ZoneDesc": "ap-beijing-6",
                "PayMode": "POSTPAID_BY_HOUR",
                "RenewFlag": false,
                "SubnetId": "subnet-rdlodajk",
                "Version": "3.16.9.4",
                "VpcId": "vpc-1asw4o73"
            }
        ],
        "RequestId": "ad9e5842-e932-47d1-83a0-a388ccc5c19e",
        "TotalCount": 2
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.SystemError	InternalError.SystemError

获取集群精简信息列表

本页目录：