调用DescribeBackupTasks接口查询集群的备份任务列表。

调试

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

请求参数

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

系统规定参数,取值为DescribeBackupTasks

DBClusterId String pc-***************

集群ID。

BackupJobId String 11111111

备份任务ID。

BackupMode String Manual

备份模式,取值范围如下:

  • Automated:系统自动备份
  • Manual:手动备份

返回数据

名称 类型 示例值 描述
Items Array

备份任务详情。

BackupJob
BackupJobId String 11111111

备份任务ID。

BackupProgressStatus String NoStart

备份程序状态,取值范围如下:

  • NoStart:未开始
  • Preparing:准备中
  • Waiting:等待中
  • Uploading:上传中
  • Checking:检查中
  • Finished:已完成
JobMode String Automated

备份模式,取值范围如下:

  • Automated:系统自动备份
  • Manual:手动备份
Process String 0

任务进度百分比。

StartTime String 2020-08-08T07:24:01Z

任务开始时间(UTC),格式为YYYY-MM-DDThh:mm:ssZ。

TaskAction String NormalBackupTask

任务类型,取值范围如下:

  • TempBackupTask:临时备份任务
  • NormalBackupTask:普通备份任务
RequestId String FA8C1EF1-E3D4-44D7-B809-823187******

请求ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeBackupTasks
&DBClusterId=pc-***************
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>FA8C1EF1-E3D4-44D7-B809-823187******</RequestId>
<Items>
    <BackupJob>
        <JobMode>Automated</JobMode>
        <TaskAction>NormalBackupTask</TaskAction>
        <StartTime>2020-08-08T07:24:01Z</StartTime>
        <BackupProgressStatus>NoStart</BackupProgressStatus>
        <Process>0</Process>
        <BackupJobId>11111111</BackupJobId>
    </BackupJob>
</Items>

JSON 格式

{
	"RequestId": "FA8C1EF1-E3D4-44D7-B809-823187******",
	"Items": {
		"BackupJob": [
			{
				"JobMode": "Automated",
				"TaskAction": "NormalBackupTask",
				"StartTime": "2020-08-08T07:24:01Z",
				"BackupProgressStatus": "NoStart",
				"Process": "0",
				"BackupJobId": 11111111
			}
		]
	}
}

错误码

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