调用DescribeBackupTasks接口查询实例的备份任务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeBackupTasks

系统规定参数，取值：DescribeBackupTasks。

DBInstanceId String 是 rm-uf6wjk5xxxxxxx

实例ID。
ClientToken String 否 ETnLKlblzczshOTUbOCzxxxxxxx

用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。
Flag String 否 无

备用参数。
BackupJobId Integer 否 4762614

备份任务ID。
BackupMode String 否 Automated

备份模式，取值：

  • Automated：系统自动备份
  • Manual：手动备份
BackupJobStatus String 否 NoStart

备份任务状态，取值：

  • NoStart：未开始
  • Progressing：正在进行中

默认为所有状态。

返回数据

名称 类型 示例值 描述
Items Array of BackupJob

备份任务详情。
BackupJob
BackupId String 346650271

任务生成的备份集ID。

说明 当返回参数 BackupStatus= Finished之后，传入请求参数 BackupJobId才能够查看到备份集ID。
BackupJobId String 4762614

备份任务ID。
BackupProgressStatus String NoStart

备份程序状态。取值：

  • NoStart：未开始
  • Preparing：准备中
  • Waiting：等待中
  • Uploading：上传中
  • Checking：检查中
  • Finished：已完成
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": [
            {
                "JobMode": "Automated",
                "BackupProgressStatus": "NoStart",
                "TaskAction": "NormalBackupTask",
                "BackupStatus": "NoStart",
                "BackupJobId": 4762614
            }
        ]
    },
    "RequestId": "90496720-2319-42A8-87CD-FCE4DF95EBED"
}

错误码

访问错误中心查看更多错误码。