查询实例列表

最近更新时间:2018-10-26 15:05:19

1. 接口描述

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

本接口(DescribeDBInstances)用于查询云数据库实例列表,支持通过项目ID、实例ID、访问地址、实例状态等过滤条件来筛选实例。支持查询主实例、灾备实例和只读实例信息列表。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cdb.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBInstances
Version String 公共参数,本接口取值:2017-03-20
Region String 公共参数,详见产品支持的地域列表
ProjectId Integer 项目ID,可使用查询项目列表接口查询项目ID
InstanceTypes.N Array of Integer 实例类型,可取值:1-主实例,2-灾备实例,3-只读实例
Vips.N Array of String 实例的内网IP地址
Status.N Array of Integer 实例状态,可取值:0-创建中,1-运行中,4-隔离中,5-已隔离
Offset Integer 偏移量,默认值为0
Limit Integer 单次请求返回的数量,默认值为20,最大值为2000
SecurityGroupId String 安全组ID
PayTypes.N Array of Integer 付费类型,可取值:0-包年包月,1-小时计费
InstanceNames.N Array of String 实例名称
TaskStatus.N Array of Integer 实例任务状态,可能取值:
0-没有任务
1-升级中
2-数据导入中
3-开放Slave中
4-外网访问开通中
5-批量操作执行中
6-回档中
7-外网访问关闭中
8-密码修改中
9-实例名修改中
10-重启中
12-自建迁移中
13-删除库表中
14-灾备实例创建同步中
EngineVersions.N Array of String 实例数据库引擎版本,可能取值:5.1、5.5、5.6和5.7
VpcIds.N Array of Integer 私有网络的ID
ZoneIds.N Array of Integer 可用区的ID
SubnetIds.N Array of Integer 子网ID
CdbErrors.N Array of Integer 是否锁定标记
OrderBy String 返回结果集排序的字段,目前支持:"InstanceId", "InstanceName", "CreateTime", "DeadlineTime"
OrderDirection String 返回结果集排序方式,目前支持:"ASC"或者"DESC"
WithSecurityGroup Integer 是否包含安全组详细信息,可取值:0-不包含,1-包含
WithExCluster Integer 是否包含独享集群详细信息,可取值:0-不包含,1-包含
ExClusterId String 独享集群ID
InstanceIds.N Array of String 实例ID
InitFlag Integer 初始化标记,可取值:0-未初始化,1-初始化
WithDr Integer 是否包含灾备实例,可取值:0-不包含,1-包含
WithRo Integer 是否包含只读实例,可取值:0-不包含,1-包含
WithMaster Integer 是否包含主实例,可取值:0-不包含,1-包含

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合查询条件的实例总数
Items Array of InstanceInfo 实例详细信息
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例列表

输入示例

https://cdb.tencentcloudapi.com/?Action=DescribeDBInstances
&InstanceIds.0=cdb-70zdmgg1
&<公共请求参数>

输出示例

{
  "Response": {
    "Items": [
      {
        "AutoRenew": 0,
        "CdbError": 0,
        "CreateTime": "2018-05-03 14:53:23",
        "DeadlineTime": "0000-00-00 00:00:00",
        "DeployMode": 0,
        "DeviceType": "CUSTOM",
        "DrInfo": [],
        "EngineVersion": "5.6",
        "InitFlag": 1,
        "InstanceId": "cdb-70zdmgg1",
        "InstanceName": "jersey_test",
        "InstanceType": 1,
        "Memory": 1000,
        "PayType": 1,
        "ProjectId": 0,
        "ProtectMode": 0,
        "Region": "ap-chengdu",
        "RoGroups": [
          {
            "MinRoInGroup": 1,
            "RoGroupId": "cdbrg-3i70uj0k",
            "RoGroupName": "ro_group_103608",
            "RoInstances": [
              {
                "DeadlineTime": "0000-00-00 00:00:00",
                "DeviceType": "CUSTOM",
                "EngineVersion": "5.6",
                "HourFeeStatus": 1,
                "InstanceId": "cdbro-3i70uj0k",
                "InstanceName": "cdb_ro_103608",
                "InstanceType": 3,
                "Memory": 1000,
                "PayType": 1,
                "Qps": 1000,
                "Region": "ap-chengdu",
                "Status": 1,
                "SubnetId": 115839,
                "TaskStatus": 0,
                "Vip": "172.16.0.11",
                "Volume": 50,
                "VpcId": 511512,
                "Vport": 3306,
                "Zone": "ap-chengdu-1"
              }
            ],
            "RoMaxDelayTime": 1,
            "Vip": "172.16.0.11",
            "Vport": 3306,
            "WeightMode": "system"
          },
          {
            "MinRoInGroup": 1,
            "RoGroupId": "cdbrg-6scijza8",
            "RoGroupName": "ro_group_103610",
            "RoInstances": [
              {
                "DeadlineTime": "0000-00-00 00:00:00",
                "DeviceType": "CUSTOM",
                "EngineVersion": "5.6",
                "HourFeeStatus": 1,
                "InstanceId": "cdbro-6scijza8",
                "InstanceName": "cdb_ro_103610",
                "InstanceType": 3,
                "Memory": 1000,
                "PayType": 1,
                "Qps": 1000,
                "Region": "ap-chengdu",
                "Status": 1,
                "SubnetId": 115839,
                "TaskStatus": 0,
                "Vip": "172.16.0.25",
                "Volume": 25,
                "VpcId": 511512,
                "Vport": 3306,
                "Zone": "ap-chengdu-1"
              }
            ],
            "RoMaxDelayTime": 1,
            "Vip": "172.16.0.25",
            "Vport": 3306,
            "WeightMode": "system"
          }
        ],
        "SlaveInfo": {
          "First": {
            "Region": "ap-chengdu",
            "Vip": "",
            "Vport": 0,
            "Zone": "ap-chengdu-1"
          }
        },
        "Status": 1,
        "SubnetId": 115839,
        "TaskStatus": 0,
        "UniqSubnetId": "subnet-1typ0s7d",
        "UniqVpcId": "vpc-5v8wn9mg",
        "Vip": "172.16.0.16",
        "Volume": 50,
        "VpcId": 511512,
        "Vport": 3306,
        "WanDomain": "",
        "WanPort": 0,
        "WanStatus": 0,
        "Zone": "ap-chengdu-1"
      }
    ],
    "RequestId": "756bb037-a44a-4b4f-abe0-6efd34a6c792",
    "TotalCount": 1
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
CdbError 后端错误或者流程错误。
InternalError.DatabaseAccessError 数据库内部错误。
InternalError.DesError 系统内部错误。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。
OperationDenied.WrongStatus 后端任务状态非法。