Call the UpdateUserBackupFile API to modify the description and retention period of a full backup file - ApsaraDB RDS - Alibaba Cloud - ApsaraDB RDS

Operation description

Supported database engines

RDS MySQL

References

A full backup file contains the data of a self-managed MySQL database. You can restore the data of a self-managed MySQL database from a full backup file to an ApsaraDB RDS for MySQL instance. For more information, see Migrate the data of a self-managed MySQL 5.7 or MySQL 8.0 instance to an ApsaraDB RDS for MySQL instance.

Note : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:UpdateUserBackupFile	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
BackupId	string	Yes	The backup ID. You can call the ListUserBackupFiles operation to query the backup ID.	b-kwwvr7v8t7of********
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Comment	string	No	The new description of the full backup file.	CommentTest
Retention	integer	No	The new retention period of the full backup file. Unit: days. Valid values: any non-zero positive integer.	30
ResourceGroupId	string	No	The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.	rg-acfmy*****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
BackupId	string	The ID of the backup file.	b-g14d0m772f7b********
RequestId	string	The request ID.	6A236067-4727-4B42-92CF-734E417ED69A

Examples

Sample success responses

JSONformat

{
  "BackupId": "b-g14d0m772f7b********",
  "RequestId": "6A236067-4727-4B42-92CF-734E417ED69A"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam	The specified parameter is invalid.	-
400	OperationDenied.Product	The product code is not supported.	The product code is not supported.

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

Change history

Change time	Summary of changes	Operation
2023-07-25	The Error code has changed. The request parameters of the API has changed	View Change Details
2022-06-23	API Description Update. The Error code has changed	View Change Details