取得 GDN 執行個體清單。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
polardbx:DescribeGdnInstances |
list |
*全部資源。
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| PageSize |
string |
否 |
頁面大小。 |
30 |
| PageNum |
string |
否 |
頁碼，取值為大於 0 且不超過 Integer 資料類型的最大值，預設值為 1。 |
50 |
| FilterType |
string |
否 |
訊息過濾類型。 |
gdn_id、 polarx_id |
| FilterValue |
string |
否 |
查詢資源時的篩選值。 與 FilterKey 配合使用。 |
gdn-***、 pxc-*** |
| GDNId |
string |
否 |
GDN ID。 |
gdn-*** |
| RegionId |
string |
否 |
地域 ID。 |
cn-hangzhou |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回資訊清單。 |
||
| RequestId |
string |
請求 ID。 |
7B044BD1-6402-5DE9-9AED-63D15A994E37 |
| Message |
string |
請求返回訊息。 說明
請求成功時該參數為空，請求失敗時會返回請求異常資訊（如錯誤碼等）。 |
success |
| Success |
boolean |
請求是否成功。 |
True |
| Data |
object |
執行個體詳情清單。 |
|
| PageNumber |
string |
頁面索引。 |
1 |
| PageSize |
string |
頁面大小。 |
30 |
| TotalNumber |
string |
總數。 |
130 |
| GdnInstanceList |
array<object> |
GDN 執行個體清單。 |
|
|
array<object> |
|||
| GdnInstanceName |
string |
GDN 執行個體名稱 |
gdn-*** |
| GmtCreated |
string |
建立時間 |
2025-01-02T13:11:10.000+0000 |
| SwitchHistory |
string |
切換日誌 |
"" |
| Status |
string |
狀態。 |
Creating |
| MemberList |
array<object> |
成員清單。 |
|
|
object |
結構體 |
||
| MemberName |
string |
成員名稱（polarx 執行個體名稱）。 |
pxc-*** |
| Role |
string |
成員角色。 |
primary、 standby |
| Status |
string |
成員狀態。 |
Creating |
| GmtCreated |
string |
建立時間 |
2025-01-02T13:11:10.000+0000 |
| SecondsBehindMaster |
string |
資料延遲 |
1s |
| CommodityCode |
string |
商品 code |
drds_polarxpre_public_cn |
| RegionId |
string |
地區 ID。 |
cn-hangzhou |
| ClassCode |
string |
執行個體規格。 |
polarx.x4.medium.2e |
| PayType |
string |
執行個體付費方式，取值：
|
Prepaid |
| ExpireTime |
string |
到期時間。 |
2025-01-02T13:11:10.000+0000 |
| PrimaryZone |
string |
主要可用區。 |
cn-zhangjiakou-a |
| SecondaryZone |
string |
次要可用區。 |
cn-zhangjiakou-a |
| TertiaryZone |
string |
第三可用區。 |
cn-zhangjiakou-a |
| ZoneId |
string |
可用區 ID。 |
cn-zhangjiakou-a |
| CnNodeClassCode |
string |
CN 節點規格。
|
polarx.x4.medium.2e |
| DnNodeClassCode |
string |
DN 節點規格。
|
mysql.n4.medium.25 |
| CnNodeCount |
string |
CN 節點個數。 |
2 |
| DnNodeCount |
string |
DN 節點個數。 |
2 |
| TaskStatus |
string |
切換工作狀態 |
prepared：参数初始化完毕 set_old_primary_readonly：原主实例已禁写 set_new_primary_read_write：已切换 timeout：任务超时 rollback：已回滚 |
| DataSyncStatus |
string |
||
| ReadWriteStatus |
string |
||
| Description |
string |
描述資訊。 |
test |
| MysqlVersion |
string |
執行個體支援的 MySQL 版本。 |
5.7 |
| GdnMode |
string |
||
| RplSyncDdl |
boolean |
||
| RplDmlStrategy |
string |
||
| RplConflictStrategy |
string |
樣本
正常返回樣本
JSON格式
{
"RequestId": "7B044BD1-6402-5DE9-9AED-63D15A994E37",
"Message": "success",
"Success": true,
"Data": {
"PageNumber": "1",
"PageSize": "30",
"TotalNumber": "130",
"GdnInstanceList": [
{
"GdnInstanceName": "gdn-***",
"GmtCreated": "2025-01-02T13:11:10.000+0000",
"SwitchHistory": "\"\"",
"Status": "Creating",
"MemberList": [
{
"MemberName": "pxc-***",
"Role": "primary、\nstandby",
"Status": "Creating",
"GmtCreated": "2025-01-02T13:11:10.000+0000",
"SecondsBehindMaster": "1s",
"CommodityCode": "drds_polarxpre_public_cn",
"RegionId": "cn-hangzhou",
"ClassCode": "polarx.x4.medium.2e",
"PayType": "Prepaid",
"ExpireTime": "2025-01-02T13:11:10.000+0000",
"PrimaryZone": "cn-zhangjiakou-a",
"SecondaryZone": "cn-zhangjiakou-a",
"TertiaryZone": "cn-zhangjiakou-a",
"ZoneId": "cn-zhangjiakou-a",
"CnNodeClassCode": "polarx.x4.medium.2e",
"DnNodeClassCode": "mysql.n4.medium.25",
"CnNodeCount": "2",
"DnNodeCount": "2",
"TaskStatus": "prepared：参数初始化完毕\nset_old_primary_readonly：原主实例已禁写\nset_new_primary_read_write：已切换\ntimeout：任务超时\nrollback：已回滚\n",
"DataSyncStatus": "",
"ReadWriteStatus": ""
}
],
"Description": "test",
"MysqlVersion": "5.7",
"GdnMode": "",
"RplSyncDdl": false,
"RplDmlStrategy": "",
"RplConflictStrategy": ""
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。