查詢云數據庫 Tair（兼容 Redis）實例的備份任務執行情況。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| kvstore:DescribeBackupTasks | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 實例 ID，可調用 DescribeInstances 接口獲取。 | r-bp1zxszhcgatnx**** |
| BackupJobId | string | 否 | 備份任務 ID。 說明
如果您調用 CreateBackup 執行了手動備份，您可以將返回的備份 ID 傳入，用以查詢備份的進度。
| 1162**** |
| JobMode | string | 否 | Manual |
返回參數
示例
正常返回示例
JSON格式
{
"InstanceId": "r-bp1zxszhcgatnx****",
"RequestId": "BB73740C-23E2-4392-9DA4-2660C74C****",
"BackupJobs": [
{
"StartTime": "2021-01-05T19:24:00Z",
"Process": "0",
"JobMode": "Manual",
"BackupJobID": 0,
"BackupProgressStatus": "NoStart",
"NodeId": "****",
"TaskAction": "NormalBackupTask"
}
],
"AccessDeniedDetail": {
"AuthAction": "-",
"AuthPrincipalDisplayName": "-",
"AuthPrincipalOwnerId": "-",
"AuthPrincipalType": "-",
"EncodedDiagnosticMessage": "-",
"NoPermissionType": "-",
"PolicyType": "-"
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-03-26 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-11-13 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-11-06 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-07-25 | OpenAPI 描述信息更新、OpenAPI 返回結構發生變更 | 查看變更詳情 |