All Products
Search
Document Center

Database Backup:ModifyBackupObjects

Last Updated:Nov 09, 2022

Modifies the backup objects of a backup schedule.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
dbs:ModifyBackupObjectsRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringYes

The ID of the backup schedule.

dbs1h****usfa
BackupObjectsstringYes

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",
        "TableIncludes":[{
        	"TableName":"Name of the table to be backed up"
        }],
        "TableExcludes":[{
            "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].``
NoteThe 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" }] } ]
ClientTokenstringNo

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

ETnLKlblzczshOTUbOCzxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The ID of the request.

D6E068C3-25BC-455A-85FE-45F0B22ECB1F
ErrCodestring

The error code.

Param.NotFound
Successboolean

Indicates whether the request is successful.

true
ErrMessagestring

The error message.

The specified parameter %s value is not valid.
BackupPlanIdstring

The ID of the backup schedule.

dbs1h****usfa
NeedPrecheckboolean

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.

true

Example

Normal return example

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

For a list of error codes, visit the API error center.