ModifyBackupObjects - Data Management - Alibaba Cloud Documentation Center

Modifies backup objects of a backup schedule in Database Backup (DBS).

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
dbs:ModifyBackupObjects	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The ID of the backup schedule.	dbs1h****usfa
BackupObjects	string	Yes	The backup objects that are defined in a JSON string in the following format: `[ { "DBName":"The name of the database that you want to back up", "SchemaName":"The name of the schema that you want to back up", "TableIncludes":[{ "TableName":"The name of the table that you want to back up" }], "TableExcludes":[{ "TableName":"The name of the table that you want to exclude during the backup" }] } ]` If you specify only `DBName` and do not specify objects of lower levels, all objects in the database are backed up. If you specify `DBName` and some objects of lower levels, only the specified objects are backed up by default. You can use the following regular expressions to define object names: A period `.` matches any single character except `\r\n`. An asterisk `` matches zero or more occurrences of a preceding subexpression. For example, `h.llo` matches strings such as `hllo` and `heeeello`. A question mark `?` matches zero or one occurrence of a preceding subexpression. For example, `h.?llo` matches strings such as `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 `SchemaName` and `NewSchemaName` apply only to SQL Server databases. Use `DBName` and `NewDBName` to specify the names of other databases.	[ { "DBName":"17xxx92xxxx374", "SchemaName":"gy9xnj8xxxxxx", "TableIncludes":[{ "TableName":"test1" }], "TableExcludes":[{ "TableName":"test2" }] } ]
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	ETnLKlblzczshOTUbOCzxxxxxxx

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	D6E068C3-25BC-455A-85FE-45F0B22ECB1F
ErrCode	string	The error code returned if the request failed.	Param.NotFound
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
BackupPlanId	string	The ID of the backup schedule.	dbs1h****usfa
NeedPrecheck	boolean	Indicates whether a precheck is triggered. If true is returned, you must call the StartBackupPlan operation to start the backup schedule.	true

Examples

Sample success responses

JSONformat

{
  "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 code	Error code	Error message
403	Request.Forbidden	Have no Permissions

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

Change history

Change time	Summary of changes	Operation

No change history