All Products
Search

This Product

    Database Backup:CreateAndStartBackupPlan

    Document Center

    Database Backup:CreateAndStartBackupPlan

    Last Updated:Apr 11, 2024

    Creates, configures, and starts a backup schedule.

    Operation description

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

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    dbs:CreateAndStartBackupPlanWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    BackupPlanIdstringNo

    The ID of the backup schedule.

    		dbstooi0*******
    RegionstringNo

    The region in which DBS is activated. Valid values:

    • cn-hangzhou: China (Hangzhou)
    • cn-shanghai: China (Shanghai)
    • cn-qingdao: China (Qingdao)
    • cn-beijing: China (Beijing)
    • cn-shenzhen: China (Shenzhen)
    • cn-hongkong: China (Hong Kong)
    • ap-southeast-1: Singapore (Singapore)
    • cn-hangzhou-finance: China East 1 Finance
    • cn-shanghai-finance: China East 2 Finance
    • cn-shenzhen-finance: China South 1 Finance
    		cn-hangzhou
    InstanceClassstringYes

    The specifications of the backup schedule. Valid values:

    • micro
    • small
    • medium
    • large
    • xlarge
    Note The higher the specifications, the higher the performance of backup and restoration. For more information, see Select backup schedule specifications.
    		micro
    DatabaseTypestringYes

    The database engine that is run by the database instance. Valid values:

    • MySQL
    • MSSQL
    • Oracle
    • MariaDB
    • PostgreSQL
    • DRDS
    • MongoDB
    • Redis
    		MySQL
    BackupMethodstringYes

    The method that is used to generate the backup file. Valid values:

    • logical: logical backup
    • physical: physical backup
    • duplication: dump backup
    		logical
    PeriodstringNo

    Specifies whether to use yearly subscription or monthly subscription for the instance. Valid values:

    • Year: yearly subscription
    • Month: monthly subscription
    		Year
    UsedTimeintegerNo

    The subscription duration of the instance. Valid values:

    • If the Period parameter is set to Year, the value of the UsedTime parameter ranges from 1 to 9.
    • If the Period parameter is set to Month, the value of the UsedTime parameter ranges from 1 to 11.
    		1
    PayTypestringNo

    The billing method of the backup schedule. Valid values:

    • Postpaid: pay-as-you-go
    • prepay: subscription
    Note Default value: prepay. This parameter can be set to postpay only if the BackupMethod parameter is set to duplication.
    		Postpaid
    DatabaseRegionstringNo

    The region in which the database that you want to back up resides.

    Note This parameter is required if the PayType parameter is set to postpay.
    		cn-hangzhou
    StorageRegionstringNo

    The region in which you want to store the backup data.

    Note This parameter is required if the PayType parameter is set to postpay.
    		cn-hangzhou
    InstanceTypestringNo

    The type of the database instance. Valid values:

    • RDS
    • PolarDB
    • DDS
    • Kvstore
    • Other
    Note This parameter is required if the PayType parameter is set to postpay.
    		RDS
    StorageTypestringNo

    This parameter is unavailable.

    		N/A
    FromAppstringNo

    The request source. Default value: OpenApi. You do not need to set this parameter.

    		OpenApi
    SourceEndpointInstanceTypestringYes

    The location of the database. Valid values:

    • RDS
    • ECS
    • Express: The source database is connected to DBS by using Express Connect, VPN Gateway, or Smart Access Gateway.
    • Agent: The database is connected to DBS over a DBS backup gateway.
    • DDS: The database is an ApsaraDB for MongoDB database.
    • Other: The database is connected to DBS by using the IP address and port of the database.
    		RDS
    SourceEndpointRegionstringNo

    The region in which the database that you want to back up resides.

    Note This parameter is required if the SourceEndpointInstanceType parameter is set to RDS, ECS, DDS, Express, or Agent.
    		cn-hangzhou
    SourceEndpointInstanceIDstringNo

    The ID of the database instance.

    Note This parameter is required if the SourceEndpointInstanceType parameter is set to RDS, ECS, DDS, or Express.
    		rm-uf6wjk5xxxxxxxxxx
    SourceEndpointIPstringNo

    The endpoint of the database.

    Note This parameter is required if the SourceEndpointInstanceType parameter is set to Express, Agent, or Other.
    		rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com
    SourceEndpointPortintegerNo

    The port of the database.

    Note This parameter is required if the SourceEndpointInstanceType parameter is set to Express, Agent, Other, or ECS.
    		3306
    SourceEndpointDatabaseNamestringNo

    The name of the database.

    Note This parameter is required if the DatabaseType parameter is set to PostgreSQL or MongoDB.
    		testRDS
    SourceEndpointUserNamestringNo

    The username of the account that is used to connect to the database.

    Note This parameter is required except that the database is an SQL Server database that is connected to DBS over a DBS backup gateway or a Redis database.
    		testRDS
    SourceEndpointPasswordstringNo

    The password of the account that is used to connect to the database.

    Note This parameter is required except that the database is an SQL Server database that is connected to DBS over a DBS backup gateway or a Redis database.
    		testPassword
    BackupGatewayIdlongNo

    The ID of the DBS backup gateway.

    Note This parameter is required If the SourceEndpointInstanceType parameter is set to Agent.
    		23313123312
    OSSBucketNamestringNo

    The name of the Object Storage Service (OSS) bucket used to store backup files. By default, the system automatically generates a name for the OSS bucket.

    		TestOssBucket
    BackupObjectsstringNo

    The object to be backed up.

    		\[ { "DBName":"Name of the database to be backed up", "SchemaName":"Name of the schema to be backed up", "TableIncludes":\[{ "TableName":"Name of the table to be backed up" }], "TableExcludes":\[{ "TableName":"Name of the table that you do not want to back up" }] } ]
    BackupPeriodstringNo

    The day of each week when the full backup task runs. Valid values:

    • Monday
    • Tuesday
    • Wednesday
    • Thursday
    • Friday
    • Saturday
    • Sunday
    		Monday
    BackupStartTimestringNo

    The start time of the full backup task. Specify the value in the HH:mmZ format. The time must be in UTC.

    		14:22
    EnableBackupLogbooleanNo

    Specifies whether to enable the incremental log backup feature. Valid values:

    • true: enables the incremental log backup feature.
    • false: disables the incremental log backup feature.
    		true
    BackupLogIntervalSecondsintegerNo

    The interval at which you want to perform incremental log backups. Unit: seconds.

    Note This parameter takes effect only when physical backups are performed.
    		1000
    BackupRetentionPeriodintegerNo

    The number of days for which the backup data is retained. Valid values: 0 to 1825. Default value: 730.

    		730
    DuplicationInfrequentAccessPeriodintegerNo

    The number of days after which the storage class of the backup data is changed to Infrequent Access (IA). Default value: 180.

    		180
    DuplicationArchivePeriodintegerNo

    The number of days after which the storage class of the backup data is changed to Archive. Default value: 365.

    		365
    BackupPlanNamestringYes

    The name of the backup schedule.

    		dbstooi0*******
    SourceEndpointOracleSIDstringNo

    The system ID (SID) of the Oracle database. This parameter is required if the source database is an Oracle database.

    		test
    BackupStorageTypestringNo

    The storage type. Valid values:

    • Empty: If you do not specify this parameter, the system stores backup data in your OSS bucket.
    • system : The system stores backup data in the built-in OSS bucket of DBS.
    		N/A
    BackupSpeedLimitlongNo

    The I/O limit for the disk. Unit: KB/s.

    Note This parameter takes effect only when physical backups for MySQL databases are performed.
    		262144
    BackupRateLimitlongNo

    The network bandwidth throttling. Unit: KB/s. DBS allows a maximum bandwidth of 10 GB/s.

    Note This parameter takes effect only when physical backups for MySQL databases are performed.
    		262144
    BackupStrategyTypestringNo

    The backup method that you want to use for full backups. Valid values:

    • simple: scheduled backup. If you specify this value for the BackupStrategyType parameter, you must also specify the BackupPeriod and BackupStartTime parameters.
    • Manual: manual backup.
    Note Default value: simple.
    		simple
    CrossAliyunIdstringNo

    The unique ID (UID) of the Alibaba Cloud account to which the backup schedule belongs.

    		2xxx7778xxxxxxxxxx
    CrossRoleNamestringNo

    The name of the RAM role that is used to perform backups across Alibaba Cloud accounts.

    		test123
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    		DBS
    ResourceGroupIdstringNo

    ResourceGroup ID.

    		rg-aekzecovzti****

    Response parameters

    ParameterTypeDescriptionExample
    object
    HttpStatusCodeinteger

    The HTTP status code.

    		200
    RequestIdstring

    The ID of the request.

    		4F1888AC-1138-4995-B9FE-D2734F61C058
    CreateBackupSetboolean

    Indicates whether the backup set feature is enabled. Valid values:

    • true: The backup set feature is enabled.
    • false: The backup set feature is disabled.
    		true
    ErrCodestring

    The error code.

    		Param.NotFound
    Successboolean

    Indicates whether the request is successful.

    		true
    ErrMessagestring

    The error message.

    		The specified parameter %s value is not valid.
    BackupPlanIdstring

    The ID of the backup schedule.

    		dbs1hvb0wwweusfa
    OrderIdstring

    The ID of the order.

    		2056157***

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError message
    403Request.ForbiddenHave no Permissions

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history