查看AnalyticDB PostgreSQL版實例的數據備份列表和可恢復點。
接口說明
目前僅存儲彈性模式實例支持查看備份列表以及備份的詳細信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| gpdb:DescribeDataBackups | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 實例 ID。 說明
您可以調用 DescribeDBInstances 接口查看目標地域下所有的 AnalyticDB PostgreSQL 實例的詳情，包括實例 ID。
| gp-bp*************** |
| BackupId | string | 否 | 備份集 ID。如果帶上 BackupId，則是查詢該備份詳情。 說明
您可以調用 DescribeDataBackups 查看目標實例下的所有備份集信息，包括備份集 ID。
| 327329803 |
| StartTime | string | 是 | 查詢開始時間。格式： yyyy-MM-ddTHH:mmZ（UTC 時間）。 | 2011-06-01T15:00Z |
| EndTime | string | 是 | 查詢結束時間，需要大于查詢開始時間。格式： yyyy-MM-ddTHH:mmZ（UTC 時間）。 | 2011-06-01T16:00Z |
| PageSize | integer | 否 | 每頁記錄數。取值說明：
默認值：30。 | 30 |
| PageNumber | integer | 否 | 頁碼，取值大于 0 且不超過 Integer 的最大值。默認值：1。 | 1 |
| DataType | string | 否 | 備份類型。取值說明：
如果不傳，則默認返回全量備份集的記錄。 | DATA |
| BackupMode | string | 否 | 備份模式。取值說明：
如果不傳，則返回所有。 | Automated |
| BackupStatus | string | 否 | 備份集狀態。取值說明：
如果不傳，則返回所有。 | Success |
返回參數
示例
正常返回示例
JSON格式
{
"PageSize": 1,
"RequestId": "3E387971-33A5-5019-AD7F-DC**********",
"PageNumber": 1,
"TotalCount": 1,
"TotalBackupSize": 1111111111,
"Items": [
{
"DataType": "DATA",
"ConsistentTime": 1576506856,
"BackupStatus": "Success",
"BackupStartTime": "2021-12-22T12:00:25Z",
"BackupEndTime": "2021-12-22T12:01:43Z",
"BackupEndTimeLocal": "2021-12-22 20:00:25",
"BackupSetId": "1111111111",
"BaksetName": "adbpgbackup_555*****_20211222200019",
"BackupSize": 2167808,
"BackupMode": "Automated",
"BackupStartTimeLocal": "2011-05-30 03:29:00",
"DBInstanceId": "gp-bp**************-master",
"BackupMethod": "Physical"
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-08-29 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2023-08-17 | OpenAPI 返回結構發生變更 | 查看變更詳情 |