调用ModifyBackupObjects接口修改备份计划中的备份对象-数据管理 DMS-阿里云

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dbs:ModifyBackupObjects

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
BackupPlanId	string	是	备份计划 ID。	dbs1h****usfa
BackupObjects	string	是	BackupObjects 的定义格式为 JSON 字符串，定义如下： `[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]` 当用户只配置了`DBName`，不配置其他子对象的规则，那么表示迁移这个数据库下面的所有对象。当用户配置了`DBName`，且配置了部分对象的规则，那么不配置的对象默认不迁移。各种对象名的定义可以支持如下的正则表达式：点号`.`：表示匹配除`\r\n`之外的任何单个字符。星号``：表示匹配前面子表达式任意次，`hllo`匹配 `hllo`、`heeeello`等字符串。问号`?`：表示匹配前面子表达式零次或 1 次，`h.?llo`匹配`hllo`、`hello`，但不能匹配`haello`。字符集合`[characters]`：表示匹配方括号内任意一个字符，例如`h[aello]`匹配`hallo`、`hello`。负值字符集合`[^characters]`：表示不匹配方括号内任意一个字符，例如`h[^ae]llo`匹配`hcllo`、`hdllo`，但是不能匹配`hallo`、`hello`。字符范围`[character1-character2]`：表示 `character1-character2`范围内的字符都可以匹配，例如 `[0-9]`、`[a-z]`。说明 `SchemaName` 和 `NewSchemaName`只用于 MSSQL，其他数据库的库名定义使用 `DBName`和`NewDBName`参数。	[ { "DBName":"17xxx92xxxx374", "SchemaName":"gy9xnj8xxxxxx", "TableIncludes":[{ "TableName":"test1" }], "TableExcludes":[{ "TableName":"test2" }] } ]
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。	ETnLKlblzczshOTUbOCzxxxxxxx

返回参数

名称	类型	描述	示例值
	object	返回参数详情如下。
HttpStatusCode	integer	HTTP 状态码。	200
RequestId	string	请求 ID。	D6E068C3-25BC-455A-85FE-45F0B22ECB1F
ErrCode	string	错误码。	InvalidParameter
Success	boolean	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
ErrMessage	string	错误信息。	The specified parameter %s value is not valid.
BackupPlanId	string	备份计划 ID。	dbs1h****usfa
NeedPrecheck	boolean	本次修改是否会触发预检查，如果为 true 则需要再调用 StartBackupPlan 接口启动备份计划。	true

示例

正常返回示例

JSON格式

{
  "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
}

错误码

HTTP status code	错误码	错误信息	描述
403	Request.Forbidden	Have no Permissions	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。