Creates a backup file for an instance.
- SQL Server
This operation uses the backup feature of ApsaraDB RDS to create a backup set. You can also use an operation of Database Backup (DBS) to create a backup set. For more information, see List of operations by function of DBS.
Before you call this operation, make sure that the following requirements are met:
- The instance is in the Running state.
- The instance does not have ongoing backup tasks.
- The number of backup files that are created per day for an instance cannot exceed 20.
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 Resourcesis 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.
The instance ID. You can call the DescribeDBInstances operation to query the instance ID.
The names of the databases whose data you want to back up. Separate the names of the databases with commas (,).
Note You can specify this parameter when you perform a logical backup on individual databases of an ApsaraDB RDS for MySQL instance. You can also specify this parameter when you perform a full physical backup on individual databases of an ApsaraDB RDS for SQL Server instance.
The backup policy. Valid values:
Note You can specify this parameter when you perform a logical backup on an ApsaraDB RDS for MySQL instance. You can also specify this parameter when you perform a full physical backup on an ApsaraDB RDS for SQL Server instance.
The backup type of the instance. Valid values:
Default value: Physical.
The backup method. Valid values:
Default value: Auto.
The resource group ID. You can call the DescribeDBInstanceAttribute to query the resource group ID.
Sample success responses
|HTTP status code
|the specified backup type not support
|This operation is not supported for the specified backup type.
|The specified parameter "BackupMethod" is not valid.
|The backup method is invalid. Specify a valid backup method. Valid values: Logical and Physical. Default value: Physical. Logical backups are not supported for RDS instances in which no databases are created, and physical backups are supported only for RDS instances that run SQL Server.
|The operation is not permitted due to type of the instance.
|The Current DB instance lock mode does not support this operation.
|The operation failed. The RDS instance is locked.
|A backup job already exists in the specified DB instance.
|The backup has been created.
|Specified preferred backup time is not valid.
|The time of the backup file is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. Example: 2012-06-11T15:00Z.
|Specified DB name is not valid.
|The database name is invalid. Specify a valid name. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.
|operation not permitted.
|The operation is not allowed.
|Current DB Instance engine does not support this operation.
|The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
|Current DB instance engine and type does not support operations.
|The operation failed. The operation is not supported for the database engine of the RDS instance.
|Current DB instance state does not support this operation.
|Current DB Instance character_type does not support this operation.
|This operation is not supported for the character type of the current instance.
|The backup times exceeds.
|The specified BackupTimes parameter is invalid.
|The database instance does not exist.
|The name of the RDS instance cannot be found. Check the name of the RDS instance.
|Specified db does not exist or DB status does not support this operation.
|The operation failed. The database cannot be found or is not in a ready state. You can call the DescribeDatabases operation to view the databases of an RDS instance.
For a list of error codes, visit the Service error codes.
|Summary of changes
|The Error code has changed