MyBase中的PolarDB列表
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
GET HTTP/1.1請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
地區 ID。 |
cn-hangzhou |
| DBClusterIds |
string |
否 |
叢集 ID。多個叢集 ID 間用英文逗號（,）隔開。 |
pc-**************** |
| DBClusterDescription |
string |
否 |
叢集描述，可模糊查詢。 |
pc-**************** |
| ConnectionString |
string |
否 |
資料庫連接地址。 |
********.rwlb.polardb-pg-public.rds.aliyuncs.com |
| DBClusterStatus |
string |
否 |
叢集狀態。 |
Running |
| DBType |
string |
否 |
資料庫類型，取值範圍如下：
|
MySQL |
| DescribeType |
string |
否 |
列表查詢方式。取值為 Simple，表示簡略模式，僅返回叢集的基本中繼資料資訊。 |
Simple |
| DBVersion |
string |
否 |
資料庫版本。 |
5.6 |
| RecentCreationInterval |
integer |
否 |
篩選最近 N 天建立的叢集。取值範圍：0~15。 |
7 |
| RecentExpirationInterval |
integer |
否 |
篩選 N 天后到期的叢集。取值範圍：0~15。 |
6 |
| Expired |
string |
否 |
是否叢集已到期。取值範圍如下：
|
true |
| PageSize |
integer |
否 |
每頁記錄數，取值為 30、50 或 100。 預設值為 30。 |
30 |
| PageNumber |
integer |
否 |
頁碼，取值為大於 0 且不超過 整數資料類型的最大值，預設值為 1。 |
10 |
| ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-********** |
| Tag |
array<object> |
否 |
標籤列表。 |
|
|
object |
否 |
|||
| Value |
string |
否 |
標籤鍵對應的標籤值。 |
5.6 |
| Key |
string |
否 |
標籤鍵，可以根據標籤過濾叢集列表。最多 20 對標籤，各個標籤對的數字 n 必須不同，且必須是從 1 開始的連續整數。Tag.n.Key 對應的值為 Tag.n.Value。 |
MySQL |
| PayType |
string |
否 |
付費類型，取值範圍如下：
|
Postpaid |
| DBNodeIds |
string |
否 |
節點 ID。支援傳入多個節點 ID，多個 ID 間用英文逗號（,）分隔。 |
pi-*************** |
| CloudProvider |
string |
否 |
雲廠商。 |
AlibabaCloud |
| MaxResults |
integer |
否 |
本次讀取的最巨量資料量，預設值為 10。 |
10 |
| NextToken |
string |
否 |
查詢憑證（token），取值為上一次 api 調用返回的 nexttoken 參數值。如果沒有下一個查詢，請不傳。 |
212db86sca4384811e0b5e8707e****** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| TotalRecordCount |
integer |
總記錄數。 |
16 |
| PageRecordCount |
integer |
本頁叢集數量。 |
5 |
| RequestId |
string |
請求 ID。 |
9B7BFB11-C077-4FE3-B051-F69CEB****** |
| PageNumber |
integer |
頁數。 |
12 |
| Items |
array<object> |
叢集列表。 |
|
|
object |
|||
| Category |
string |
叢集系列，目前支援如下系列：
|
Normal |
| DBClusterId |
string |
叢集 ID。 |
pc-**************** |
| DBType |
string |
資料庫類型。 |
MySQL |
| CentralControlRegionId |
string |
中心管控。 |
cn-beijing |
| DBVersion |
string |
資料庫版本。 |
5.6 |
| CloudProvider |
string |
雲廠商。 |
ENS |
| Tags |
array<object> |
標籤列表。 |
|
|
object |
|||
| Value |
string |
標籤值。 |
5.6 |
| Key |
string |
標籤鍵。 |
MySQL |
| StorageType |
string |
標準版儲存類型取值如下：
|
essdautopl |
| ZoneId |
string |
可用性區域 ID。 |
cn-hangzhou-i |
| DBClusterStatus |
string |
叢集狀態。 |
Running |
| CreateTime |
string |
建立時間。 |
2020-08-14T05:58:42Z |
| DBClusterDescription |
string |
叢集描述。 |
GDN-1 |
| Expired |
string |
叢集是否到期。取值範圍：
|
false |
| PayType |
string |
付費類型。取值範圍：
|
Prepaid |
| LockMode |
string |
叢集的鎖定狀態，取值範圍如下：
|
Unlock |
| VswitchId |
string |
虛擬交換器 ID。 |
vsw-*************** |
| StrictConsistency |
string |
叢集是否開啟了多可用性區域資料強一致。取值範圍：
|
ON |
| DBNodeClass |
string |
節點規格。 |
polar.mysql.g1.tiny.c |
| StorageUsed |
integer |
叢集已經使用的儲存用量，單位為 Byte。 |
3009413120 |
| ENSRegionId |
string |
ENS 地區 ID。 |
sg-singapore-9 |
| DBNodeNumber |
integer |
節點數量。 |
2 |
| VpcId |
string |
專用網路 ID。 |
vpc-**************** |
| StorageSpace |
integer |
執行個體的儲存空間名稱。 |
10 |
| ServerlessType |
string |
Serverless 類型。返回 AgileServerless 表示當前叢集是 Serverless 叢集，返回空值表示當前叢集是普通叢集。 |
AgileServerless |
| AiType |
string |
ai 節點資訊狀態。取值範圍如下：
|
SearchNode |
| CpuCores |
string |
CPU 核心數。單位：個。 |
1 |
| SubCategory |
string |
計算節點的規格類型，取值範圍如下：
|
Exclusive |
| ExpireTime |
string |
叢集到期時間。 說明
僅付費方式為 Prepaid（訂用帳戶）的叢集會返回具體參數值，Postpaid（隨用隨付）叢集則返回空值。 |
2022-09-14T16:00:00Z |
| MaxResults |
integer |
本次讀取的最巨量資料量，預設值為 10。 |
10 |
| NextToken |
string |
查詢憑證（token），取值為上一次 api 調用返回的 nexttoken 參數值。如果沒有下一個查詢，請不傳。 |
212db86sca4384811e0b5e8707e****** |
樣本
正常返回樣本
JSON格式
{
"TotalRecordCount": 16,
"PageRecordCount": 5,
"RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
"PageNumber": 12,
"Items": [
{
"Category": "Normal",
"DBClusterId": "pc-****************",
"DBType": "MySQL",
"CentralControlRegionId": "cn-beijing",
"DBVersion": "5.6",
"CloudProvider": "ENS",
"Tags": [
{
"Value": "5.6",
"Key": "MySQL"
}
],
"StorageType": "essdautopl",
"ZoneId": "cn-hangzhou-i",
"DBClusterStatus": "Running",
"CreateTime": "2020-08-14T05:58:42Z",
"DBClusterDescription": "GDN-1",
"Expired": "false",
"PayType": "Prepaid",
"LockMode": "Unlock",
"VswitchId": "vsw-***************",
"StrictConsistency": "ON",
"DBNodeClass": "polar.mysql.g1.tiny.c",
"StorageUsed": 3009413120,
"ENSRegionId": "sg-singapore-9",
"DBNodeNumber": 2,
"VpcId": "vpc-****************",
"StorageSpace": 10,
"ServerlessType": "AgileServerless",
"AiType": "SearchNode",
"CpuCores": "1",
"SubCategory": "Exclusive",
"ExpireTime": "2022-09-14T16:00:00Z"
}
],
"MaxResults": 10,
"NextToken": "212db86sca4384811e0b5e8707e******"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。