全部产品
Search
文档中心

云原生数据仓库AnalyticDB PostgreSQL版:DescribeDBInstances - 查询数据库实例列表

更新时间:Jun 19, 2024

查询AnalyticDB PostgreSQL版数据库实例列表。

接口说明

使用说明

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

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:DescribeDBInstancesRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

说明 您可以通过 DescribeRegions 接口查看可用的地域 ID。
cn-hangzhou
DBInstanceDescriptionstring

实例描述。

gp-bp12ga6v69h86****
InstanceNetworkTypestring

实例网络类型,取值说明:

  • VPC:专有网络。
  • Classic:经典网络。
说明 如果不填,则返回所有网络类型的实例。
VPC
DBInstanceIdsstring

实例 ID,多个实例 ID 之间用英文半角逗号(,)分隔。

gp-bp12ga6v69h86****
PageSizeinteger

每页记录数,取值说明:

  • 30
  • 50
  • 100

默认值:30

50
PageNumberinteger

页码,大于 0 且不超过 Integer 的最大值,默认值:1

1
Tagobject []

标签列表。

Keystring

标签键。

test-key
Valuestring

标签值。

test-value
InstanceDeployTypesarray

该参数已废弃,无需传入该参数。

string

该参数已废弃,无需传入该参数。

null
DBInstanceStatusesarray

实例运行状态。

string

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

说明 该参数的传入值须为小写字母。
running
DBInstanceCategoriesarray

实例系列,多个值用英文逗号(,)分隔。

string

实例系列,多个值用英文逗号(,)分隔。取值说明:

  • basic:基础版。
  • highavailability:高可用版。
  • finance:企业版。
basic,highavailability
DBInstanceModesarray

资源类型,多个值用英文逗号(,)分隔。

string

资源类型,多个值用英文逗号(,)分隔。取值说明:

  • serverless:Serverless 版本。
  • storageelastic:存储弹性模式。
  • classic:存储预留模式。
storageelastic,serverless
ResourceGroupIdstring

实例所在的企业资源组 ID。

rg-bp67acfmxazb4p****
VpcIdstring

专有网络 ID。 可根据该参数筛选出同一 VPC 的数据。

vpc-t4nqyp3tc5mx7vy6****

返回参数

名称类型描述示例值
object

列表。

TotalRecordCountinteger

总记录数。

1
PageRecordCountinteger

当前页记录数。

1
RequestIdstring

请求 ID。

53EA07B7-FC2A-521B-AB7C-27**********
PageNumberinteger

当前页码。

1
Itemsobject []

实例详情列表。

VpcIdstring

VPC ID。

vpc-bp19ame5m1r3oejns****
ExpireTimestring

实例到期时间(UTC 时间)。

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

实例网卡类型,取值说明:

  • 0:外网。
  • 1:内网。
  • 2:VPC 网络。
2
InstanceDeployTypestring

实例资源类型,取值说明:

  • cluster:存储弹性模式或 Serverless 版本。
  • replicaSet:存储预留模式。
cluster
StorageTypestring

实例存储类型,取值说明:

  • cloud_essd:ESSD 云盘。
  • cloud_efficiency:高效云盘。
cloud_essd
CreateTimestring

实例创建时间(UTC 时间)。

2021-10-09T04:54:08Z
PayTypestring

计费类型,取值说明:

  • Postpaid:按量付费。
  • Prepaid:包年包月。
Postpaid
Tagsobject []

实例标签。

Keystring

标签键。

test-key
Valuestring

标签值。

test-value
LockReasonstring

被锁定的原因,取值说明:

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

实例状态,详见实例状态表

Running
ConnectionModestring

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

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

null
LockModestring

实例锁定模式,取值说明:

  • Unlock:正常。
  • ManualLock:手动触发锁定。
  • LockByExpiration:实例过期自动锁定。
  • LockByRestoration:实例回滚前的自动锁定。
  • LockByDiskQuota:实例空间满自动锁定。
  • LockReadInstanceByDiskQuota:只读实例空间满自动锁定。
Unlock
EngineVersionstring

数据库版本。

6.0
RegionIdstring

地域 ID。

cn-hangzhou
VSwitchIdstring

vSwitch ID。

vsw-bp1cpq8mr64paltkb****
InstanceNetworkTypestring

实例网络类型,取值说明:

  • Classic:经典网络。
  • VPC:VPC 网络。
VPC
ZoneIdstring

可用区 ID。

cn-hangzhou-h
DBInstanceIdstring

实例 ID。

gp-bp12ga6v69h86****
Enginestring

数据库类型。

gpdb
DBInstanceDescriptionstring

实例描述。

gp-bp12ga6v69h86****
SegNodeNumstring

Segment 节点数量。

4
StorageSizestring

存储空间大小,单位 GB。

50
MasterNodeNuminteger

Master 节点数量。

1
DBInstanceCategorystring

实例系列,取值说明:

  • Basic:基础版。
  • HighAvailability:高可用版。
  • Finance:企业版。
HighAvailability
DBInstanceModestring

资源类型,取值说明:

  • Serverless:Serverless 版本。
  • StorageElastic:存储弹性模式。
  • Classic:存储预留模式。
StorageElastic
ResourceGroupIdstring

实例所在的企业资源组 ID。

rg-bp67acfmxazb4p****
ServerlessModestring

Serverless 实例的模式,取值如下:

  • Manual:手动调度。
  • Auto:自动调度。
说明 仅 Serverless 模式实例返回该参数。
Manual
ProdTypestring

产品类型,取值说明:

  • standard:标准版。
  • cost-effective:经济版。
standard

示例

正常返回示例

JSON格式

{
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "RequestId": "53EA07B7-FC2A-521B-AB7C-27**********",
  "PageNumber": 1,
  "Items": {
    "DBInstance": [
      {
        "VpcId": "vpc-bp19ame5m1r3oejns****",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "DBInstanceNetType": "2",
        "InstanceDeployType": "cluster",
        "StorageType": "cloud_essd",
        "CreateTime": "2021-10-09T04:54:08Z",
        "PayType": "Postpaid",
        "Tags": {
          "Tag": [
            {
              "Key": "test-key",
              "Value": "test-value"
            }
          ]
        },
        "LockReason": "0",
        "DBInstanceStatus": "Running",
        "ConnectionMode": "null",
        "LockMode": "Unlock",
        "EngineVersion": "6.0",
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-bp1cpq8mr64paltkb****",
        "InstanceNetworkType": "VPC",
        "ZoneId": "cn-hangzhou-h",
        "DBInstanceId": "gp-bp12ga6v69h86****",
        "Engine": "gpdb",
        "DBInstanceDescription": "gp-bp12ga6v69h86****",
        "SegNodeNum": "4",
        "StorageSize": "50",
        "MasterNodeNum": 1,
        "DBInstanceCategory": "HighAvailability",
        "DBInstanceMode": "StorageElastic",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ServerlessMode": "Manual",
        "ProdType": "standard"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-04OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-12-11OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:VpcId