有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: dbdc.tencentcloudapi.com 。

根据不同地域不同用户,获取集群列表信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstances。
Version String 公共参数,本接口取值:2020-10-29。
Region String 公共参数,详见产品支持的 地域列表
InstanceTypes.N Array of Integer 集群类型: 0 一主一备, 1 一主两备...N-1 一主N备
ProductIds.N Array of Integer 产品ID: 0 MYSQL,1 TDSQL
InstanceIds.N Array of String 集群uuid: 如 dbdc-q810131s
FenceFlag Boolean 是否按金融围笼标志搜索
InstanceName String 按实例名字模糊匹配
PageSize Integer 每页数目, 整型
PageNumber Integer 页码, 整型
OrderBy String 排序字段,枚举:createtime,groupname
OrderByType String 排序方式: asc升序, desc降序
InstanceStatus Integer 集群状态: -2 已删除, -1 已隔离, 0 创建中, 1 运行中, 2 扩容中, 3 删除中

3. 输出参数

参数名称 类型 描述
TotalCount Integer 集群数量
Instances Array of InstanceExpand 集群扩展信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例DEMO

输入示例

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

{}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "xx",
        "Instances": [
            {
                "InstanceStatus": 0,
                "Zone": "xx",
                "InstanceId": "xx",
                "Region": "xx",
                "Pid": 10875,
                "CreateTime": "xx",
                "Machine": "xx",
                "AutoRenewFlag": 0,
                "InstanceDetail": {
                    "Status": 0,
                    "ReadWriteTotalMemory": 1,
                    "ReadWriteTotalLeaveMemory": 1,
                    "ReadWriteTotalLeaveDisk": 1,
                    "ReadOnlyTotalLeaveDisk": 1,
                    "ReadOnlyTotalMemory": 1,
                    "ReadOnlyTotalLeaveMemory": 1,
                    "ReadOnlyTotalDisk": 1,
                    "InstanceDeviceInfos": [
                        {
                            "InstanceId": "xx",
                            "FreeDevice": [
                                {
                                    "RawDeviceNum": 1,
                                    "InstanceNum": 1,
                                    "DevClass": "xx",
                                    "RestDisk": 1,
                                    "DeviceId": 0,
                                    "DeviceNo": "xx",
                                    "MaxDisk": 1
                                }
                            ],
                            "ReadWriteDevice": [
                                {
                                    "RawDeviceNum": 1,
                                    "InstanceNum": 1,
                                    "DevClass": "xx",
                                    "RestDisk": 1,
                                    "DeviceId": 0,
                                    "DeviceNo": "xx",
                                    "MaxDisk": 1
                                }
                            ],
                            "ReadOnlyDevice": [
                                {
                                    "RawDeviceNum": 1,
                                    "InstanceNum": 1,
                                    "DevClass": "xx",
                                    "RestDisk": 1,
                                    "DeviceId": 0,
                                    "DeviceNo": "xx",
                                    "MaxDisk": 1
                                }
                            ]
                        }
                    ],
                    "ReadWriteTotalDisk": 1
                },
                "AppId": 1,
                "PeriodEndTime": "xx",
                "InstanceName": "xx",
                "InstanceType": 0
            },
            {
                "InstanceStatus": 0,
                "Zone": "xx",
                "InstanceId": "xx",
                "Region": "xx",
                "Pid": 10875,
                "InstanceType": 0,
                "Machine": "xx",
                "AutoRenewFlag": 0,
                "InstanceDetail": {
                    "Status": 0,
                    "ReadWriteTotalMemory": 1,
                    "ReadWriteTotalLeaveMemory": 1,
                    "ReadWriteTotalLeaveDisk": 1,
                    "ReadOnlyTotalLeaveDisk": 1,
                    "ReadOnlyTotalMemory": 1,
                    "ReadOnlyTotalLeaveMemory": 1,
                    "ReadOnlyTotalDisk": 1,
                    "InstanceDeviceInfos": [
                        {
                            "InstanceId": "xx",
                            "FreeDevice": [
                                {
                                    "RawDeviceNum": 1,
                                    "InstanceNum": 1,
                                    "DevClass": "xx",
                                    "RestDisk": 1,
                                    "DeviceId": 0,
                                    "DeviceNo": "xx",
                                    "MaxDisk": 1
                                }
                            ],
                            "ReadWriteDevice": [
                                {
                                    "RawDeviceNum": 1,
                                    "InstanceNum": 1,
                                    "DevClass": "xx",
                                    "RestDisk": 1,
                                    "DeviceId": 0,
                                    "DeviceNo": "xx",
                                    "MaxDisk": 1
                                }
                            ],
                            "ReadOnlyDevice": [
                                {
                                    "RawDeviceNum": 1,
                                    "InstanceNum": 1,
                                    "DevClass": "xx",
                                    "RestDisk": 1,
                                    "DeviceId": 0,
                                    "DeviceNo": "xx",
                                    "MaxDisk": 1
                                }
                            ]
                        }
                    ],
                    "ReadWriteTotalDisk": 1
                },
                "AppId": 1,
                "PeriodEndTime": "xx",
                "InstanceName": "xx",
                "CreateTime": "xx"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue.ResourceParameterError 集群的参数非法。
ResourceNotFound.FetchResourceError 获取资源失败,AppId:{{1}},ResourceId:{{2}}。
ResourceNotFound.FetchResourceListError 获取资源列表失败,ErrMsg:{{1}}。