Queries the information about backup tasks of an ApsaraDB for Redis instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeBackupTasks

The operation that you want to perform. Set the value to DescribeBackupTasks.

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the instance. You can call the DescribeInstances operation to query instance IDs.

RegionId String No cn-hangzhou

The ID of the region where the instance is deployed. You can call the DescribeRegions operation to query region IDs.

BackupJobId String No 1162****

The ID of the backup task.

Note If you have called the CreateBackup operation to perform a manual backup task, you can specify the returned backup task ID in this request to query the progress of the backup task.
JobMode String No Manual

The backup task. Valid values:

  • Automated: automatic backup. You can call the DescribeBackupPolicy operation to query the automatic backup policy.
  • Manual: manual backup.
Note The information about backup tasks in both modes is returned by default.

Response parameters

Parameter Type Example Description
BackupJobs Array of BackupJob

The details of the backup task.

BackupJobID Integer 8491111

The ID of the backup task.

BackupProgressStatus String Automated

The state of the backup task. Valid values:

  • NoStart:: The backup task has not been started.
  • Preparing: The backup task is being prepared.
  • Waiting: The backup task is waiting.
  • Uploading: The system is uploading the backup file.
  • Checking: The system is checking the uploaded backup file.
  • Finished: The backup task is completed.
JobMode String Manual

The backup mode. Valid values:

  • Automated: automatic backup.
  • Manual: manual backup.
Process String 0

The progress of the backup task in percentage.

StartTime String 2021-01-05T19:24:00Z

The start time of the backup task. The time follows the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

TaskAction String NormalBackupTask

The backup type. Valid values:

  • TempBackupTask: The backup task is manually performed.
  • NormalBackupTask:The backup task is automatically performed.
InstanceId String r-bp1zxszhcgatnx****

The ID of the instance.

RequestId String BB73740C-23E2-4392-9DA4-2660C74C****

The ID of the request.

Examples

Sample requests

http(s)://https://r-kvstore.aliyuncs.com/?Action=DescribeBackupTasks
&InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>

Sample success responses

XML format

<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 format

{
    "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
    }]
}

Error codes

For a list of error codes, visit the API Error Center.