CreateBackupPlan - Data Management - Alibaba Cloud Documentation Center

This operation creates a Database Backup (DBS) backup plan.

Operation description

For the corresponding operation in the console, see Purchase a 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:CreateBackupPlan

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	No	The ID of the region where the DBS instance resides. This parameter is required. To view the regions supported by DBS, call the DescribeRegions operation. Note For more information, see Endpoints.	cn-hangzhou
InstanceClass	string	Yes	The instance class. Valid values: micro: Micro small: Small medium: Medium large: Large xlarge: X-Large (no traffic limit) Note A larger instance class provides better performance for backup and recovery. For more information, see Instance classes.	micro
DatabaseType	string	Yes	The database type. Valid values: MySQL MSSQL Oracle MariaDB PostgreSQL DRDS MongoDB Redis	MySQL
BackupMethod	string	Yes	The backup method. Valid values: logical: logical backup physical: physical backup	logical
Period	string	No	The billing cycle of the subscription instance. Valid values: Year: The instance is billed annually. Month: The instance is billed monthly.	Month
UsedTime	integer	No	The subscription duration. Valid values: If you set the Period parameter to Year, the value of UsedTime can be 1, 2, 3, 4, or 5. If you set the Period parameter to Month, the value of UsedTime can be 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, or 11.	1
PayType	string	No	The payment method. Valid values: prepay: subscription	prepay
DatabaseRegion	string	No	The region where the source database resides.	cn-hangzhou
StorageRegion	string	No	The storage region.	cn-hangzhou
InstanceType	string	No	The type of the database instance. Valid values: RDS PolarDB DDS: Alibaba Cloud MongoDB Kvstore: Alibaba Cloud Redis Other: A database connected using an IP address and port number. dg: A self-managed database without a public IP address and port number. This type of database is connected through Database Gateway (DG).	RDS
StorageType	string	No	This parameter is not yet available.	无
FromApp	string	No	The source of the request. The default value is OpenAPI. You do not need to set this parameter.	OpenAPI
ClientToken	string	No	A client token that is used to ensure the idempotence of the request. Enter a unique string.	KJSAHKJFHKJSHFKASHFKJADFHKDXXXX
ResourceGroupId	string	No	The resource group ID.	rg-aekzecovzti****

Response elements

Element	Type	Description	Example
	object	The details of the return value.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	7BCF6D62-885F-5A4A-91A1-679760E7****
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.	dbsrhahrsu2****
OrderId	string	The order ID.	21437345592****

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "7BCF6D62-885F-5A4A-91A1-679760E7****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "BackupPlanId": "dbsrhahrsu2****",
  "OrderId": "21437345592****"
}

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.