All Products
Search

This Product

    Data Management:ConfigureBackupPlan

    Document Center

    Data Management:ConfigureBackupPlan

    Last Updated:Jan 13, 2026

    Configures 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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    BackupPlanId

    string

    Yes

    The ID of the backup plan. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    dbstooi0*******
    SourceEndpointInstanceType

    string

    Yes

    The type of the database source. Call the DescribeBackupPlanList operation to obtain the value of this parameter. Valid values:

    • RDS

    • ECS

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

    • Agent: A database connected over a backup gateway.

    • DDS: ApsaraDB for MongoDB.

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

    RDS
    SourceEndpointRegion

    string

    No

    The region of the database. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    Note

    This parameter is required if SourceEndpointInstanceType is set to RDS, ECS, DDS, Express, or Agent.

    cn-hangzhou
    SourceEndpointInstanceID

    string

    No

    The ID of the database instance. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    Note

    This parameter is required if SourceEndpoint.InstanceType is set to RDS, ECS, DDS, or Express.

    rm-uf6wjk5*********
    SourceEndpointIP

    string

    No

    The database endpoint. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    Note

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

    rm-uf6wjk5*******.mysql.rds.aliyuncs.com
    SourceEndpointPort

    integer

    No

    The database port. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    Note

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

    3306
    SourceEndpointDatabaseName

    string

    No

    The name of the database. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    Note

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

    testRDS
    SourceEndpointUserName

    string

    No

    The database account.

    Note

    This parameter is optional if the database type is Redis, or if SourceEndpointInstanceType is agent and the database type is SQL Server. Otherwise, this parameter is required.

    testRDS
    SourceEndpointPassword

    string

    No

    The password for the database account.

    Note

    This parameter is optional if the database type is Redis, or if SourceEndpointInstanceType is agent and the database type is SQL Server. Otherwise, this parameter is required.

    testPassword
    BackupGatewayId

    integer

    No

    The ID of the backup gateway. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    Note

    This parameter is required if SourceEndpointInstanceType is set to agent.

    23313123312
    OSSBucketName

    string

    No

    The name of the Object Storage Service (OSS) bucket.

    Note

    The system automatically generates a new name by default.

    TestOssBucket
    BackupObjects

    string

    No

    The backup objects. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

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

    string

    No

    The full backup cycle. Valid values:

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

    • Sunday

    Monday
    BackupStartTime

    string

    No

    The start time for the full backup. The time is in the HH:mmZ format (UTC). Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    14:22
    EnableBackupLog

    boolean

    No

    Specifies whether to enable incremental log backup. Valid values:

    • true: Enable.

    • false: Disable.

    true
    BackupLogIntervalSeconds

    integer

    No

    The interval for incremental backups, in seconds (s).

    Note

    This parameter is valid only for physical backups.

    1000
    BackupRetentionPeriod

    integer

    No

    The retention period for backup data, in days. Valid values: 0 to 1825. Default value: 730.

    730
    DuplicationInfrequentAccessPeriod

    integer

    No

    The number of days after which a backup is converted to Infrequent Access (IA) storage. Default value: 180.

    180
    DuplicationArchivePeriod

    integer

    No

    The number of days after which a backup is converted to archive storage. Default value: 365.

    365
    BackupPlanName

    string

    Yes

    The custom name of the backup plan. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    dbstooi0*******
    SourceEndpointOracleSID

    string

    No

    The Oracle system ID (SID).

    Note

    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 in your OSS bucket.

    • system: Backup data is stored in 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 physical backups of MySQL databases.

    262144
    BackupRateLimit

    integer

    No

    The network bandwidth throttling limit, in KB/s. The maximum value is 10 GB.

    Note

    This parameter is valid only for physical backups of MySQL databases.

    262144
    BackupStrategyType

    string

    No

    The backup strategy. 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 of the Alibaba Cloud account for cross-account backup. Call the DescribeRestoreTaskList operation to obtain the value of this parameter.

    2xxx7778xxxxxxxxxx
    CrossRoleName

    string

    No

    The name of the Resource Access Management (RAM) role for cross-account backup. Call the DescribeRestoreTaskList operation to obtain the value of this parameter.

    test123
    AutoStartBackup

    boolean

    No

    Specifies whether to enable automatic backup.

    • true: Enable.

    • false: Disable.

    false
    ClientToken

    string

    No

    A client token used to ensure the idempotence of the request. This prevents duplicate requests. The client generates this value, which must be unique among different requests. The value can be up to 64 ASCII characters and cannot contain non-ASCII characters.

    ETnLKlblzczshOTUbOCzxxxxxxx
    ResourceGroupId

    string

    No

    The resource group ID.

    rg-aekzecovzti****

    Response elements

    Element

    Type

    Description

    Example

    object

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