DescribeDownloadSupport - Database Backup - Alibaba Cloud Documentation Center

Queries whether an instance supports the advanced download feature.

Operation description

Supported database engines

ApsaraDB RDS for MySQL
ApsaraDB RDS for PostgreSQL
PolarDB for MySQL

References

You can create an advanced download task by point in time or backup set. You can set the download destination to a URL or directly upload the downloaded backup set to your Object Storage Service (OSS) bucket to facilitate data analysis and offline archiving.

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
dbs:DescribeDownloadSupport	get	*BackupPlan `acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionCode	string	Yes	The ID of the region in which the instance resides. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.	cn-hangzhou
InstanceName	string	Yes	The ID of the instance.	rm-bp1a48p922r4b****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Data	string	Indicates whether the advanced download feature is supported. Valid values: true: The advanced download feature is supported. false: The advanced download feature is not supported.	true
RequestId	string	The ID of the request.	F1A186F7-7B34-5C11-A903-EE23876B****
ErrCode	string	The error code returned if the request failed.	DBS.ParamIsInValid
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrMessage	string	The error message returned if the request failed.	Argument: regionCode Must not be empty
Code	string	The error code returned if the request failed.	DBS.ParamIsInValid
Message	string	The error message returned if the request failed.	Argument: regionCode Must not be empty

Examples

Sample success responses

JSONformat

{
  "Data": "true",
  "RequestId": "F1A186F7-7B34-5C11-A903-EE23876B****",
  "ErrCode": "DBS.ParamIsInValid",
  "Success": "true",
  "ErrMessage": "Argument: regionCode Must not be empty",
  "Code": "DBS.ParamIsInValid",
  "Message": "Argument: regionCode Must not be empty"
}

Error codes

HTTP status code	Error code	Error message
403	Request.Forbidden	Have no Permissions

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

Change history

Change time	Summary of changes	Operation

No change history