API 文档

查询实例列表

最近更新时间:2022-01-13 08:56:09

我的收藏

1. 接口描述

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

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

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

推荐使用 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:按照实例ID过滤,类型为string
db-instance-name:按照实例名过滤,类型为string
db-project-id:按照项目ID过滤,类型为integer
db-pay-mode:按照付费模式过滤,类型为string
db-tag-key:按照标签键过滤,类型为string
Limit Integer 每页显示数量,取值范围为1-100,默认为返回10条。
OrderBy String 排序指标,如实例名、创建时间等,支持DBInstanceId,CreateTime,Name,EndTime
Offset Integer 页码偏移量,从0开始。
OrderByType String 排序方式,包括升序:asc、降序:desc。

3. 输出参数

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

4. 示例

示例1 查询所有实例列表

输入示例

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

输出示例

{
  "Response": {
    "TotalCount": 1,
    "DBInstanceSet": [
      {
        "Zone": "ap-guangzhou-2",
        "DBInstanceName": "xxx",
        "Type": 1,
        "ReadOnlyInstanceNum": 1,
        "MasterDBInstanceId": "",
        "UpdateTime": "2020-09-22 00:00:00",
        "VpcId": "vpc-xxxxxxxx",
        "IsolatedTime": "2020-09-22 00:00:00",
        "DBVersion": "10",
        "DBKernelVersion": "v10.4_r1.0",
        "DBInstanceVersion": "standard",
        "AutoRenew": 1,
        "StatusInReadonlyGroup": "running",
        "SubnetId": "subnet-xxxxxxxx",
        "DBInstanceMemory": 1,
        "DBInstanceType": "primary",
        "DBInstanceStatus": "running",
        "OfflineTime": "2019-12-28 19:23:19",
        "Region": "ap-guangzhou",
        "ProjectId": 1,
        "DBInstanceNetInfo": [
          {
            "Address": "",
            "Ip": "10.10.10.220",
            "Port": 5432,
            "Status": "opened",
            "NetType": "private",
            "VpcId": "vpc-xxxxxxxx",
            "SubnetId": "subnet-xxxxxxxx"
          },
          {
            "Address": "",
            "Ip": "",
            "Port": 0,
            "Status": "",
            "NetType": "public",
            "VpcId": "",
            "SubnetId": ""
          }
        ],
        "DBInstanceStorage": 1,
        "Uid": 1,
        "DBCharset": "UTF8",
        "DBInstanceId": "postgres-xxxxxxxx",
        "PayType": "prepaid",
        "ExpireTime": "2020-09-22 00:00:00",
        "SupportIpv6": 1,
        "AppId": 1,
        "DBInstanceClass": "cdb.pg.z1.4g",
        "CreateTime": "2020-09-22 00:00:00",
        "DBInstanceCpu": 1,
        "TagList": [
          {
            "TagKey": "tag1",
            "TagValue": "v1"
          }
        ],
        "NetworkAccessList": []
      }
    ],
    "RequestId": "d849664a-191c-48bf-b42f-444caa189557"
  }
}

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

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

输入示例

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

输出示例

{
  "Response": {
    "RequestId": "d849664a-191c-48bf-b42f-444caa189557",
    "TotalCount": 1,
    "DBInstanceSet": [
      {
        "Region": "ap-guangzhou",
        "Zone": "ap-guangzhou-2",
        "AppId": 100000000,
        "Uid": 1000001,
        "ProjectId": 0,
        "VpcId": "vpc-xxxxxxxx",
        "SubnetId": "subnet-xxxxxxxx",
        "Type": 1,
        "DBInstanceId": "postgres-xxxxxxxx",
        "MasterDBInstanceId": "",
        "DBInstanceName": "test",
        "DBInstanceStatus": "running",
        "DBInstanceMemory": 4,
        "DBInstanceStorage": 20,
        "DBInstanceCpu": 2,
        "DBInstanceClass": "cdb.pg.z1.4g",
        "DBInstanceType": "primary",
        "DBInstanceVersion": "standard",
        "DBInstanceNetInfo": [
          {
            "Address": "",
            "Ip": "10.10.10.220",
            "Port": 5432,
            "Status": "opened",
            "NetType": "private",
            "VpcId": "vpc-xxxxxxxx",
            "SubnetId": "subnet-xxxxxxxx"
          },
          {
            "Address": "",
            "Ip": "",
            "Port": 0,
            "Status": "",
            "NetType": "public",
            "VpcId": "",
            "SubnetId": ""
          }
        ],
        "DBCharset": "UTF8",
        "DBVersion": "10",
        "DBKernelVersion": "v10.4_r1.0",
        "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",
        "OfflineTime": "2019-12-28 19:23:19",
        "StatusInReadonlyGroup": "running",
        "ReadOnlyInstanceNum": 1,
        "PayType": "prepaid",
        "AutoRenew": 1,
        "SupportIpv6": 0,
        "TagList": [
          {
            "TagKey": "tag1",
            "TagValue": "v1"
          }
        ],
        "NetworkAccessList": []
      }
    ]
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UnauthorizedOperation 鉴权失败。
FailedOperation.CamCheckResourceError 获取权限失败,请稍后重试。如果持续不成功,请联系客服进行处理。。
FailedOperation.CamCheckResourceFailed CAM资源检查失败。
FailedOperation.CamSigAndAuthError 鉴权失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.DatabaseAccessError 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.FailedOperationError 操作失败,请稍后重试。
FailedOperation.LimitOperation 实例被限制操作。
InternalError.DBError 后台DB执行错误。
InternalError.SystemError 系统错误。出现这种错误时,请联系客服支持。
InternalError.UnknownError 其他未知错误。出现这种错误时,请联系客服支持。
InvalidParameter 参数错误。
InvalidParameterValue.DataConvertError 数据格式转换失败,请联系客服处理。
InvalidParameterValue.IllegalRegion 非法的Region参数。
InvalidParameterValue.InstanceNotExist 当前实例不存在。
InvalidParameterValue.InvalidParameterValueError 参数值有误。
InvalidParameterValue.ParameterHandleError 参数处理失败,请检参数值设置是否有效。
InvalidParameterValue.RegionNotSupported 不支持当前地域。
InvalidParameterValue.StructParseFailed 解析参数出错。
OperationDenied.CamDeniedError 当前操作被限制。
ResourceNotFound.InstanceNotFoundError 实例不存在。
ResourceUnavailable.InvalidInstanceStatus 实例状态错误。
目录