CreateAndStartBackupPlan - Database Backup - Alibaba Cloud Documentation Center

Creates, configures, and starts a backup schedule.

Operation description

Before you call this operation, make sure that you fully understand the billing methods and pricing of Database Backup (DBS).

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
dbs:CreateAndStartBackupPlan	create	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	No	The ID of the backup schedule.	dbstooi0*******
Region	string	No	The ID of the region in which you want to store the backup data. You can query the supported regions of DBS by calling the DescribeRegions operation.	cn-hangzhou
InstanceClass	string	Yes	The type of the backup schedule. Valid values: micro small medium large xlarge Note A backup schedule type with higher specifications offers higher backup and restoration performance. For more information, see Select a backup schedule type.	micro
DatabaseType	string	Yes	The type of the source database. Valid values: MySQL MSSQL Oracle MariaDB PostgreSQL DRDS MongoDB Redis	MySQL
BackupMethod	string	Yes	The method that is used to generate the backup file. Valid values: logical: logical backup physical: physical backup duplication: dump backup	logical
Period	string	No	Specifies whether to use yearly subscription or monthly subscription for the instance. Valid values: Year: yearly subscription Month: monthly subscription	Year
UsedTime	integer	No	The subscription duration. If Period is set to Year, the valid values of UsedTime range from 1 to 5. If Period is set to Month, the valid values of UsedTime range from 1 to 11.	1
PayType	string	No	The billing method. Valid values: postpay: pay-as-you-go. prepay: subscription. Note The default value is prepay. You can set this parameter to postpay only if you set BackupMethod to duplication.	Postpaid
DatabaseRegion	string	No	The region in which the database that you want to back up resides. Note This parameter is required if the PayType parameter is set to postpay.	cn-hangzhou
StorageRegion	string	No	The region in which you want to store the backup data. Note This parameter is required if the PayType parameter is set to postpay.	cn-hangzhou
InstanceType	string	No	The type of the source database instance. Valid values: RDS: ApsaraDB RDS. PolarDB: PolarDB. DDS: ApsaraDB for MongoDB. Kvstore: ApsaraDB for Redis. Other: Database connected by using an IP address and a port number. dg: Self-managed database that has no public IP address or port number and is connected over Database Gateway. Note If PayType is set to postpay, this parameter is required.	RDS
StorageType	string	No	This parameter is unavailable.	N/A
FromApp	string	No	The request source. Default value: OpenApi. You do not need to set this parameter.	OpenApi
SourceEndpointInstanceType	string	Yes	The location of the source database. Valid values: RDS: The database is on an ApsaraDB RDS instance. ECS: The database is on an Elastic Compute Service (ECS) instance. Express: The database is connected to DBS by using Express Connect, VPN Gateway, or Smart Access Gateway. Agent: The database is connected to DBS over a DBS backup gateway. DDS: The database is on an ApsaraDB for MongoDB instance. Other: The database is connected to DBS by using an IP address and a port number. dg: The database is a self-managed database that has no public IP address or port number and is connected to DBS over Database Gateway.	RDS
SourceEndpointRegion	string	No	The region in which the database that you want to back up resides. Note This parameter is required if the SourceEndpointInstanceType parameter is set to RDS, ECS, DDS, Express, or Agent.	cn-hangzhou
SourceEndpointInstanceID	string	No	The ID of the database instance. Note This parameter is required if the SourceEndpointInstanceType parameter is set to RDS, ECS, DDS, or Express.	rm-uf6wjk5xxxxxxxxxx
SourceEndpointIP	string	No	The endpoint of the database. Note This parameter is required if the SourceEndpointInstanceType parameter is set to Express, Agent, or Other.	rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com
SourceEndpointPort	integer	No	The port of the database. Note This parameter is required if the SourceEndpointInstanceType parameter is set to Express, Agent, Other, or ECS.	3306
SourceEndpointDatabaseName	string	No	The name of the database. Note This parameter is required if the DatabaseType parameter is set to PostgreSQL or MongoDB.	testRDS
SourceEndpointUserName	string	No	The username of the account that is used to connect to the database. Note This parameter is required except that the database is an SQL Server database that is connected to DBS over a DBS backup gateway or a Redis database.	testRDS
SourceEndpointPassword	string	No	The password of the account that is used to connect to the database. Note This parameter is required except that the database is an SQL Server database that is connected to DBS over a DBS backup gateway or a Redis database.	testPassword
BackupGatewayId	long	No	The backup gateway ID. Note If SourceEndpointInstanceType is set to Agent, this parameter is required.**** For more information about how to install a backup gateway, see Install a backup gateway. You can query a list of existing backup gateways by calling the DescribeBackupGatewayList operation.	23313123312
OSSBucketName	string	No	The name of the Object Storage Service (OSS) bucket used to store backup files. By default, the system automatically generates a name for the OSS bucket.	TestOssBucket
BackupObjects	string	No	The object to be backed up.	\[ { "DBName":"Name of the database to be backed up", "SchemaName":"Name of the schema to be backed up", "TableIncludes":\[{ "TableName":"Name of the table to be backed up" }], "TableExcludes":\[{ "TableName":"Name of the table that you do not want to back up" }] } ]
BackupPeriod	string	No	The day of the week on which you want to perform full backup. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Note You can specify multiple values. Separate multiple values with commas (,).	Monday
BackupStartTime	string	No	The start time of full backup tasks. Specify the value in the HH:mm format. The time must be in UTC.	14:22
EnableBackupLog	boolean	No	Specifies whether to enable the incremental log backup feature. Valid values: true: enables the incremental log backup feature. false: disables the incremental log backup feature.	true
BackupLogIntervalSeconds	integer	No	The interval at which you want to perform incremental log backups. Unit: seconds. Note This parameter is required only if you set BackupMethod to physical.	1000
BackupRetentionPeriod	integer	No	The number of days for which the backup data is retained. Valid values: 0 to 1825. Default value: 730.	730
DuplicationInfrequentAccessPeriod	integer	No	The number of days after which the storage class of the backup data is changed to Infrequent Access (IA). Default value: 180.	180
DuplicationArchivePeriod	integer	No	The number of days after which the storage class of the backup data is changed to Archive. Default value: 365.	365
BackupPlanName	string	Yes	The name of the backup schedule.	dbstooi0*******
SourceEndpointOracleSID	string	No	The system ID (SID) of the Oracle database. This parameter is required if the source database is an Oracle database.	test
BackupStorageType	string	No	The storage type. Valid values: Empty: If you do not specify this parameter, the system stores backup data in your OSS bucket. system : The system stores backup data in the built-in OSS bucket of DBS.	N/A
BackupSpeedLimit	long	No	The I/O limit for the disk. Unit: KB/s. Note This parameter takes effect only when physical backups for MySQL databases are performed.	262144
BackupRateLimit	long	No	The network bandwidth throttling. Unit: KB/s. DBS allows a maximum bandwidth of 10 GB/s. Note This parameter takes effect only when physical backups for MySQL databases are performed.	262144
BackupStrategyType	string	No	The backup method that you want to use for full backups. Valid values: simple: scheduled backup. If you specify this value for the BackupStrategyType parameter, you must also specify the BackupPeriod and BackupStartTime parameters. Manual: manual backup. Note Default value: simple.	simple
CrossAliyunId	string	No	The unique ID (UID) of the Alibaba Cloud account to which the source database belongs.	2xxx7778xxxxxxxxxx
CrossRoleName	string	No	The name of the RAM role that is used to perform backups across Alibaba Cloud accounts.	test123
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	DBS
ResourceGroupId	string	No	The ID of the resource group.	rg-aekzecovzti****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	4F1888AC-1138-4995-B9FE-D2734F61C058
CreateBackupSet	boolean	Indicates whether a backup is performed immediately after the backup schedule is configured. Valid values: true false	true
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request is successful.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
BackupPlanId	string	The backup schedule ID.	dbs1hvb0wwweusfa
OrderId	string	The ID of the order.	2056157***

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "CreateBackupSet": true,
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "BackupPlanId": "dbs1hvb0wwweusfa",
  "OrderId": "2056157***"
}

Error codes

HTTP status code	Error code	Error message
403	Request.Forbidden	Have no Permissions

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

Change history

Change time	Summary of changes	Operation

No change history