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

1. 接口描述

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

本接口用于查询独享集群实例列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstanceList。
Version String 公共参数,本接口取值:2020-10-29。
Region String 公共参数,详见产品支持的 地域列表
Limit Integer 分页返回数量
示例值:1000
Offset Integer 分页偏移量
示例值:1
OrderBy String 排序字段,createTime,instancename两者之一
示例值:createTime
SortBy String 排序规则,desc,asc两者之一
示例值:desc
ProductId.N Array of Integer 按产品过滤,0:CDB, 1:TDSQL
示例值:[1]
InstanceId.N Array of String 按实例ID过滤
示例值:["dbdc-1234"]
InstanceName.N Array of String 按实例名称过滤
示例值:["dbdc-name"]
FenceId.N Array of String 按金融围笼ID过滤
示例值:["cage-1-2"]
Status.N Array of Integer 按实例状态过滤, -1:已隔离, 0:创建中, 1:运行中, 2:扩容中, 3:删除中
示例值:[1]
ClusterId.N Array of String 按所属集群ID过滤
示例值:["cluster-xxxx""]

3. 输出参数

参数名称 类型 描述
Instances Array of DescribeInstanceDetail 独享集群列表
TotalCount Integer 独享集群实例总数
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询独享集群接口列表

输入示例

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

{
    "Limit": 20,
    "Offset": 0,
    "OrderBy": "createTime",
    "SortBy": "desc"
}

输出示例

{
    "Response": {
        "Instances": [
            {
                "DbNum": 0,
                "CpuAssignable": 64,
                "HostType": 0,
                "AutoRenewFlag": 0,
                "Type": 0,
                "Status": 1,
                "InstanceId": "dbdc-test",
                "AssignStrategy": 0,
                "PeriodEndTime": "2021-05-28 00:00:00",
                "HostNum": 2,
                "MemoryAssignable": 256,
                "CpuSpec": 64,
                "DiskSpec": 12000,
                "MemorySpec": 256,
                "MemoryAssigned": 0,
                "StatusDesc": "运行中",
                "InstanceName": "test",
                "CpuAssigned": 0,
                "ProductId": 1,
                "DiskAssignable": 6000,
                "DiskAssigned": 0,
                "Region": "ap-guangzhou",
                "Zone": "ap-guangzhou-3",
                "FenceId": "cage-x-x",
                "ClusterId": "",
                "CreateTime": "2021-04-28 00:00:00"
            }
        ],
        "RequestId": "8cf4daa6-b172-11eb-94d3-525400542aa6",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
DryRunOperation DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。
FailedOperation.QueryResourceError 查询资源信息失败。
FailedOperation.QuerySpecInfoError 获取独享集群规格信息失败。
InvalidParameterValue.InvalidParameterValueError 参数值传入错误。