You can call this operation to modify the backup objects of a DBS backup schedule.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyBackupObjects

The parameter specified by the system. Value: ModifyBackupObjects.

BackupObjects String Yes [ { "DBName":"17xxx92xxxx374", "SchemaName":"gy9xnj8xxxxxx", "TableIncludes":[{ "TableName":"test1" }], "TableExcludes":[{ "TableName":"test2" }] } ]

The definition of BackupObjects is a JSON string:

        "DBName":"Name of the database to be backed up",
        "SchemaName":"The name of the Schema to be backed up",
        	"TableName":"The name of the table to be backed up"
            "TableName":"The name of the database to be backed up"
  • When the user only configures DBName, if no other child object rules are configured, all objects in the database are migrated.
  • When the user configures DBName if you have configured some rules for objects, the objects that are not configured are not migrated by default. You can use the following regular expressions to define different object names:
    • Point number .: indicates matching. \r\n any single character other than.
    • Asterisk *: indicates matching the front face expression any number of times. h.llo match hllo, heeeello such as string.
    • Question Mark?: matches zero or one occurrence of the previous expression. h.? llo match hllo, hello but cannot match haello.
    • Character set [characters]: matches any character included in the square brackets. For example, h[aello] match hallo, hello.
    • Negative character set [^characters]: it does not match any character included in the square brackets. For example, h[^ae]llo match hcllo, hdllo, but it cannot match hallo, hello.
    • Character Range [character1-character2]: Indicates character1-character2 the characters in the range can be matched. For example, [0-9], [a-z].
Note SchemaName and NewSchemaName it is used only for MSSQL, and is used for the definition of database names in other databases. DBName and NewDBName parameter.
BackupPlanId String Yes dbs1h****usfa

The ID of the backup plan.

RegionId String No cn-hangzhou

Region ID, call DescribeRegions to view the regions supported by DBS.

ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxx

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

Response parameters

Parameter Type Example Description
BackupPlanId String dbs1h****usfa

The ID of the backup plan.

ErrCode String Param.NotFound

The error code.

ErrMessage String The specified parameter %s value is not valid.

The error message.

HttpStatusCode Integer 200

The HTTP status code.

NeedPrecheck Boolean true

Indicates whether the PreCheck is triggered by the modification. If the value is true, you need to call the StartBackupPlan operation to start a backup plan.

RequestId String D6E068C3-25BC-455A-85FE-45F0B22ECB1F

The ID of the request.

Success Boolean true

Indicates whether the request succeeded.


Sample requests

http(s):// Action=ModifyBackupObjects
&BackupObjects=[     {         "DBName":"17xxx92xxxx374",         "SchemaName":"gy9xnj8xxxxxx",         "TableIncludes":[{         	"TableName":"test1"         }],         "TableExcludes":[{             "TableName":"test2"         }]     } ]
&<Common request parameters>

Sample success responses

XML format


JSON format

{"RequestId":"D6E068C3-25BC-455A-85FE-45F0B22ECB1F","HttpStatusCode":"200","BackupPlanId":"dbs1h****usfa","NeedPrecheck":"true","ErrMessage":"The specified parameter %s value is not valid. ","Success":"true","ErrCode":"Param.NotFound"}

Error codes

For a list of error codes, visit the API Error Center.