All Products
Search
Document Center

ApsaraDB RDS:DescribeBackupDatabase

Last Updated:May 29, 2023

Queries the databases that are involved in a backup file.

Operation Description

NoteThis operation is phased out.

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DescribeBackupDatabaseREAD
  • RDS
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance.

rm-uf6wjk5xxxxxxx
BackupIdstringNo

The ID of the backup set.

90262212

Response parameters

ParameterTypeDescriptionExample
object
DatabaseNamesstring

The name of the database. Format: "db1,db2".

db1,db2
RequestIdstring

The ID of the request.

08A3B71B-FE08-4B03-974F-CC7EA6DB1828

Examples

Sample success responses

JSONformat

{
    "DatabaseNames": "db1,db2", 
    "RequestId": "08A3B71B-FE08-4B03-974F-CC7EA6DB1828"
}

XMLformat

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeBackupDatabaseResponse>
	<DatabaseNames>db1,db2</DatabaseNames>
	<RequestId>08A3B71B-FE08-4B03-974F-CC7EA6DB1828</RequestId></DescribeBackupDatabaseResponse>
	

Error codes

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