全部產品
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
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。