DescribeDownloadBackupSetStorageInfo - Database Backup - Alibaba Cloud Documentation Center

Queries the storage information of a downloaded backup set.

Operation description

Supported database engines

ApsaraDB RDS for MySQL
ApsaraDB RDS for PostgreSQL
PolarDB for MySQL

References

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:DescribeDownloadBackupSetStorageInfo	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
Duration	string	Yes	The validity period of the URL that is used as the download destination. Take note of the following items: Default value: 7200. This means that the URL is valid for 2 hours by default. Valid values: 300 to 86400. Unit: seconds. This means that you can specify a validity period in the range of 5 minutes to 1 day. Before you specify this parameter, convert the validity period to seconds. For example, if you want to set the validity period of the URL to 5 minutes, enter 300.	300
InstanceName	string	No	The ID of the instance. Note The BackupSetId parameter is required if you specify the InstanceName parameter.	rm-uf6qqf569n435****
TaskId	string	No	The download task ID. The BackupSetId and InstanceName parameters are required if you do not specify the TaskId parameter. To view the download task ID, go to the instance details page in the console and click Backup and Restoration in the left-side navigation pane. On the Backup Download tab, view the task ID.	dt-s0ugzak9****
BackupSetId	string	No	The ID of the backup set.	30****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	44B8C2F5-919D-5D29-BCD5-DEB03467****
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
Data	object	The returned data.
PublicUrl	string	The public download URL of the backup set.	http://dbs-137383785969**-cn-hangzhou-1iv12nblw.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa**/dbs_target_file_path/test_456
PrivateUrl	string	The private download URL of the backup set.	http://dbs-137383785969**-cn-hangzhou-1iv12nblw.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa**/dbs_target_file_path/test_123
ExpirationTime	long	The validity period of the URL. Note This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1661329050

Examples

Sample success responses

JSONformat

{
  "RequestId": "44B8C2F5-919D-5D29-BCD5-DEB03467****",
  "ErrCode": "DBS.ParamIsInValid",
  "Success": "true",
  "ErrMessage": "Argument: regionCode Must not be empty",
  "Code": "DBS.ParamIsInValid",
  "Message": "Argument: regionCode Must not be empty",
  "Data": {
    "PublicUrl": "http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456",
    "PrivateUrl": "http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123",
    "ExpirationTime": 1661329050
  }
}

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