All Products
Search

This Product

    Data Management:CreateAndStartBackupPlan

    Document Center

    Data Management:CreateAndStartBackupPlan

    Last Updated:Dec 01, 2025

    Creates, configures, and starts a backup plan.

    Operation description

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

    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:CreateAndStartBackupPlan

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    BackupPlanId

    string

    No

    The ID of the backup plan.

    dbstooi0*******
    Region

    string

    No

    The region where DBS is supported. For more information, see DescribeRegions.

    cn-hangzhou
    InstanceClass

    string

    Yes

    The specification of the backup plan. Valid values:

    • micro

    • small

    • medium

    • large

    • xlarge

    Note

    The higher the specification, the better the performance of backup and recovery. For more information, see Specifications.

    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 for the subscription instance. Valid values:

    • Year: The instance is billed annually.

    • Month: The instance is billed monthly.

    Year
    UsedTime

    integer

    No

    The subscription duration. Valid values:

    • If you set Period to Year, the value of UsedTime can be 1 to 5.

    • If you set Period to Month, the value of UsedTime can be 1 to 11.

    1
    PayType

    string

    No

    The payment method. Valid value:

    prepay: subscription

    postpay
    DatabaseRegion

    string

    No

    The region where the database is located.

    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 through an IP address and port.

    • dg: A self-managed database that does not have a public IP address and port. This 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
    SourceEndpointInstanceType

    string

    Yes

    The location of the database. Valid values:

    • RDS

    • ECS

    • Express: A database connected through a leased line, VPN Gateway, or Smart Access Gateway.

    • Agent: A database connected through a backup gateway.

    • DDS: Alibaba Cloud MongoDB

    • Other: A database connected directly through an IP address and port.

    • dg: A self-managed database that does not have a public IP address and port. This database is connected through Database Gateway (DG).

    RDS
    SourceEndpointRegion

    string

    No

    The region where the database is located.

    Note

    This parameter is required if SourceEndpoint.InstanceType 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 SourceEndpoint.InstanceType is set to RDS, ECS, DDS, or Express.

    rm-uf6wjk5xxxxxxxxxx
    SourceEndpointIP

    string

    No

    The database endpoint.

    Note

    This parameter is required if SourceEndpoint.InstanceType is set to express, agent, or other.

    rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com
    SourceEndpointPort

    integer

    No

    The database port.

    Note

    This parameter is required if SourceEndpoint.InstanceType is set to express, agent, other, or ECS.

    3306
    SourceEndpointDatabaseName

    string

    No

    The database name.

    Note

    This parameter is required if the database type is PostgreSQL or MongoDB.

    testRDS
    SourceEndpointUserName

    string

    No

    The database account.

    Note

    This parameter is not required if the database type is Redis, or if the database location is agent and the database type is MSSQL. In other scenarios, this parameter is required.

    testRDS
    SourceEndpointPassword

    string

    No

    The password.

    Note

    This parameter is not required if the database type is Redis, or if the database location is agent and the database type is MSSQL. In other scenarios, this parameter is required.

    testPassword
    BackupGatewayId

    integer

    No

    The ID of the backup gateway.

    Note

    • This parameter is required if SourceEndpoint.InstanceType is set to agent.

    • For information about how to create a backup gateway, see Add a backup gateway.

    • To view the list of existing backup gateways, call the DescribeBackupGatewayList operation.

    23313123312
    OSSBucketName

    string

    No

    The name of the Object Storage Service (OSS) bucket. Default: The system automatically generates a new name.

    TestOssBucket
    BackupObjects

    string

    No

    The backup objects.

    [ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]
    BackupPeriod

    string

    No

    The full backup cycle. Valid values:

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

    • Sunday

    Note

    You can select multiple values. Separate them with commas (,).

    Monday
    BackupStartTime

    string

    No

    The start time for the full backup. The time is in the HH:mm format and is in UTC.

    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 backups, in seconds (s).

    Note

    This parameter is required only if you select physical backup.

    1000
    BackupRetentionPeriod

    integer

    No

    The retention period for backup data. Valid values: 0 to 1825. The default value is 730 days.

    730
    DuplicationInfrequentAccessPeriod

    integer

    No

    The time after which backup data is converted to Infrequent Access (IA) storage. The default value is 180 days.

    180
    DuplicationArchivePeriod

    integer

    No

    The time after which backup data is converted to archive storage. The default value is 365 days.

    365
    BackupPlanName

    string

    Yes

    The custom name of the backup plan.

    dbstooi0*******
    SourceEndpointOracleSID

    string

    No

    The Oracle system ID (SID). This parameter is required if the database type is Oracle.

    test
    BackupStorageType

    string

    No

    The built-in storage type:

    • Empty (default): Backup data is stored on your OSS bucket.

    • system: Backup data is stored on the built-in OSS bucket of DBS.

    无
    BackupSpeedLimit

    integer

    No

    The disk I/O limit, in KB/s.

    Note

    This parameter is valid only for MySQL physical backups.

    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 backups.

    262144
    BackupStrategyType

    string

    No

    The backup strategy type. Valid values:

    • simple: periodic backup. Use this value with BackupPeriod and BackupStartTime.

    • manual: manual backup.

    Note

    The default value is simple.

    simple
    CrossAliyunId

    string

    No

    The UID of the Alibaba Cloud account for cross-account backup.

    1648821913******
    CrossRoleName

    string

    No

    The name of the Resource Access Management (RAM) role for cross-account backup.

    test123
    ClientToken

    string

    No

    A client token that is used to ensure the idempotence of the request. This prevents duplicate requests.

    ASDASDASDSADASFCZXVZ
    ResourceGroupId

    string

    No

    The ID of the resource group.

    rg-aekzecovzti****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    HttpStatusCode

    integer

    The HTTP status code.

    200
    RequestId

    string

    The request ID.

    4F1888AC-1138-4995-B9FE-D2734F61C058
    CreateBackupSet

    boolean

    Indicates whether a backup set is created. Return values:

    • true: A backup set is created.

    • false: A backup set is not created.

    true
    ErrCode

    string

    The error code.

    Param.NotFound
    Success

    boolean

    Indicates whether the request was successful.

    true
    ErrMessage

    string

    The error message.

    The specified parameter %s value is not valid.
    BackupPlanId

    string

    The ID of the backup plan.

    dbs1hvb0wwwe****
    OrderId

    string

    The order ID.

    2056157***

    Examples

    Success response

    JSON format

    {
  "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": "dbs1hvb0wwwe****",
  "OrderId": "2056157***"
}

    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.