ConfigureBackupPlan - Database Backup - Alibaba Cloud Documentation Center

Configures a backup schedule.

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:ConfigureBackupPlan	update	BackupPlan acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The ID of the backup schedule. You can call the DescribeBackupPlanList operation to obtain the ID of the backup schedule.	dbstooi0*******
SourceEndpointInstanceType	string	Yes	The location of the database. You can call the DescribeBackupPlanList operation to obtain the location. Valid values: RDS ECS 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 an ApsaraDB for MongoDB database. Other: The database is connected to DBS by using the IP address and port of the database.	RDS
SourceEndpointRegion	string	No	The region in which the database you want to back up resides. You can call the DescribeBackupPlanList operation to obtain the region. 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. You can call the DescribeBackupPlanList operation to obtain the ID of the database instance. Note This parameter is required if the SourceEndpointInstanceType parameter is set to RDS, ECS, DDS, or Express.	rm-uf6wjk5*********
SourceEndpointIP	string	No	The endpoint that is used to connect to the database. You can call the DescribeBackupPlanList operation to obtain the endpoint. Note This parameter is required if the SourceEndpointInstanceType parameter is set to Express, Agent, or Other.	rm-uf6wjk5*******.mysql.rds.aliyuncs.com
SourceEndpointPort	integer	No	The port that is used to connect to the database. You can call the DescribeBackupPlanList operation to obtain the port. 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. You can call the DescribeBackupPlanList operation to obtain the name of the database. Note This parameter is required if the database is a PostgreSQL or MongoDB database.	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 ID of the backup gateway. You can call the DescribeBackupPlanList operation to obtain the ID of the backup gateway. Note This parameter is required if the SourceEndpointInstanceType parameter is set to Agent.	23313123312
OSSBucketName	string	No	The name of the Object Storage Service (OSS) bucket that is used to store backup files. By default, the system automatically generates a name for the OSS bucket.	TestOssBucket
BackupObjects	string	No	The objects to be backed up. You can call the DescribeBackupPlanList operation to obtain the objects.	\[ { "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 to be excluded during the backup" }] } ]
BackupPeriod	string	No	The day of each week when the full backup task runs. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday	Monday
BackupStartTime	string	No	The start time of full backup tasks. Specify the value in the HH:mmZ format. The time must be in UTC. You can call the DescribeBackupPlanList operation to obtain the start time of full backup tasks.	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 takes effect only when physical backups are performed.	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. You can call the DescribeBackupPlanList operation to obtain the name of the backup schedule.	dbstooi0*******
SourceEndpointOracleSID	string	No	The system ID (SID) of the Oracle database. Note This parameter is required if the 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 backup schedule belongs. You can call the DescribeRestoreTaskList operation to obtain the UID of the Alibaba Cloud account.	2xxx7778xxxxxxxxxx
CrossRoleName	string	No	The name of the RAM role that is used to perform backups across Alibaba Cloud accounts. You can call the DescribeRestoreTaskList operation to obtain the RAM role.	test123
AutoStartBackup	boolean	No	Specifies whether to enable the automatic backup feature. true: enables the automatic backup feature. false: disables the automatic backup feature.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	ETnLKlblzczshOTUbOCzxxxxxxx
ResourceGroupId	string	No	ResourceGroupId.	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.	F1FB49D4-B504-47F1-9F43-D7EAB33F****
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
BackupPlanId	string	The ID of the backup schedule.	dbstooi01ex****

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "F1FB49D4-B504-47F1-9F43-D7EAB33F****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "BackupPlanId": "dbstooi01ex****"
}

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