All Products
Search

This Product

    ApsaraDB RDS:DeleteUserBackupFile

    Document Center

    ApsaraDB RDS:DeleteUserBackupFile

    Last Updated:Aug 28, 2026

    Deletes the backup files of an ApsaraDB RDS for MySQL instance.

    Operation description

    Supported database engine

    • MySQL

    Usage notes

    • A full backup file contains the data of a self-managed MySQL instance. You can restore the data of a self-managed MySQL instance 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 instance to the cloud.
    • This operation deletes full backup files only from the ApsaraDB RDS console. This operation does not affect the full backup files that are stored as objects in Object Storage Service (OSS) buckets. After you call this operation to delete a full backup file, you can call the ImportUserBackupFile operation to reimport the full backup file.

    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.

    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:DeleteUserBackupFile delete
    *All Resources
    *
      none
    		 none

    Request parameters

    Parameter Type Required Description Example
    BackupId string Yes

    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.

    		 b-w1haya7e4i25********
    RegionId string Yes

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

    		 cn-hangzhou
    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 deleted full backup file.

    		 b-w1haya7e4i25********
    RequestId string

    The ID of the request.

    		 F28AE40B-203B-4CFE-B81F-FD981CD97B17

    Examples

    Sample success responses

    JSONformat

    {
  "BackupId": "b-w1haya7e4i25********",
  "RequestId": "F28AE40B-203B-4CFE-B81F-FD981CD97B17"
}

    Error codes

    HTTP status code Error code Error message Description
    403 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