查詢某地區下包含備份組的PolarDB叢集詳情。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
polardb:DescribeDBClustersWithBackups |
get |
*DBCluster
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-************ |
| RegionId |
string |
是 |
地區 ID。 說明
可通過介面 DescribeRegions 查看地區資訊詳情。 |
cn-hangzhou |
| DBClusterIds |
string |
否 |
叢集 ID，支援傳入多個叢集 ID，叢集 ID 之間用英文逗號（,）分隔。 |
pc-************** |
| DBClusterDescription |
string |
否 |
叢集名稱，叢集名稱需滿足如下要求：
|
test |
| DBType |
string |
否 |
資料庫引擎類型，取值範圍如下：
|
MySQL |
| IsDeleted |
integer |
否 |
叢集是否已刪除，取值範圍如下：
|
0 |
| PageSize |
integer |
否 |
每頁記錄數，取值範圍如下：
預設值為 30。 |
30 |
| PageNumber |
integer |
否 |
頁碼，取值範圍為大於 0 但不超過 Integer 最大值的整數，預設值為 1。 |
1 |
| DBVersion |
string |
否 |
資料庫引擎版本號碼。
|
8.0 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
F8529AA2-522F-4B30-B80B-8F7D39****** |
| PageNumber |
integer |
頁數。 |
1 |
| PageRecordCount |
integer |
本頁叢集數量。 |
1 |
| TotalRecordCount |
integer |
總記錄數。 |
1 |
| Items |
object |
||
| DBCluster |
array<object> |
叢集詳情。 |
|
|
object |
|||
| DeletedTime |
string |
叢集刪除時間。 |
2022-05-12T03:25:37Z |
| VpcId |
string |
專用網路 ID。 |
vpc-****************** |
| ExpireTime |
string |
到期時間。 說明
僅付費方式為 Prepaid（訂用帳戶）的叢集會返回具體參數值，Postpaid（隨用隨付）叢集則返回空值。 |
2022-09-14T16:00:00Z |
| Expired |
string |
叢集是否到期。 說明
僅付費方式為 Prepaid（訂用帳戶）的叢集支援返該參數。 |
false |
| CreateTime |
string |
叢集建立時間。 |
2022-05-09T09:33:51Z |
| DBNodeClass |
string |
節點規格。 |
polar.mysql.x4.medium |
| PayType |
string |
付費類型，取值範圍如下：
|
Postpaid |
| DBType |
string |
資料庫引擎類型。 |
MySQL |
| LockMode |
string |
叢集的鎖定狀態，取值範圍如下：
|
Unlock |
| RegionId |
string |
地區 ID。 |
cn-hangzhou |
| DeletionLock |
integer |
叢集刪除的鎖定狀態，取值範圍如下：
|
0 |
| DBVersion |
string |
資料庫引擎版本。 |
8.0 |
| DBClusterId |
string |
叢集 ID。 |
pc-**************** |
| DBClusterStatus |
string |
叢集狀態，取值範圍如下：
|
Running |
| IsDeleted |
integer |
叢集是否已釋放，取值範圍如下：
|
1 |
| DBClusterNetworkType |
string |
叢集的網路類型。 |
VPC |
| DBClusterDescription |
string |
叢集名稱。 |
test |
| ZoneId |
string |
可用性區域 ID。 |
cn-hangzhou-h |
| Engine |
string |
叢集引擎。 |
POLARDB |
樣本
正常返回樣本
JSON格式
{
"RequestId": "F8529AA2-522F-4B30-B80B-8F7D39******",
"PageNumber": 1,
"PageRecordCount": 1,
"TotalRecordCount": 1,
"Items": {
"DBCluster": [
{
"DeletedTime": "2022-05-12T03:25:37Z",
"VpcId": "vpc-******************",
"ExpireTime": "2022-09-14T16:00:00Z",
"Expired": "false",
"CreateTime": "2022-05-09T09:33:51Z",
"DBNodeClass": "polar.mysql.x4.medium",
"PayType": "Postpaid",
"DBType": "MySQL",
"LockMode": "Unlock",
"RegionId": "cn-hangzhou",
"DeletionLock": 0,
"DBVersion": "8.0",
"DBClusterId": "pc-****************",
"DBClusterStatus": "Running",
"IsDeleted": 1,
"DBClusterNetworkType": "VPC",
"DBClusterDescription": "test",
"ZoneId": "cn-hangzhou-h",
"Engine": "POLARDB"
}
]
}
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidRegionId.Malformed | The specified parameter RegionId is not valid. | 指定的參數RegionId無效 |
| 400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | 指定的參數PageSize無效 |
| 400 | InvalidPageNumber.Malformed | The specified parameter PageNumber is not valid. | 指定的參數PageNumber無效 |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 由於某些未知錯誤、異常或失敗，請求處理失敗。 |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 由於伺服器臨時故障，請求失敗。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。