DescribeBackupTasks - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the DescribeBackupTasks operation to query the backup tasks of an instance.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rds:DescribeBackupTasks	READ	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCzxxxxxxx
Flag	string	No	A reserved parameter.	None
DBInstanceId	string	Yes	The ID of the instance.	rm-uf6wjk5xxxxxxx
BackupJobId	integer	No	The ID of the backup task.	4762614
BackupMode	string	No	The backup mode. Valid values: Automated Manual	Automated
BackupJobStatus	string	No	The status of the backup task. Valid values: NoStart: The backup task is not started. Progressing: The backup task is in progress. By default, this operation returns backup tasks in both states.	NoStart

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	90496720-2319-42A8-87CD-FCE4DF95EBED
Items	object []	An array that consists of the details of the backup task.
Process	string	The progress of the task in percentage.	25
BackupJobId	string	The ID of the backup task.	4762614
BackupStatus	string	The status of the backup task. Valid values: NoStart Checking Preparing Waiting Uploading Finished Failed NoteThis parameter is returned only after a backup task is run.	NoStart
JobMode	string	The backup mode. Valid values: Automated Manual	Automated
BackupProgressStatus	string	The status of the backup program. Valid values: NoStart Preparing Waiting Uploading Checking Finished	NoStart
BackupId	string	The ID of the backup set that is generated by the backup task. NoteIf the return value of the BackupStatus parameter is Finished, you must specify the BackupJobId parameter to obtain the ID of the generated backup set.	346650271
TaskAction	string	The type of the backup task. Valid values: TempBackupTask: The backup task is an adhoc backup task. NormalBackupTask: The backup task is a common backup task.	NormalBackupTask

Examples

Sample success responses

JSONformat

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

XMLformat

<?xml version="1.0" encoding="UTF-8" ?>
<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>

Error codes

HTTP status code	Error code	Error message	Description
400	InternalFailure	Internal failure, retry later.	The request failed. Please try again later.

For a list of error codes, visit the Service error codes.