All Products
Search
Document Center

ApsaraDB RDS:DeleteBackupFile

Last Updated:May 29, 2023

Deletes backup files of an ApsaraDB RDS for SQL Server instance.

Operation Description

This operation is available for users whose accounts are added to the whitelist of an ApsaraDB RDS for SQL Server instance. If your account is not added to the whitelist of the instance, you can join the Database Backup (DBS) DingTalk group whose ID is 35585947 and contact the on-duty engineer to add your account to the whitelist.

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DeleteBackupFileWRITE
  • RDS
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

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

cn-hangzhou
DBInstanceIdstringYes

The ID of the instance.

rm-bp6wjk5******
BackupIdstringNo

The ID of the backup set. You can specify the IDs of up to 100 backup sets at a time. Separate the IDs with commas (,).

Note
  • Only the IDs of the backup sets for the database is supported.

  • You can call the DescribeBackups operation to query the IDs of backup sets.

29304****
DBNamestringNo

The name of the database.

testdb
BackupTimestringNo

Specifies whether to delete the backup sets that are generated before the specified point in time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2011-06-11T16:00:00Z

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

C7B3A91C-0ACD-4948-ACAE-xxxxxxxD4069
DeletedBaksetIdsarray

An array that consists of the IDs of deleted backup sets.

integer

The ID of the backup set.

29304****

Examples

Sample success responses

JSONformat

{
  "RequestId": "C7B3A91C-0ACD-4948-ACAE-xxxxxxxD4069",
  "DeletedBaksetIds": {
    "DeletedBaksetIds": [
      0
    ]
  }
}

Error codes

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