查詢PolarDB集群的備份信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| polardb:DescribeBackups | Read |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 集群 ID。 | pc-**************** |
| BackupId | string | 否 | 備份 ID。 | 11111111 |
| BackupStatus | string | 否 | 備份狀態，取值范圍如下：
| Success |
| BackupMode | string | 否 | 備份模式，取值范圍如下：
| Automated |
| StartTime | string | 是 | 查詢開始時間，格式為 | 2020-11-14T00:00Z |
| EndTime | string | 是 | 查詢結束時間，查詢結束時間需晚于開始時間，格式為 | 2020-11-16T00:00Z |
| BackupRegion | string | 否 | 跨地域備份的目的地域。 說明
當前僅 PolarDB MySQL 版支持該參數。
| cn-hangzhou |
| PageSize | integer | 否 | 每頁記錄數，取值范圍如下：
默認值為 30。 | 30 |
| PageNumber | integer | 否 | 頁碼，取值范圍為大于 0 但不超過 Integer 最大值的整數，默認值為 1。 | 1 |
返回參數
示例
正常返回示例
JSON格式
{
"TotalRecordCount": "1",
"PageRecordCount": "1",
"RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
"PageNumber": "1",
"Items": {
"Backup": [
{
"BackupSetSize": "4639948800",
"ConsistentTime": "1605425407",
"BackupStatus": "Success",
"BackupType": "FullBackup",
"BackupStartTime": "2020-11-15T07:30:05Z",
"ExpectExpireTime": "2022-10-24T08:13:23Z",
"ExpectExpireType": "EXPIRED\u0000\u0000",
"IsAvail": "0",
"BackupEndTime": "2020-11-15T07:30:20Z",
"BackupId": "61*******",
"DBClusterId": "pc-****************",
"BackupsLevel": "Level-1",
"BackupMode": "Automated",
"BackupMethod": "Snapshot"
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的參數DBClusterId無效 |
| 400 | InvalidBackupStatus.Malformed | The specified parameter BackupStatus is not valid. | 指定的參數BackupStatus無效 |
| 400 | InvalidBackupMode.Malformed | The specified parameter BackupMode is not valid. | 指定的參數BackupMode無效 |
| 400 | InvalidStartTime.Malformed | The specified parameter StartTime is not valid. | 指定的參數StartTime無效 |
| 400 | InvalidEndTime.Malformed | The specified parameter EndTime is not valid. | 指定的參數EndTime無效 |
| 400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | 指定的參數PageSize無效 |
| 400 | InvalidPageNumber.Malformed | The specified parameter PageNumber is not valid. | 指定的參數PageNumber無效 |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 當前的記錄中不存在提供的DBClusterId。 |
| 404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | 當前的記錄中不存在提供的DBClusterId。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-09-12 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2023-05-26 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 看變更集 | ||||||||
| ||||||||||
| 2022-06-01 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 看變更集 | ||||||||
|