查詢AnalyticDB PostgreSQL版數據庫實例列表。
接口說明
使用說明
本接口用于查看目標地域下的 AnalyticDB PostgreSQL 版實例的實例類型、網絡類型、實例狀態等信息。
QPS 限制
本接口的單用戶 QPS 限制默認為 1000 次/秒。超過限制，API 調用會被限流，這可能會影響您的業務，請合理調用。
本文檔中的 QPS 僅為默認參考值，準確信息請參見 API 速率配額列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| gpdb:DescribeDBInstances | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。 說明
您可以通過 DescribeRegions 接口查看可用的地域 ID。
| cn-hangzhou |
| DBInstanceDescription | string | 否 | 實例描述。 | gp-bp12ga6v69h86**** |
| InstanceNetworkType | string | 否 | 實例網絡類型，取值說明：
說明
如果不填，則返回所有網絡類型的實例。
| VPC |
| DBInstanceIds | string | 否 | 實例 ID，多個實例 ID 之間用英文半角逗號（,）分隔。 | gp-bp12ga6v69h86**** |
| PageSize | integer | 否 | 每頁記錄數，取值說明：
默認值：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 | |
| DBInstanceModes | array | 否 | 資源類型，多個值用英文逗號（,）分隔。 | |
| string | 否 | 資源類型，多個值用英文逗號（,）分隔。取值說明：
| storageelastic,serverless | |
| ResourceGroupId | string | 否 | 實例所在的企業資源組 ID。 | rg-bp67acfmxazb4p**** |
| VpcId | string | 否 | 專有網絡 ID。 可根據該參數篩選出同一 VPC 的數據。 | vpc-t4nqyp3tc5mx7vy6**** |
返回參數
示例
正常返回示例
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-04 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-12-11 | OpenAPI 入參發生變更 | 查看變更詳情 |