All Products
Search
Document Center

ModifyBackupObjects

Last Updated: Mar 18, 2020

Description

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

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to ModifyBackupObjects.
BackupPlanId String Yes The ID of the backup schedule.
BackupObjects String Yes The objects to be backed up. For more information, see the description of the BackupObjects parameter.

BackupObjects

The BackupObjects parameter is defined as a JSON string. Certain regular expressions can be used in the object configuration.

The BackupObjects parameter is defined as follows:

[
    {
        "DBName":"Name of the database to be backed up",
        "SchemaName":"Schema name of the database 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"
        }]
    }
]

SchemaName and NewSchemaName are applicable only to MSSQL databases. DBName and NewDBName are used to specify the names of other databases.

If you only specify the DBName parameter and do not specify lower levels of objects, all objects in the database are migrated.

If you specify the DBName parameter and some lower levels of objects, the objects that are not specified are not migrated by default. You can use the following regular expressions to define different object names:

  • A period (.) matches any single character except '\r\n'.
  • An asterisk () matches zero or more occurrences of a subexpression which occurs before. For example, h.llo matches strings such as hllo and heeeello.
  • A question mark (?) matches zero or one occurrence of a subexpression which occurs before. For example, h.?llo matches hllo and hello, but not haello.
  • The [characters] character set matches any character included in the brackets ([ ]). For example, h[aello] matches hallo and hello.
  • The [^characters] negative character set does not match any character included in the brackets ([ ]). For example, h[^ae]llo matches hcllo and hdllo, but not hallo or hello.
  • The [character1-character2] character range matches any character included in the range from character1 to character2, for example, [0-9] and [a-z].

Response parameters

Parameter Type Description
BackupPlanId String The ID of the backup schedule.
NeedPrecheck Boolean Indicates whether the modification triggered precheck. If the value is true, you need to call the StartBackupPlan operation to start the backup schedule.

Error codes

Error code Error message Description
BackupPlanNotModify modify backup objects fail. The error message returned because the backup objects failed to be modified.