查詢某地域下包含備份集的PolarDB集群詳情。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| polardb:DescribeDBClustersWithBackups | Read |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 |
返回參數
示例
正常返回示例
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. | 由于服務器臨時故障，請求失敗。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史