调用ModifyBackupObjects接口,修改一个DBS备份计划的备份对象。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyBackupObjects

系统规定参数,取值:ModifyBackupObjects。

BackupObjects String [ { "DBName":"17xxx92xxxx374", "SchemaName":"gy9xnj8xxxxxx", "TableIncludes":[{ "TableName":"test1" }], "TableExcludes":[{ "TableName":"test2" }] } ]

BackupObjects 的定义格式为 JSON 字符串,定义如下:


[
    {
        "DBName":"待备份库名",
        "SchemaName":"待备份 Schema 名",
        "TableIncludes":[{
        	"TableName":"待备份表表名"
        }],
        "TableExcludes":[{
            "TableName":"待备份库名不需要备份表的表名"
        }]
    }
]
  • 当用户只配置了DBName,不配置其他子对象的规则,那么表示迁移这个数据库下面的所有对象。
  • 当用户配置了DBName,且配置了部分对象的规则,那么不配置的对象默认不迁移。各种对象名的定义可以支持如下的正则表达式:
    • 点号.:表示匹配除\r\n之外的任何单个字符。
    • 星号*:表示匹配前面子表达式任意次,h.llo匹配 hlloheeeello等字符串。
    • 问号?:表示匹配前面子表达式零次或1次,h.?llo匹配hllohello,但不能匹配haello
    • 字符集合[characters]:表示匹配方括号内任意一个字符,例如h[aello]匹配hallohello
    • 负值字符集合[^characters]:表示不匹配方括号内任意一个字符,例如h[^ae]llo匹配hcllohdllo,但是不能匹配hallohello
    • 字符范围[character1-character2]:表示 character1-character2范围内的字符都可以匹配,例如 [0-9][a-z]
说明 SchemaNameNewSchemaName只用于 MSSQL,其他数据库的库名定义使用 DBNameNewDBName参数。
BackupPlanId String dbs1h****usfa

备份计划ID。

RegionId String cn-hangzhou

地域ID,调用DescribeRegions接口查看DBS支持地域。

ClientToken String ETnLKlblzczshOTUbOCzxxxxxxx

用于保证请求的幂等性,防止重复提交请求。

返回数据

名称 类型 示例值 描述
BackupPlanId String dbs1h****usfa

备份计划ID。

ErrCode String Param.NotFound

错误码。

ErrMessage String The specified parameter %s value is not valid.

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

NeedPrecheck Boolean true

本次修改是否会触发预检查,如果为true则需要再调用StartBackupPlan接口启动备份计划。

RequestId String D6E068C3-25BC-455A-85FE-45F0B22ECB1F

请求ID。

Success Boolean true

是否成功。

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=ModifyBackupObjects
&BackupObjects=[     {         "DBName":"17xxx92xxxx374",         "SchemaName":"gy9xnj8xxxxxx",         "TableIncludes":[{         	"TableName":"test1"         }],         "TableExcludes":[{             "TableName":"test2"         }]     } ]
&BackupPlanId=dbs1h****usfa
&<公共请求参数>

正常返回示例

XML 格式

<ModifyBackupObjectsReponse>
  <RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId>
  <HttpStatusCode>200</HttpStatusCode>
  <BackupPlanId>dbs1h****usfa</BackupPlanId>
  <Success>true</Success>
</ModifyBackupObjectsReponse>

JSON 格式

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

错误码

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