查詢云數據庫 Tair(兼容 Redis)實例的備份文件信息。
接口說明
本接口不適用云原生版集群架構實例,如有需要請使用 DescribeClusterBackupList 接口。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
kvstore:DescribeBackups | get | *DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID。 | r-bp1zxszhcgatnx**** |
BackupId | long | 否 | 備份文件的 ID。 | 11611111 |
BackupJobId | long | 否 | 備份任務 ID,由 CreateBackup 返回,CreateBackup 若返回多個 BackupJobId,則需要使用本接口分別對其查詢。 | 10001 |
PageSize | integer | 否 | 每頁最大記錄數,取值:30、50、100、200 或 300。 | 30 |
PageNumber | integer | 否 | 頁碼,取值大于 0 且不超過 Integer 數據類型的最大值,默認值為 1。 | 1 |
StartTime | string | 是 | 查詢開始時間,格式為yyyy-MM-ddTHH:mmZ(UTC 時間)。 | 2019-03-11T10:00Z |
EndTime | string | 是 | 查詢結束時間,必須晚于查詢開始時間,格式為yyyy-MM-ddTHH:mmZ(UTC 時間)。 | 2019-03-14T18:00Z |
NeedAof | string | 否 | 是否開啟 AoF 落盤,取值:
說明
默認值:0。
| 1 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "963C20F0-7CE1-4591-AAF3-6F3CD1CE****",
"PageNumber": 1,
"PageSize": 30,
"TotalCount": 5,
"FullStorageSize": 1000,
"LogStorageSize": 5000,
"FreeSize": 100000,
"Backups": {
"Backup": [
{
"BackupStatus": "Success",
"BackupStartTime": "2019-03-14T05:28:50Z",
"BackupType": "FullBackup",
"BackupDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
"NodeInstanceId": "r-bp10noxlhcoim2****-db-1",
"BackupEndTime": "2019-03-14T05:31:13Z",
"BackupId": 0,
"BackupDBNames": "all",
"EngineVersion": "4.0",
"BackupIntranetDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
"BackupSize": 1024,
"BackupMode": "Automated",
"BackupMethod": "Physical",
"BackupJobID": 24340,
"RecoverConfigMode": "{\"whitelist\":true,\"config\":true,\"account\":true}"
}
]
},
"AccessDeniedDetail": {
"AuthAction": "-",
"AuthPrincipalDisplayName": "-",
"AuthPrincipalOwnerId": "-",
"AuthPrincipalType": "-",
"EncodedDiagnosticMessage": "-",
"NoPermissionType": "-",
"PolicyType": "-"
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidStartTime.Malformed | The Specified parameter StartTime is not valid. | - |
400 | InvalidEndTime.Malformed | The Specified parameter EndTime is not valid. | 結束時間驗證失敗,時間格式應該為gmt時間例如2011-06-11T16:00Z |
400 | InvalidEngineVersion.Malformed | The Specified EngieVersion is not valid. | - |
400 | InvalidStartTimeAndEndTime.Malformed | The end time must be greater than the start time. | 結束時間必須大于開始時間 |
400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-09-06 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-05-23 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2024-05-06 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2024-03-26 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-22 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2024-01-03 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-11-13 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-11-06 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-07-25 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2022-11-29 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |