All Products
Document Center

Database Backup:ModifyBackupObjects

Last Updated:May 15, 2024

Modifies the backup objects of a backup schedule.


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
  • All Resources

Request parameters


The ID of the backup schedule.


The backup objects that are defined in a JSON string in the following format:

        "DBName":"Name of the database to be backed up",
        "SchemaName":"Name of the schema to be backed up",
        	"TableName":"Name of the table to be backed up"
            "TableName":"Name of the table to be excluded during the backup"
  • If you specify only the DBName parameter and do not specify lower levels of objects, all objects in the database are backed up.

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

    • A period (.) matches any single character except \r or \n.``
    • An asterisk (*) matches zero or more occurrences of the preceding subexpression. For example, h.*llo matches hllo and heeeello.``
    • A question mark (?) matches zero or one repetition of the preceding subexpression. For example, h.?llo matches hllo and hello, but not haello.``
    • Character set [Characters] matches a character included in the brackets ([ ]). For example, h[ae]llo matches hallo and hello.
    • Negative character set [^Characters] does not match a character in the brackets ([ ]). For example, h[^ae]llo matches hcllo and hdllo, but not hallo or hello.
    • Character range [character1-character2] matches any character included in the range from character1 to character2, such as [0-9] and [a-z].``
Note The SchemaName and NewSchemaName parameters are used only for SQL Server databases. The DBName and NewDBName parameters are used to define the names of other databases.
[ { "DBName":"17xxx92xxxx374", "SchemaName":"gy9xnj8xxxxxx", "TableIncludes":[{ "TableName":"test1" }], "TableExcludes":[{ "TableName":"test2" }] } ]

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


Response parameters


The HTTP status code.


The ID of the request.


The error code.


Indicates whether the request is successful.


The error message.

The specified parameter %s value is not valid.

The ID of the backup schedule.


Indicates whether a precheck is triggered. If the value of this parameter is true, you must start the backup schedule by calling the StartBackupPlan operation.



Sample success responses


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

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