ConfigureBackupPlan-阿里云帮助中心

This API is used to configure a 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 backup plan ID. Call the DescribeBackupPlanList API to get this parameter's value.	dbstooi0*******
SourceEndpointInstanceType	string	Yes	The location of the database. Call the DescribeBackupPlanList API to get this parameter's value. Valid values: RDS ECS Express: A database connected through a leased line, VPN Gateway, or Smart Gateway. Agent: A database connected through a backup gateway. DDS: Cloud MongoDB. Other: A database directly connected through IP:Port.	RDS
SourceEndpointRegion	string	No	The region of the database. Call the DescribeBackupPlanList API to get this parameter's value. Note This parameter is required when SourceEndpointInstanceType is RDS, ECS, DDS, Express, or Agent.	cn-hangzhou
SourceEndpointInstanceID	string	No	The database instance ID. Call the DescribeBackupPlanList API to get this parameter's value. Note This parameter is required when SourceEndpoint.InstanceType is RDS, ECS, DDS, or Express.	rm-uf6wjk5*********
SourceEndpointIP	string	No	The database endpoint. Call the DescribeBackupPlanList API to get this parameter's value. Note This parameter is required when SourceEndpointInstanceType is express, agent, or other.	rm-uf6wjk5*******.mysql.rds.aliyuncs.com
SourceEndpointPort	integer	No	The database port. Call the DescribeBackupPlanList API to get this parameter's value. Note This parameter is required when SourceEndpoint.InstanceType is express, agent, other, or ECS.	3306
SourceEndpointDatabaseName	string	No	The database name. Call the DescribeBackupPlanList API to get this parameter's value. Note This parameter is required when the database type is PostgreSQL or MongoDB.	testRDS
SourceEndpointUserName	string	No	The database account. Note This parameter is optional when the database type is Redis, or when the database location is agent and the database type is SQL Server. It is required in other scenarios.	testRDS
SourceEndpointPassword	string	No	The password. Note This parameter is optional when the database type is Redis, or when the database location is agent and the database type is SQL Server. It is required in other scenarios.	testPassword
BackupGatewayId	integer	No	The backup gateway ID. Call the DescribeBackupPlanList API to get this parameter's value. Note This parameter is required when SourceEndpointInstanceType is agent.	23313123312
OSSBucketName	string	No	The OSS bucket name. Note The system automatically generates a new name by default.	TestOssBucket
BackupObjects	string	No	The backup objects. Call the DescribeBackupPlanList API to get this parameter's value.	[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]
BackupPeriod	string	No	The full backup period. Valid values: Monday: Monday Tuesday: Tuesday Wednesday: Wednesday Thursday: Thursday Friday: Friday Saturday: Saturday Sunday: Sunday	Monday
BackupStartTime	string	No	The full backup start time in HH:mmZ (UTC) format. Call the DescribeBackupPlanList API to get this parameter's value.	14:22
EnableBackupLog	boolean	No	Enable incremental log backup. Valid values: true: Enable false: Disable	true
BackupLogIntervalSeconds	integer	No	The incremental interval in seconds (s). Note Only physical backup is supported.	1000
BackupRetentionPeriod	integer	No	The retention period for backup data. Valid values: 0 to 1825. Default value: 730 days.	730
DuplicationInfrequentAccessPeriod	integer	No	The period after which data is converted to Infrequent Access storage. Default value: 180 days.	180
DuplicationArchivePeriod	integer	No	The period after which data is converted to archive cold storage. Default value: 365 days.	365
BackupPlanName	string	Yes	The custom backup plan name. Call the DescribeBackupPlanList API to get this parameter's value.	dbstooi0*******
SourceEndpointOracleSID	string	No	The Oracle SID name. Note This parameter is required when the database type is Oracle.	test
BackupStorageType	string	No	The built-in storage type: Empty (default): Backup data is stored on your OSS. system: Backup data is stored on the built-in OSS of DBS.	无
BackupSpeedLimit	integer	No	The disk I/O limit in KB/s. Note This parameter is valid only for MySQL physical backup.	262144
BackupRateLimit	integer	No	The network bandwidth throttling in KB/s. The maximum value is 10 GB. Note This parameter is valid only for MySQL physical backup.	262144
BackupStrategyType	string	No	The full backup period. Valid values: simple: Periodic backup. Use this value with BackupPeriod and BackupStartTime. manual: Manual backup. Note Default value: simple.	simple
CrossAliyunId	string	No	The UID for cross-Alibaba Cloud account backup. Call the DescribeRestoreTaskList API to get this parameter's value.	2xxx7778xxxxxxxxxx
CrossRoleName	string	No	The RAM role name for cross-Alibaba Cloud account backup. Call the DescribeRestoreTaskList API to get this parameter's value.	test123
AutoStartBackup	boolean	No	Enable automatic backup. Valid values: true: Enable false: Disable	false
ClientToken	string	No	Ensure the idempotence of the request to prevent duplicate submissions. The client generates this parameter value. Ensure its uniqueness across different requests. The maximum length is 64 ASCII characters, and the value cannot contain non-ASCII characters.	ETnLKlblzczshOTUbOCzxxxxxxx
ResourceGroupId	string	No	The resource group ID.	rg-aekzecovzti****

Response elements

Element	Type	Description	Example
	object	Details are as follows.
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 was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
BackupPlanId	string	The backup plan ID.	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.