調(diào)用DescribeBackupTasks接口查詢實(shí)例的備份任務(wù)列表。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeBackupTasks

系統(tǒng)規(guī)定參數(shù)，取值：DescribeBackupTasks。

DBInstanceId String 是 rm-uf6wjk5xxxxxxx

實(shí)例ID。
ClientToken String 否 ETnLKlblzczshOTUbOCzxxxxxxx

用于保證請求的冪等性，防止重復(fù)提交請求。由客戶端生成該參數(shù)值，要保證在不同請求間唯一，最大值不超過64個(gè)ASCII字符，且該參數(shù)值中不能包含非ASCII字符。
Flag String 否 無

備用參數(shù)。
BackupJobId Integer 否 4762614

備份任務(wù)ID。
BackupMode String 否 Automated

備份模式，取值：

  • Automated：系統(tǒng)自動備份
  • Manual：手動備份
BackupJobStatus String 否 NoStart

備份任務(wù)狀態(tài)，取值：

  • NoStart：未開始
  • Progressing：正在進(jìn)行中

默認(rèn)為所有狀態(tài)。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
Items Array of BackupJob

備份任務(wù)詳情。
BackupJob
BackupId String 346650271

任務(wù)生成的備份集ID。

說明 當(dāng)返回參數(shù)BackupStatus=Finished之后，傳入請求參數(shù)BackupJobId才能夠查看到備份集ID。
BackupJobId String 4762614

備份任務(wù)ID。
BackupProgressStatus String NoStart

備份程序狀態(tài)。取值：

  • NoStart：未開始
  • Preparing：準(zhǔn)備中
  • Waiting：等待中
  • Uploading：上傳中
  • Checking：檢查中
  • Finished：已完成
BackupStatus String NoStart

備份任務(wù)狀態(tài)。取值：

  • NoStart：未開始
  • Checking：檢查備份
  • Preparing：準(zhǔn)備備份
  • Waiting：等待備份
  • Uploading：上傳備份
  • Finished：完成備份
  • Failed：備份失敗
說明 有任務(wù)執(zhí)行時(shí)才會返回本參數(shù)。
JobMode String Automated

備份模式，取值：

  • Automated：系統(tǒng)自動備份
  • Manual：手動備份
Process String 25

任務(wù)進(jìn)度百分比。
TaskAction String NormalBackupTask

任務(wù)類型，取值：

  • TempBackupTask：臨時(shí)備份任務(wù)
  • NormalBackupTask：普通備份任務(wù)
RequestId String 90496720-2319-42A8-87CD-FCE4DF95EBED

請求ID。

示例

請求示例

http(s)://rds.aliyuncs.com/?Action=DescribeBackupTasks
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<公共請求參數(shù)>

正常返回示例

XML 格式 

<DescribeBackupTasksResponse>
	  <Items>
		    <BackupJob>
			      <JobMode>Automated</JobMode>
			      <BackupProgressStatus>NoStart</BackupProgressStatus>
			      <TaskAction>NormalBackupTask</TaskAction>
			      <BackupStatus>NoStart</BackupStatus>
			      <BackupJobId>4762614</BackupJobId>
		    </BackupJob>
	  </Items>
	  <RequestId>90496720-2319-42A8-87CD-FCE4DF95EBED</RequestId>
</DescribeBackupTasksResponse>

JSON 格式 

{
    "Items": {
        "BackupJob": [
            {
                "JobMode": "Automated",
                "BackupProgressStatus": "NoStart",
                "TaskAction": "NormalBackupTask",
                "BackupStatus": "NoStart",
                "BackupJobId": 4762614
            }
        ]
    },
    "RequestId": "90496720-2319-42A8-87CD-FCE4DF95EBED"
}

錯(cuò)誤碼

訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。