All Products
Search

This Product

    Database Backup:ConfigureBackupPlan

    Document Center

    Database Backup:ConfigureBackupPlan

    最終更新日:Sep 11, 2024

    Configures a backup schedule.

    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:ConfigureBackupPlanupdate
    • BackupPlan
      acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    BackupPlanIdstringYes

    The ID of the backup schedule. You can call the DescribeBackupPlanList operation to obtain the ID of the backup schedule.

    		dbstooi0*******
    SourceEndpointInstanceTypestringYes

    The location of the database. You can call the DescribeBackupPlanList operation to obtain the location. Valid values:

    • RDS
    • ECS
    • Express: The 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 you want to back up resides. You can call the DescribeBackupPlanList operation to obtain the region.

    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. You can call the DescribeBackupPlanList operation to obtain the ID of the database instance.

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

    The endpoint that is used to connect to the database. You can call the DescribeBackupPlanList operation to obtain the endpoint.

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

    The port that is used to connect to the database. You can call the DescribeBackupPlanList operation to obtain the port.

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

    The name of the database. You can call the DescribeBackupPlanList operation to obtain the name of the database.

    Note This parameter is required if the database is a PostgreSQL or MongoDB database.
    		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 backup gateway. You can call the DescribeBackupPlanList operation to obtain the ID of the 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 that is used to store backup files. By default, the system automatically generates a name for the OSS bucket.

    		TestOssBucket
    BackupObjectsstringNo

    The objects to be backed up. You can call the DescribeBackupPlanList operation to obtain the objects.

    		\[ { "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 to be excluded during the backup" }] } ]
    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 full backup tasks. Specify the value in the HH:mmZ format. The time must be in UTC. You can call the DescribeBackupPlanList operation to obtain the start time of full backup tasks.

    		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. You can call the DescribeBackupPlanList operation to obtain the name of the backup schedule.

    		dbstooi0*******
    SourceEndpointOracleSIDstringNo

    The system ID (SID) of the Oracle database.

    Note This parameter is required if the 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. You can call the DescribeRestoreTaskList operation to obtain the UID of the Alibaba Cloud account.

    		2xxx7778xxxxxxxxxx
    CrossRoleNamestringNo

    The name of the RAM role that is used to perform backups across Alibaba Cloud accounts. You can call the DescribeRestoreTaskList operation to obtain the RAM role.

    		test123
    AutoStartBackupbooleanNo

    Specifies whether to enable the automatic backup feature.

    • true: enables the automatic backup feature.
    • false: disables the automatic backup feature.
    		false
    ClientTokenstringNo

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

    		ETnLKlblzczshOTUbOCzxxxxxxx
    ResourceGroupIdstringNo

    ResourceGroupId.

    		rg-aekzecovzti****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    HttpStatusCodeinteger

    The HTTP status code.

    		200
    RequestIdstring

    The ID of the request.

    		F1FB49D4-B504-47F1-9F43-D7EAB33F****
    ErrCodestring

    The error code.

    		Param.NotFound
    Successboolean

    Indicates whether the request is successful. Valid values:

    • true: The request is successful.
    • false: The request fails.
    		true
    ErrMessagestring

    The error message.

    		The specified parameter %s value is not valid.
    BackupPlanIdstring

    The ID of the backup schedule.

    		dbstooi01ex****

    Examples

    Sample success responses

    JSONformat

    {
  "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 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