ConfigureBackupPlan-阿里云帮助中心

Configures a Database Backup (DBS) backup plan.

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

dbs:ConfigureBackupPlan

update

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

None

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The ID of the backup plan. You can call the DescribeBackupPlanList operation to query the value of this parameter.	dbstooi0*******
SourceEndpointInstanceType	string	Yes	The location of the database. You can call the DescribeBackupPlanList operation to query the value of this parameter. Valid values: RDS ECS Express: databases connected over Express Connect circuits, VPN gateways, or Smart Access Gateway (SAG) Agent: databases connected over backup gateways DDS: ApsaraDB for MongoDB Other: databases connected by using IP addresses and port numbers	RDS
SourceEndpointRegion	string	No	The region of the database. You can call the DescribeBackupPlanList operation to query the value of this parameter. Note This parameter is required when SourceEndpointInstanceType is set to RDS, ECS, DDS, Express, or Agent.	cn-hangzhou
SourceEndpointInstanceID	string	No	The database instance ID. You can call the DescribeBackupPlanList operation to query the value of this parameter. Note This parameter is required when SourceEndpoint.InstanceType is set to RDS, ECS, DDS, or Express.	rm-uf6wjk5*********
SourceEndpointIP	string	No	The database connection address. You can call the DescribeBackupPlanList operation to query the value of this parameter. Note This parameter is required when SourceEndpointInstanceType is set to express, agent, or other.	rm-uf6wjk5*******.mysql.rds.aliyuncs.com
SourceEndpointPort	integer	No	The port number of the database. You can call the DescribeBackupPlanList operation to query the value of this parameter. Note This parameter is required when SourceEndpoint.InstanceType is set to express, agent, other, or ECS.	3306
SourceEndpointDatabaseName	string	No	The name of the database. You can call the DescribeBackupPlanList operation to query the value of this parameter. Note This parameter is required when the database engine is PostgreSQL or MongoDB.	testRDS
SourceEndpointUserName	string	No	The username of the database account. Note This parameter is not required when the database engine is Redis, or when the database is connected over a backup gateway (agent) and the database engine is SQL Server. This parameter is required in other scenarios.	testRDS
SourceEndpointPassword	string	No	The password of the database account. Note This parameter is not required when the database engine is Redis, or when the database is connected over a backup gateway (agent) and the database engine is SQL Server. This parameter is required in other scenarios.	testPassword
BackupGatewayId	integer	No	The ID of the backup gateway. You can call the DescribeBackupPlanList operation to query the value of this parameter. Note This parameter is required when SourceEndpointInstanceType is set to agent.	23313123312
OSSBucketName	string	No	The name of the OSS bucket. Note By default, the system automatically generates a new name.	TestOssBucket
BackupObjects	string	No	The objects to be backed up. You can call the DescribeBackupPlanList operation to query the value of this parameter.	[ { "DBName":"DatabaseToBackUp", "SchemaName":"SchemaToBackUp", "TableIncludes":[{ "TableName":"TableToBackUp" }], "TableExcludes":[{ "TableName":"TableToExclude" }] } ]
BackupPeriod	string	No	The full backup cycle. Valid values: Monday: Monday Tuesday: Tuesday Wednesday: Wednesday Thursday: Thursday Friday: Friday Saturday: Saturday Sunday: Sunday	Monday
BackupStartTime	string	No	The start time of the full backup. The time is in the HH:mmZ format and displayed in UTC. You can call the DescribeBackupPlanList operation to query the value of this parameter.	14:22
EnableBackupLog	boolean	No	Specifies whether to enable incremental log backup. Valid values: true: enables incremental log backup false: disables incremental log backup	true
BackupLogIntervalSeconds	integer	No	The interval for incremental backup, in seconds. Note This parameter is supported only for physical backup.	1000
BackupRetentionPeriod	integer	No	The retention period of backup data. Valid values: 0 to 1825. Default value: 730. Unit: days.	730
DuplicationInfrequentAccessPeriod	integer	No	The period after which backup data is transitioned to Infrequent Access (IA) storage. Default value: 180. Unit: days.	180
DuplicationArchivePeriod	integer	No	The period after which backup data is transitioned to Archive storage. Default value: 365. Unit: days.	365
BackupPlanName	string	Yes	The custom name of the backup plan. You can call the DescribeBackupPlanList operation to query the value of this parameter.	dbstooi0*******
SourceEndpointOracleSID	string	No	The Oracle system identifier (SID). Note This parameter is required when the database engine is Oracle.	test
BackupStorageType	string	No	The built-in storage type. Valid values: Empty string (default): Backup data is stored in your OSS bucket. system: Backup data is stored in the built-in OSS bucket of DBS.	None
BackupSpeedLimit	integer	No	The disk I/O limit. Unit: KB/s. Note This parameter takes effect only for MySQL physical backup.	262144
BackupRateLimit	integer	No	The network bandwidth throttling. Unit: KB/s. Maximum value: 10 GB. Note This parameter takes effect only for MySQL physical backup.	262144
BackupStrategyType	string	No	The full backup epoch. Valid values: simple: periodic backup, which is used together with BackupPeriod and BackupStartTime manual: manual backup Note Default value: simple.	simple
CrossAliyunId	string	No	The UID of the Alibaba Cloud account for cross-account backup. You can call the DescribeRestoreTaskList operation to query the value of this parameter.	2xxx7778xxxxxxxxxx
CrossRoleName	string	No	The name of the RAM role for cross-account backup. You can call the DescribeRestoreTaskList operation to query the value of this parameter.	test123
AutoStartBackup	boolean	No	Specifies whether to enable automatic backup. Valid values: true: enables automatic backup false: disables automatic backup	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to generate the value, and you must ensure that the value is unique among different requests. The value can be up to 64 ASCII characters in length and cannot contain non-ASCII characters.	ETnLKlblzczshOTUbOCzxxxxxxx
ResourceGroupId	string	No	The ID of the resource group.	rg-aekzecovzti****
EnableSourceEndpointSsl	string	No	Specifies whether to enable an SSL-encrypted connection to the source database instance.	true
BackupStorageEncryptMethod	string	No	The encryption method for backup storage.	encrypted
SslCaPem	string	No	The PEM certificate for the SSL-encrypted connection to the source database.	-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----
SourceEndpointOracleHome	string	No	Oracle Home	/home/test
EnableMysqlPhysicalBackupBinlog	string	No	Specifies whether to enable log backup for MySQL physical backup.	true

Response elements

Element	Type	Description	Example
	object	The details.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	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 plan.	dbstooi01ex****

Examples

Success response

JSON format

{
  "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	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.