DescribeBackupTasks - 查詢備份任務執行情況 - Tair (Redis® OSS-Compatible)

查詢雲資料庫 Tair（相容 Redis）執行個體的備份任務執行情況。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeBackupTasks

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID，可調用 DescribeInstances 介面擷取。	r-bp1zxszhcgatnx****
BackupJobId	string	否	備份任務 ID。說明如果您調用 CreateBackup 執行了手動備份，您可以將返回的備份 ID 傳入，用以查詢備份的進度。	1162****
JobMode	string	否	備份模式，取值： Automated：系統自動備份，您可以調用 DescribeBackupPolicy 查詢自動備份策略。 Manual：手動備份說明預設返回所有備份模式的任務資訊。	Manual

返回參數

名稱	類型	描述	樣本值
	object
InstanceId	string	執行個體 ID。	r-bp1zxszhcgatnx****
RequestId	string	請求 ID。	BB73740C-23E2-4392-9DA4-2660C74C****
BackupJobs	array<object>	備份任務詳情。
	object
StartTime	string	備份任務開始時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2021-01-05T19:24:00Z
Process	string	備份任務進度百分比（不推薦，請查看 Progress 參數）。	0
JobMode	string	備份模式，傳回值： Automated：系統自動備份。 Manual：手動備份。	Manual
BackupJobID	integer	備份任務 ID。	29****10
BackupProgressStatus	string	備份任務狀態，傳回值： NoStart：未開始。 Preparing：準備中。 Waiting：等待中。 Uploading：上傳中 Checking：檢查中。 Finished：已完成。	NoStart
NodeId	string	資料節點 ID。	****
TaskAction	string	備份任務類型，傳回值： TempBackupTask：臨機操作備份任務，即手動備份。 NormalBackupTask：標準備份任務，即自動備份。	NormalBackupTask
Progress	string	備份的進度百分比，取值為 0-100。	27
AccessDeniedDetail	object	本組參數已棄用，請忽略。
AuthAction	string	說明如上。	-
AuthPrincipalDisplayName	string	說明如上。	-
AuthPrincipalOwnerId	string	說明如上。	-
AuthPrincipalType	string	說明如上。	-
EncodedDiagnosticMessage	string	說明如上。	-
NoPermissionType	string	說明如上。	-
PolicyType	string	說明如上。	-

樣本

正常返回樣本

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",
      "Progress": "27"
    }
  ],
  "AccessDeniedDetail": {
    "AuthAction": "-",
    "AuthPrincipalDisplayName": "-",
    "AuthPrincipalOwnerId": "-",
    "AuthPrincipalType": "-",
    "EncodedDiagnosticMessage": "-",
    "NoPermissionType": "-",
    "PolicyType": "-"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。