DescribeBackupTasks - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the backup tasks of an instance.

Operation description

Supported database engines

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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	get	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	Specifies 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 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 instance ID. You can call the DescribeDBInstances operation to query the instance ID.	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 Progressing By default, this operation returns backup tasks in both states.	NoStart

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	90496720-2319-42A8-87CD-FCE4DF95EBED
Items	array<object>	The backup tasks.
BackupJob	object
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 Note This 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. Note If the value of the BackupStatus parameter is Finished, you can view the backup set ID only if you configure the BackupJobId parameter.	346650271
TaskAction	string	The type of the 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

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

Error codes

HTTP status code	Error code	Error message	Description
400	InternalFailure	Internal failure, retry later.	The request failed. Please try again later.
400	InvalidParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter.
400	ReadDBInstanceNotSupport	The operation is not permitted due to type of the instance.	-
400	InvalidParameters.Format	Specified parameter is not valid	The operation failed. The values of some parameters are invalid.
404	InvalidDBInstanceName.NotFound	Invalid DBInstanceId NotFound.	The instance ID cannot be found.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	The RDS instance cannot be found, is deleted, or does not support the operation.

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