调用DescribeDBInstances查询数据库实例列表。

使用说明

本接口一般用于查看目标地域下的AnalyticDB PostgreSQL版实例的实例类型、网络类型、实例状态等信息。

QPS限制

本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。

本文档中的QPS仅为默认参考值，准确信息请参见API速率配额列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeDBInstances

系统规定参数。取值：DescribeDBInstances。

RegionId String 是 cn-hangzhou

地域ID。

说明 您可以通过DescribeRegions接口查看可用的地域ID。
DBInstanceDescription String 否 gp-bp***************

实例描述。
InstanceNetworkType String 否 VPC

实例网络类型，取值说明：

  • VPC：专有网络。
  • Classic：经典网络。
说明 如果不填，则返回所有网络类型的实例。
DBInstanceIds String 否 gp-bp***************

实例ID，多个实例ID之间用英文半角逗号（,）分隔。
PageSize Integer 否 50

每页记录数，取值说明：

  • 30
  • 50
  • 100

默认值：30。

PageNumber Integer 否 1

页码，大于0且不超过Integer的最大值，默认值：1。

InstanceDeployTypes Array of String 否 null

该参数已废弃，无需传入该参数。
DBInstanceStatuses Array of String 否 running

运行状态，多个值用英文逗号（,）分隔。实例的运行状态的值，请参见实例状态表。

DBInstanceCategories Array of String 否 basic,highavailability

实例系列，多个值用英文逗号（,）分隔。取值说明：

  • basic：基础版。
  • highavailability：高可用版。
  • finance：企业版。
DBInstanceModes Array of String 否 storageelastic,serverless

资源类型，多个值用英文逗号（,）分隔。取值说明：

  • serverless：Serverless版本。
  • storageelastic：存储弹性模式。
  • classic：存储预留模式。
Tag.N.Key String 否 test-key

标签键。
Tag.N.Value String 否 test-value

标签值。

返回数据

名称 类型 示例值 描述
TotalRecordCount Integer 1

总记录数。
PageRecordCount Integer 1

当前页记录数。
RequestId String 53EA07B7-FC2A-521B-AB7C-27**********

请求ID。
PageNumber Integer 1

当前页码。
Items Array of DBInstance

实例详情列表。
DBInstance
VpcId String vpc-bp*******************

VPC ID。
ExpireTime String 2999-09-08T16:00:00Z

实例到期时间（UTC时间）。

说明 按量付费实例的到日时间为2999-09-08T16:00:00Z。
DBInstanceNetType String 2

实例网卡类型，取值说明：

  • 0：外网。
  • 1：内网。
  • 2：VPC网络。
InstanceDeployType String cluster

实例资源类型，取值说明：

  • cluster：存储弹性模式或Serverless版本。
  • replicaSet：存储预留模式。
StorageType String cloud_essd

实例存储类型，取值说明：

  • cloud_essd：ESSD云盘。
  • cloud_efficiency：高效云盘。
CreateTime String 2021-10-09T04:54:08Z

实例创建时间（UTC时间）。
PayType String Postpaid

计费类型，取值说明：

  • Postpaid：按量付费。
  • Prepaid：包年包月。
Tags Array of Tag

实例标签。
Tag
Key String test-key

标签键。
Value String test-value

标签值。
LockReason String 0

被锁定的原因，取值说明：

  • 0：正常。
  • 1：手动触发锁定。
  • 2：实例过期自动锁定。
  • 3：实例回滚前的自动锁定。
  • 4：实例空间满自动锁定。
说明 存储预留模式实例正常情况下返回值为空。
DBInstanceStatus String Running

实例状态，详见实例状态表。

ConnectionMode String null

该参数已废弃，故不会返回参数值。

如需查询访问模式可以通过DescribeDBInstanceAttribute接口查询。

LockMode String Unlock

实例锁定模式，取值说明：

  • Unlock：正常。
  • ManualLock：手动触发锁定。
  • LockByExpiration：实例过期自动锁定。
  • LockByRestoration：实例回滚前的自动锁定。
  • LockByD