查询实例列表

最近更新时间:2018-09-28 14:59:52

1. 接口描述

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

查询云数据库实例列表,支持通过项目ID、实例ID、内网地址、实例名称等来筛选实例。 如果不指定任何筛选条件,则默认返回10条实例记录,单次请求最多支持返回100条实例记录。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDCDBInstances
Version String 公共参数,本接口取值:2018-04-11
Region String 公共参数,详见产品支持的地域列表
InstanceIds.N Array of String 按照一个或者多个实例 ID 查询。实例 ID 形如:dcdbt-2t4cf98d
SearchName String 搜索的字段名,当前支持的值有:instancename、vip、all。传 instancename 表示按实例名进行搜索;传 vip 表示按内网IP进行搜索;传 all 将会按实例ID、实例名和内网IP进行搜索。
SearchKey String 搜索的关键字,支持模糊搜索。多个关键字使用换行符('\n')分割。
ProjectIds.N Array of Integer 按项目 ID 查询
IsFilterVpc Boolean 是否根据 VPC 网络来搜索
VpcId String 私有网络 ID, IsFilterVpc 为 1 时有效
SubnetId String 私有网络的子网 ID, IsFilterVpc 为 1 时有效
OrderBy String 排序字段, projectId, createtime, instancename 三者之一
OrderByType String 排序类型, desc 或者 asc
Offset Integer 偏移量,默认为 0
Limit Integer 返回数量,默认为 10,最大值为 100。
ExclusterType Integer 1非独享集群,2独享集群, 0全部
IsFilterExcluster Boolean 标识是否使用ExclusterType字段, false不使用,true使用

3. 输出参数

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

4. 示例

示例1 根据实例ID查询实例列表

输入示例

https://dcdb.tencentcloudapi.com/?Action=DescribeDCDBInstances
&InstanceIds.0=dcdbt-52s53yyh
&<公共请求参数>

输出示例

{
  "Response": {
    "Instances": [
      {
        "AppId": 1251006373,
        "AutoRenewFlag": 0,
        "CreateTime": "2018-05-04 16:42:18",
        "DbEngine": "MySQL",
        "DbVersion": "10.1.9",
        "ExclusterId": "",
        "Id": 40965,
        "InstanceId": "dcdbt-52s53yyh",
        "InstanceName": "dcdbt-52s53yyh",
        "IsTmp": 0,
        "IsolatedTimestamp": "0000-00-00 00:00:00",
        "Memory": 4,
        "NodeCount": 2,
        "PeriodEndTime": "2018-05-11 16:42:18",
        "Pid": 11128,
        "ProjectId": 0,
        "Region": "ap-guangzhou",
        "ShardCount": 2,
        "ShardDetail": [
          {
            "Createtime": "2018-05-04 16:42:19",
            "Memory": 2,
            "NodeCount": 2,
            "Pid": 11128,
            "ShardId": 10240,
            "ShardInstanceId": "shard-8m3rgssh",
            "ShardSerialId": "set_1525423498_1",
            "Status": 2,
            "Storage": 10
          },
          {
            "Createtime": "2018-05-04 16:42:19",
            "Memory": 2,
            "NodeCount": 2,
            "Pid": 11128,
            "ShardId": 10241,
            "ShardInstanceId": "shard-n8f80yrv",
            "ShardSerialId": "set_1525427618_3",
            "Status": 2,
            "Storage": 10
          }
        ],
        "Status": 2,
        "StatusDesc": "运行中",
        "Storage": 20,
        "SubnetId": 45109,
        "Uin": "20548499",
        "UniqueSubnetId": "subnet-6ffate6q",
        "UniqueVpcId": "vpc-5rkcp0wb",
        "UpdateTime": "2018-05-20 18:04:17",
        "Vip": "172.17.0.10",
        "VpcId": 75203,
        "Vport": 3306,
        "WanDomain": "",
        "WanPort": 0,
        "WanVip": "",
        "Zone": "ap-guangzhou-2"
      }
    ],
    "RequestId": "f5301a70-8a4b-4e5e-b7e4-68d9c2f9c7c6",
    "TotalCount": 1
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CamAuthFailed CAM鉴权请求失败。
InternalError.DbOperationFailed 查询数据库失败。
InternalError.FenceError 查询独享集群信息失败。
InternalError.GetSubnetFailed 查询虚拟私有网络子网信息失败。
InvalidParameter.GenericParameterError 参数合法性校验错误。
InvalidParameter.SubnetNotFound 找不到指定的虚拟私有网络子网。
InvalidParameterValue.IllegalExclusterID 找不到数据库实例所属的独享集群。
InvalidParameterValue.SpecIdIllegal 找不到数据库实例对应的规格信息。
UnauthorizedOperation.PermissionDenied 没有权限操作该接口或资源。