Use the CreateBackup API to create a backup file for an instance - ApsaraDB RDS - Alibaba Cloud - ApsaraDB RDS

Create a backup set for an RDS instance.

Operation description

Supported engines

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

Description

This API calls the native RDS backup API. You can also use DBS. For more information, see DBS API Overview.

Usage notes

The API call succeeds only if the instance meets the following conditions:

The instance is running.
No backup tasks are in progress.
A maximum of 20 backup sets can be created per instance per day.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rds:CreateBackup

create

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to obtain the instance ID.	rm-uf6wjk5****
DBName	string	No	The names of the databases that you want to back up. Separate multiple database names with commas (,). Note This parameter applies only when the BackupStrategy parameter is set to db.	rds_mysql
BackupStrategy	string	No	The backup strategy. Valid values: db: database backup instance: instance backup Note This parameter applies only in the following cases: For a MySQL instance, this parameter applies when the BackupMethod parameter is set to Logical. For a SQL Server instance, this parameter applies when the BackupType parameter is set to FullBackup.	db
BackupMethod	string	No	The backup method. Valid values: Logical: logical backup. This method is applicable only to MySQL instances that use local disks. Physical: physical backup. This method is applicable to MySQL instances that use local disks, and to SQL Server and PostgreSQL instances. Snapshot: snapshot backup. This method is applicable to MySQL instances that use cloud disks, and to SQL Server, PostgreSQL, and MariaDB instances. Default value: Physical. Note For logical backups, the database cannot be empty. MariaDB instances support only snapshot backups. However, you must set this parameter to Physical.	Physical
BackupType	string	No	The backup type for a SQL Server instance. Valid values: Auto (default): The system automatically selects between a full backup and an incremental backup. FullBackup: full backup Note This parameter takes effect only when BackupMethod is set to Physical.	Auto
BackupRetentionPeriod	integer	No	For SQL Server instances, you can specify the retention period for a backup set if BackupStrategy is set to db, BackupMethod is set to Physical, and BackupType is set to FullBackup. The value must be an integer from 7 to 730. A value of -1 specifies long-term retention. MySQL: The retention period for backup sets can be 7 to 730 days, or -1 for long-term retention.	7

Optional parameters

This API has four optional parameters: BackupMethod, BackupStrategy, BackupType, and DBName. Use specific parameter combinations depending on the database engine and your backup scenario.

MySQL

For a physical backup or snapshot backup, specify only the BackupMethod parameter. By default, all databases are backed up. Single-database backups are not supported.
For a logical backup:
- For a single-database backup, specify the BackupMethod, BackupStrategy, and DBName parameters.
- To back up an entire instance, specify the BackupMethod and BackupStrategy parameters.

SQL Server

For a snapshot backup, specify only the BackupMethod parameter. By default, all databases are backed up. Single-database backups are not supported.
For a physical backup:
- For a single-database full backup, specify all four optional parameters.
- For an entire instance full backup, specify the BackupMethod, BackupType, and BackupStrategy parameters.
- For a system-determined incremental or full backup, specify the BackupMethod and BackupType parameters.
Logical backups are not supported.

PostgreSQL

For a physical backup or snapshot backup, specify only the BackupMethod parameter. By default, all databases are backed up. Single-database backups are not supported.
Logical backups are not supported.

MariaDB

For a snapshot backup, specify only the BackupMethod parameter. By default, all databases are backed up. Single-database backups are not supported.
Physical and logical backups are not supported.

Response elements

Element	Type	Description	Example
	object	Contains the response parameters.
BackupJobId	string	The backup job ID.	507****
RequestId	string	The request ID.	2C125605-266F-41CA-8AC5-3A643D4F42C5

Examples

Success response

JSON format

{
  "BackupJobId": "507****",
  "RequestId": "2C125605-266F-41CA-8AC5-3A643D4F42C5"
}

Error codes

HTTP status code	Error code	Error message	Description
400	BackupType.NotSupport	the specified backup type not support	This operation is not supported for the specified backup type.
400	InvalidBackupMethod.ValueNotSupport	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.
400	ReadDBInstanceNotSupport	The operation is not permitted due to type of the instance.
400	IncorrectDBInstanceLockMode.ValueNotSupported	The Current DB instance lock mode does not support this operation.	The operation failed. The RDS instance is locked.
400	BackupJobExists	A backup job already exists in the specified DB instance.	The backup has been created.
400	InvalidPreferredBackupTime.Format	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.
400	InvalidDBName.Format	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.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Hello customer, this area has been abolished.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	No payment method has been specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400	KmsApiError	User secret key invalid.	The user key is invalid.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL command execution failed or timed out
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	This operation is not supported by the instance type.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	The link address name is duplicate. Please reset the connection string.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
400	Pay.NoCreditCard	No credit cards.	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	The instance has been released, please verify and place an order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	The request failed to be processed due to an RDS API failure.
403	OperationDenied.ApiForbidden	operation not permitted.	The operation is not allowed.
403	IncorrectDBInstanceEngine	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.
403	IncorrectDBInstanceType	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.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	IncorrectDBInstanceCharacterType	Current DB Instance character_type does not support this operation.	This operation is not supported for the character type of the current instance.
403	Exceeded.BackupTimes	The backup times exceeds.	The specified BackupTimes parameter is invalid.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	The scale-in target capacity cannot be less than the current storage space usage
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	This operation is not supported for the current minor engine version.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The specified database instance type does not support this operation.
404	InvalidDBInstanceName.NotFound	The database instance does not exist.	The name of the RDS instance cannot be found. Check the name of the RDS instance.
404	InvalidDB.NotFound	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.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The instance does not have permissions to access Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	The requested resources are unavailable.
404	HostInfo.NotFound	The specified host info is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

ApsaraDB RDS:CreateBackup