全部产品
Search

搜索本产品

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

    文档中心

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

    更新时间：Mar 30, 2026

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

    接口说明

    使用说明

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

    QPS 限制

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

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    gpdb:DescribeDBInstances

    get

    *DBInstance

    acs:gpdb:{#regionId}:{#accountId}:dbinstance/*

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    RegionId

    string

    是

    地域 ID。

    说明

    您可以通过 DescribeRegions 接口查看可用的地域 ID。

    cn-hangzhou
    DBInstanceDescription

    string

    否

    实例描述。

    gp-bp12ga6v69h86****
    InstanceNetworkType

    string

    否

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

    • VPC：专有网络。

    • Classic：经典网络。

    说明

    如果不填，则返回所有网络类型的实例。

    VPC
    DBInstanceIds

    string

    否

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

    gp-bp12ga6v69h86****
    PageSize

    integer

    否

    每页记录数，取值说明：

    • 30

    • 50

    • 100

    默认值：30。

    50
    PageNumber

    integer

    否

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

    1
    Tag

    array<object>

    否

    标签列表。

    object

    否

    标签列表。

    Key

    string

    否

    标签键。

    test-key
    Value

    string

    否

    标签值。

    test-value
    InstanceDeployTypes

    array

    否

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

    string

    否

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

    null
    DBInstanceStatuses

    array

    否

    实例运行状态。

    string

    否

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

    说明

    该参数的传入值须为小写字母。

    running
    DBInstanceCategories

    array

    否

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

    string

    否

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

    • basic：基础版。

    • highavailability：高可用版。

    • finance：企业版。

    basic,highavailability
    DBInstanceModes

    array

    否

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

    string

    否

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

    • serverless：Serverless 版本。

    • storageelastic：存储弹性模式。

    • classic：存储预留模式。

    storageelastic,serverless
    ResourceGroupId

    string

    否

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

    rg-bp67acfmxazb4p****
    VpcId

    string

    否

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

    vpc-t4nqyp3tc5mx7vy6****

    返回参数

    名称

    类型

    描述

    示例值

    object

    列表。

    Items

    object

    DBInstance

    array<object>

    实例详情列表。

    array<object>

    实例详情。

    ConnectionMode

    string

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

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

    null
    CreateTime

    string

    实例创建时间（UTC 时间）。

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

    string

    实例系列，取值说明：

    • Basic：基础版。

    • HighAvailability：高可用版。

    • Finance：企业版。

    HighAvailability
    DBInstanceDescription

    string

    实例描述。

    gp-bp12ga6v69h86****
    DBInstanceId

    string

    实例 ID。

    gp-bp12ga6v69h86****
    DBInstanceMode

    string

    资源类型，取值说明：

    • Serverless：Serverless 版本。

    • StorageElastic：存储弹性模式。

    • Classic：存储预留模式。

    StorageElastic
    DBInstanceNetType

    string

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

    • 0：外网。

    • 1：内网。

    • 2：VPC 网络。

    2
    DBInstanceStatus

    string

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

    Running
    Engine

    string

    数据库类型。

    gpdb
    EngineVersion

    string

    数据库版本。

    6.0
    ExpireTime

    string

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

    说明

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

    2999-09-08T16:00:00Z
    InstanceDeployType

    string

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

    • cluster：存储弹性模式或 Serverless 版本。

    • replicaSet：存储预留模式。

    cluster
    InstanceNetworkType

    string

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

    • Classic：经典网络。

    • VPC：VPC 网络。

    VPC
    LockMode

    string

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

    • Unlock：正常。

    • ManualLock：手动触发锁定。

    • LockByExpiration：实例过期自动锁定。

    • LockByRestoration：实例回滚前的自动锁定。

    • LockByDiskQuota：实例空间满自动锁定。

    • LockReadInstanceByDiskQuota：只读实例空间满自动锁定。

    Unlock
    LockReason

    string

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

    • 0：正常。

    • 1：手动触发锁定。

    • 2：实例过期自动锁定。

    • 3：实例回滚前的自动锁定。

    • 4：实例空间满自动锁定。

    说明

    存储预留模式实例正常情况下返回值为空。

    0
    MasterNodeNum

    integer

    Master 节点数量。

    1
    PayType

    string

    计费类型，取值说明：

    • Postpaid：按量付费。

    • Prepaid：包年包月。

    Postpaid
    ProdType

    string

    产品类型，取值说明：

    • standard：标准版。

    • cost-effective：经济版。

    standard
    RegionId

    string

    地域 ID。

    cn-hangzhou
    ResourceGroupId

    string

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

    rg-bp67acfmxazb4p****
    SegNodeNum

    string

    Segment 节点数量。

    4
    ServerlessMode

    string

    Serverless 实例的模式，取值如下：

    • Manual：手动调度。

    • Auto：自动调度。

    说明

    • 仅 Serverless 模式实例返回该参数。

    • 云原生数据仓库 AnalyticDB PostgreSQL 版 Serverless 自动调度模式正在邀测中。如需使用，请您提交工单申请邀测资格。

    Manual
    StorageSize

    string

    存储空间大小，单位 GB。

    50
    StorageType

    string

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

    • cloud_essd：ESSD 云盘。

    • cloud_efficiency：高效云盘。

    cloud_essd
    Tags

    object

    Tag

    array<object>

    实例标签。

    object

    列表。

    Key

    string

    标签键。

    test-key
    Value

    string

    标签值。

    test-value
    VSwitchId

    string

    vSwitch ID。

    vsw-bp1cpq8mr64paltkb****
    VpcId

    string

    VPC ID。

    vpc-bp19ame5m1r3oejns****
    ZoneId

    string

    可用区 ID。

    cn-hangzhou-h
    PageNumber

    integer

    当前页码。

    1
    PageRecordCount

    integer

    当前页记录数。

    1
    RequestId

    string

    请求 ID。

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

    integer

    总记录数。

    1

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    更多信息，参考变更详情。