調用DescribeBackupTasks介面查詢執行個體的備份工作清單。

調試

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

請求參數

名稱 類型 是否必選 樣本值 描述
Action String 是 DescribeBackupTasks

系統規定參數，取值：DescribeBackupTasks。

DBInstanceId String 是 rm-uf6wjk5xxxxxxx

執行個體ID。
ClientToken String 否 ETnLKlblzczshOTUbOCzxxxxxxx

用於保證請求的等冪性，防止重複提交請求。由用戶端產生該參數值，要保證在不同請求間唯一，最大值不超過64個ASCII字元，且該參數值中不能包含非ASCII字元。
BackupJobId String 否 4762614

備份任務ID。
BackupMode String 否 Automated

備份模式，取值：

  • Automated：系統自動備份；
  • Manual：手動備份。
BackupJobStatus String 否 0

備份任務狀態，取值：

  • 0：未開始；
  • 1：進行中中。

預設為所有狀態。
AccessKeyId String 否 LTAIfCxxxxxxxxxx

阿里雲頒發給使用者的訪問服務所用的密鑰ID。
Flag String 否 -

備用參數。

返回資料

名稱 類型 樣本值 描述
Items

備份任務詳情。
BackupId String 346650271

任務產生的備份組ID。

说明 當返回參數BackupStatus=Finished之後，可以通過傳入請求參數BackupJobId查看備份組ID。
BackupJobId String 4762614

備份任務ID。
BackupProgressStatus String NoStart

備份程式狀態。
BackupStatus String NoStart

備份任務狀態，取值：

  • NoStart：未開始；
  • Checking：檢查備份；
  • Preparing：準備備份；
  • Waiting：等待備份；
  • Uploading：上傳備份；
  • Finished：完成備份；
  • Failed：備份失敗。
JobMode String Automated

備份模式，取值：

  • Automated：系統自動備份；
  • Manual：手動備份。
Process String 25

任務進度百分比。
TaskAction String NormalBackupTask

任務類型，取值：

  • TempBackupTask：臨機操作備份任務；
  • NormalBackupTask：標準備份任務。
RequestId String 90496720-2319-42A8-87CD-FCE4DF95EBED

請求ID。

樣本

請求樣本


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

正常返回樣本

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":[
			{
				"BackupProgressStatus":"NoStart",
				"JobMode":"Automated",
				"TaskAction":"NormalBackupTask",
				"BackupStatus":"NoStart",
				"BackupJobId":4762614
			}
		]
	},
	"RequestId":"90496720-2319-42A8-87CD-FCE4DF95EBED"
}

錯誤碼

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