ModifyBackupObjects - Data Management - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dbs:ModifyBackupObjects

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The ID of the backup plan.	dbs1h****usfa
BackupObjects	string	Yes	The backup objects, specified as a JSON string. The format is as follows: `[ { "DBName":"The name of the database to be backed up", "SchemaName":"The name of the schema to be backed up", "TableIncludes":[{ "TableName":"The name of the table to be backed up" }], "TableExcludes":[{ "TableName":"The name of a table in the database that does not need to be backed up" }] } ]` If only `DBName` is specified and no rules are configured for other sub-objects, all objects in the database are backed up. If `DBName` is specified and rules are configured for some objects, objects without configured rules are not backed up by default. Object names can be defined using the following regular expressions: A period (`.`) matches any single character except for `\r\n`. An asterisk (``) matches the preceding subexpression zero or more times. For example, `hllo` matches strings such as `hllo` and `heeeello`. A question mark (`?`) matches the preceding subexpression zero or one time. For example, `h.?llo` matches `hllo` and `hello`, but not `haello`. A character set (`[characters]`) matches any single character within the brackets. For example, `h[aello]` matches `hallo` and `hello`. A negated character set (`[^characters]`) matches any single character not within the brackets. For example, `h[^ae]llo` matches `hcllo` and `hdllo`, but not `hallo` or `hello`. A character range (`[character1-character2]`) matches any character within the specified range, such as `[0-9]` or `[a-z]`. Note `SchemaName` and `NewSchemaName` are used only for MSSQL. For other databases, use the `DBName` and `NewDBName` parameters to define database names.	[ { "DBName":"17xxx92xxxx374", "SchemaName":"gy9xnj8xxxxxx", "TableIncludes":[{ "TableName":"test1" }], "TableExcludes":[{ "TableName":"test2" }] } ]
ClientToken	string	No	A client token to ensure the idempotence of the request. This prevents the same request from being submitted multiple times.	ETnLKlblzczshOTUbOCzxxxxxxx

Response elements

Element	Type	Description	Example
	object	The details of the returned parameters.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	D6E068C3-25BC-455A-85FE-45F0B22ECB1F
ErrCode	string	The error code.	InvalidParameter
Success	boolean	Indicates whether the request was successful. The return values are as follows: true: The request was successful. false: The request failed.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
BackupPlanId	string	The ID of the backup plan.	dbs1h****usfa
NeedPrecheck	boolean	Indicates whether the modification triggers a precheck. If the value is true, call the StartBackupPlan operation to start the backup plan.	true

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "ErrCode": "InvalidParameter",
  "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	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.