You can call this operation to query the backup tasks of instances.

Debugging

You can use API Explorer to perform debugging. API Explorer allows you to perform various operations to simplify API usage. For example, you can retrieve APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required? Example Description
Action String Yes DescribeBackupTasks

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

DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance.

ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxx

The token used to ensure that requests are idempotent and prevent from submitting the same request multiple times. The value of this parameter is generated by the client and is unique among different requests. It has maximum length of 64 ASCII characters, and can contain only ASCII characters.

BackupJobId String No 4762614

The ID of the backup task.

BackupMode String No Automated

The backup mode. Valid values:

  • Automated.
  • Manual.
BackupJobStatus String No 0

The status of the backup task. Valid values:

  • 0: not started.
  • 1: in progress.

Default values: 0 and 1.

AccessKeyId String No LTAIfCxxxxxxxxxx

The AccessKey ID issued by Alibaba Cloud for users to access services.

Response parameters

Parameter Type Example Description
Items

The details of backup tasks.

└BackupId String 346650271

The ID of the backup set generated by a task.

Note When the response parameter BackupStatus is Finished, you can enter the request parameter BackupJobId to view the IDs of backup sets.
└BackupJobId String 4762614

The ID of the backup task.

└BackupProgressStatus String NoStart

The status of the backup program.

└BackupStatus String NoStart

The status of the backup task. Valid values:

  • NoStart.
  • Checking.
  • Preparing.
  • Waiting.
  • Uploading.
  • Finished.
  • Failed.
└JobMode String Automated

The backup mode. Valid values:

  • Automated.
  • Manual.
└Process String 25

The progress of the task.

└TaskAction String NormalBackupTask

The type of the task. Valid values:

  • TempBackupTask.
  • NormalBackupTask.
RequestId String 90496720-2319-42A8-87CD-FCE4DF95EBED

The ID of the request.

Examples

Sample requests


http(s)://rds.aliyuncs.com/? Action=DescribeBackupTasks
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Common request parameters>

Successful response examples

XML format

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

{
	"Items":{
		"BackupJob":[
			{
				"BackupProgressStatus":"NoStart",
				"JobMode":"Automated",
				"TaskAction":"NormalBackupTask",
				"BackupStatus":"NoStart",
				"BackupJobId":4762614
			}
		]
	},
	"RequestId":"90496720-2319-42A8-87CD-FCE4DF95EBED"
}

Error codes

View error codes