调用DescribeBackupTasks查询Redis实例的备份任务执行情况。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeBackupTasks |
系统规定参数,取值:DescribeBackupTasks。 |
InstanceId | String | 是 | r-bp1zxszhcgatnx**** |
实例ID,可调用DescribeInstances接口获取。 |
RegionId | String | 否 | cn-hangzhou |
实例所属的地域ID,可调用DescribeRegions接口获取。 |
BackupJobId | String | 否 | 1162**** |
备份任务ID。 说明 如果您调用CreateBackup执行了手动备份,您可以将返回的备份ID传入,用以查询备份的进度。
|
JobMode | String | 否 | Manual |
备份模式,取值:
说明 默认返回所有备份模式的任务信息。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
BackupJobs | Array of BackupJob |
备份任务详情。 |
|
BackupJobID | Integer | 8491111 |
备份任务ID。 |
BackupProgressStatus | String | Automated |
备份任务状态,返回值:
|
JobMode | String | Manual |
备份模式,返回值:
|
Process | String | 0 |
备份任务进度百分比。 |
StartTime | String | 2021-01-05T19:24:00Z |
备份任务开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
TaskAction | String | NormalBackupTask |
备份任务类型,返回值:
|
InstanceId | String | r-bp1zxszhcgatnx**** |
实例ID。 |
RequestId | String | BB73740C-23E2-4392-9DA4-2660C74C**** |
请求ID。 |
示例
请求示例
http(s)://https://r-kvstore.aliyuncs.com/?Action=DescribeBackupTasks
&InstanceId=r-bp1zxszhcgatnx****
&<公共请求参数>
正常返回示例
XML
格式
<DescribeBackupTasksResponse>
<RequestId>BB73740C-23E2-4392-9DA4-2660C74C****</RequestId>
<InstanceId>r-bp1zxszhcgatnx****</InstanceId>
<BackupJobs>
<JobMode>Automated</JobMode>
<TaskAction>NormalBackupTask</TaskAction>
<StartTime>2021-01-05T19:24:00Z</StartTime>
<BackupProgressStatus>NoStart</BackupProgressStatus>
<Process>0</Process>
<BackupJobID>8491111</BackupJobID>
</BackupJobs>
</DescribeBackupTasksResponse>
JSON
格式
{
"RequestId": "BB73740C-23E2-4392-9DA4-2660C74C****",
"InstanceId": "r-bp1zxszhcgatnx****",
"BackupJobs": [{
"JobMode": "Automated",
"TaskAction": "NormalBackupTask",
"StartTime": "2021-01-05T19:24:00Z",
"BackupProgressStatus": "NoStart",
"Process": "0",
"BackupJobID": 8491111
}]
}
错误码
访问错误中心查看更多错误码。