查询实例列表

最近更新时间:2020-09-09 08:07:41

1. 接口描述

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

本接口 (DescribeDBInstances) 用于查询一个或多个实例的详细信息。

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBInstances。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter 过滤条件,目前支持:db-instance-id、db-instance-name、db-project-id、db-pay-mode、db-tag-key。
Limit Integer 每页显示数量,默认返回10条。
Offset Integer 分页序号,从0开始。
OrderBy String 排序指标,如实例名、创建时间等,支持DBInstanceId,CreateTime,Name,EndTime
OrderByType String 排序方式,包括升序、降序

3. 输出参数

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

4. 示例

示例1 查询所有实例列表

输入示例

https://postgres.tencentcloudapi.com/?Action=DescribeDBInstances
&Limit=10
&Offset=0
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "a6e3c73c-6810-42c2-842e-fa759ce52fa0",
    "TotalCount": 2,
    "DBInstanceSet": [
      {
        "Region": "ap-guangzhou",
        "Zone": "ap-guangzhou-2",
        "AppId": 251000710,
        "ProjectId": 0,
        "VpcId": "",
        "SubnetId": "",
        "DBInstanceId": "postgres-6bwgamo3",
        "DBInstanceName": "test",
        "DBInstanceStatus": "running",
        "DBInstanceMemory": 4,
        "DBInstanceStorage": 20,
        "DBInstanceCpu": 2,
        "DBInstanceClass": "cdb.pg.z1.4g",
        "DBInstanceType": "primary",
        "DBInstanceVersion": "standard",
        "DBInstanceNetInfo": [
          {
            "Address": "",
            "Ip": "10.66.187.1",
            "Port": 5432,
            "Status": "opened",
            "NetType": "inner"
          },
          {
            "Address": "",
            "Ip": "",
            "Port": 0,
            "Status": "0",
            "NetType": "public"
          }
        ],
        "DBCharset": "UTF8",
        "DBVersion": "9.5.4",
        "CreateTime": "2017-12-28 19:23:19",
        "UpdateTime": "2018-01-18 15:54:32",
        "ExpireTime": "2018-01-28 19:23:23",
        "IsolatedTime": "0000-00-00 00:00:00",
        "PayType": "prepaid",
        "AutoRenew": false
      },
      {
        "Region": "ap-guangzhou",
        "Zone": "ap-guangzhou-2",
        "AppId": 251000710,
        "ProjectId": 0,
        "VpcId": "",
        "SubnetId": "",
        "DBInstanceId": "postgres-1e2srvtt",
        "DBInstanceName": "未命名",
        "DBInstanceStatus": "running",
        "DBInstanceMemory": 4,
        "DBInstanceStorage": 20,
        "DBInstanceCpu": 2,
        "DBInstanceClass": "cdb.pg.z1.4g",
        "DBInstanceType": "primary",
        "DBInstanceVersion": "standard",
        "DBInstanceNetInfo": [
          {
            "Address": "",
            "Ip": "10.66.195.51",
            "Port": 5432,
            "Status": "opened",
            "NetType": "inner"
          },
          {
            "Address": "",
            "Ip": "",
            "Port": 0,
            "Status": "0",
            "NetType": "public"
          }
        ],
        "DBCharset": "UTF8",
        "DBVersion": "9.5.4",
        "CreateTime": "2017-12-28 19:50:15",
        "UpdateTime": "2018-01-19 10:34:21",
        "ExpireTime": "2018-01-28 19:50:17",
        "IsolatedTime": "0000-00-00 00:00:00",
        "PayType": "prepaid",
        "AutoRenew": false
      }
    ]
  }
}

示例2 根据实例ID查询实例信息

例如:查询实例ID为postgres-6bwgamo3的实例信息

输入示例

https://postgres.tencentcloudapi.com/?Action=DescribeDBInstances
&Limit=10
&Offset=0
&Filters.0.Name=db-instance-id
&Filters.0.Values.0=postgres-6bwgamo3
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "d849664a-191c-48bf-b42f-444caa189557",
    "TotalCount": 2,
    "DBInstanceSet": [
      {
        "Region": "ap-guangzhou",
        "Zone": "ap-guangzhou-2",
        "AppId": 100000000,
        "ProjectId": 0,
        "VpcId": "",
        "SubnetId": "",
        "DBInstanceId": "postgres-6bwgamo3",
        "DBInstanceName": "test",
        "DBInstanceStatus": "running",
        "DBInstanceMemory": 4,
        "DBInstanceStorage": 20,
        "DBInstanceCpu": 2,
        "DBInstanceClass": "cdb.pg.z1.4g",
        "DBInstanceType": "primary",
        "DBInstanceVersion": "standard",
        "DBInstanceNetInfo": [
          {
            "Address": "",
            "Ip": "xxxx",
            "Port": 5432,
            "Status": "opened",
            "NetType": "inner"
          },
          {
            "Address": "",
            "Ip": "",
            "Port": 0,
            "Status": "0",
            "NetType": "public"
          }
        ],
        "DBCharset": "UTF8",
        "DBVersion": "9.5.4",
        "CreateTime": "2017-12-28 19:23:19",
        "UpdateTime": "2018-01-18 15:54:32",
        "ExpireTime": "2018-01-28 19:23:23",
        "IsolatedTime": "0000-00-00 00:00:00",
        "PayType": "prepaid",
        "AutoRenew": false
      }
    ]
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UnauthorizedOperation 鉴权失败。
FailedOperation.CamCheckResourceFailed CAM资源检查失败。
FailedOperation.LimitOperation 实例被限制操作。
InternalError.DBError 后台DB执行错误。
InternalError.SystemError 系统错误。出现这种错误时,请联系客服支持。
InternalError.UnknownError 其他未知错误。出现这种错误时,请联系客服支持。
InvalidParameter 参数错误。
InvalidParameterValue.IllegalRegion 非法的Region参数。
InvalidParameterValue.InstanceNotExist 当前实例不存在。
InvalidParameterValue.RegionNotSupported 不支持当前地域。
InvalidParameterValue.StructParseFailed 解析参数出错。
ResourceUnavailable.InvalidInstanceStatus 实例状态错误。
目录