You can call the UpdateUserBackupFile operation to modify the description and retention period of a full backup file.

Note 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 full backup data of a self-managed MySQL 5.7 database to an ApsaraDB RDS for MySQL instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateUserBackupFile

The operation that you want to perform. Set the value to UpdateUserBackupFile.

BackupId String Yes b-kwwvr7v8t7of********

The ID of the full backup file. You can call the ListUserBackupFiles operation to query the information about all full backup files in a region.

RegionId String Yes cn-hangzhou

The region ID of the full backup file. You can call the DescribeRegions operation to query the most recent region list.

Comment String No CommentTest

The new description of the full backup file.

Retention Integer No 30

The new retention period of the full backup file. Unit: days. Valid values: any non-zero positive integer.

Response parameters

Parameter Type Example Description
BackupId String b-g14d0m772f7b********

The ID of the full backup file.

RequestId String 6A236067-4727-4B42-92CF-734E417ED69A

The ID of the request.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=UpdateUserBackupFile
&BackupId=b-g14d0m772f7b********
&RegionId=cn-hangzhou
&Comment=CommentTest
&Retention=30
&<Common request parameters>

Sample success responses

XML format 

<UpdateUserBackupFileResponse>
      <RequestId>6A236067-4727-4B42-92CF-734E417ED69A</RequestId>
      <BackupId>b-g14d0m772f7b********</BackupId>
</UpdateUserBackupFileResponse>

JSON format 

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

Error codes

HTTP status code Error code Error message Description
400 InvalidParam The specified parameter is invalid. The error message returned because the value that you specify for a parameter is invalid.
400 OperationDenied.Product The product code is not supported. The error message returned because the product code is not supported.

For a list of error codes, visit the API Error Center.