全部产品
云市场

创建恢复任务

更新时间:2019-05-10 18:02:32

描述

创建DBS恢复任务。

请求参数

名称 类型 是否必选 描述
Action String 系统规定参数,取值:CreateRestoreTask
DestinationEndpointInstanceType String 数据库所在位置,取值:
  • rds
  • ecs
  • express:通过专线/VPN网关/智能网关接入的数据库
  • agent:通过备份网关接入的数据库
  • dds:云MongoDB
  • other:通过IP:Port直连的数据库
DestinationEndpointRegion String 数据库地域,DestinationEndpointInstanceType为RDS、ECS、DDS、Express、Agent时,该参数必传
DestinationEndpointInstanceID String 数据库实例ID,DestinationEndpointInstanceType为RDS、ECS、DDS、Express时,该参数必传
DestinationEndpointIP String 数据库连接地址,DestinationEndpointInstanceType为express、agent、other,该参数必传
DestinationEndpointPort Integer 数据库端口,DestinationEndpointInstanceType为express、agent、other、ECS,该参数必传
DestinationEndpointDatabaseName String 数据库名称,数据库类型为PostgreSQL、MongoDB时,该参数必传;数据库所在位置为agent且数据库类型为MSSQL时,该参数必传
DestinationEndpointUserName String 数据库账号,数据库类型为Redis,或者数据库所在位置为agent且数据库类型为MSSQL时该参数非必须,其他场景均必传
DestinationEndpointPassword String 密码,数据库类型为Redis,或者数据库所在位置为agent且数据库类型为MSSQL时该参数非必须,其他场景均必传
BackupGatewayId Long 备份网关ID,DestinationEndpointInstanceType为agent时,该参数必传
RestoreObjects String 恢复对象,详见下面的RestoreObjects参数定义,当数据库所在位置为agent时,该参数非必须,其他场景均必传
RestoreTime Long 恢复时间,取值:1554560477000
BackupSetId String 恢复所使用的全量备份集ID,和RestoreTime互斥
RestoreTaskName String 恢复任务名称
DestinationEndpointOracleSID String Oracle SID名称,数据库类型为Oracle时,该参数必传
RestoreDir String DestinationEndpointInstanceType为agent且备份计划为MySQL时必传
BackupPlanId String 备份计划ID
DuplicateConflict String 同名对象冲突处理方式,取值:
  • failure:遇到同名对象则失败(默认值)
  • renamenew:遇到同名对象则重命名

RestoreObjects 参数定义

RestoreObjects的定义格式为 JSON 字符串,且对象配置支持一定的正则表达式。

RestoreObject的定义如下:

  1. [
  2. {
  3. "DBName":"待恢复库名",
  4. "NewDBName":"目标待恢复库名",
  5. "SchemaName":"待恢复 Schema 名"
  6. "NewSchemaName":"目标待恢复 Schema 名"
  7. }
  8. ]

其中:SchemaName 和 NewSchemaName 只用于 SQLServer,其他数据库的库名定义使用 DBName 和 NewDBName 这个参数。

NewDBName和NewSchemaName是指目标实际恢复的库名(自动重命名),如果恢复一样的库名可以不传入这2个参数。

对象名的定义可以支持如下的正则表达式:

  • 点号 . 表示匹配除 ‘\r\n’ 之外的任何单个字符
  • 星号 表示匹配前面子表达式任意次,h.llo 匹配 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]

返回参数

名称 类型 描述
RestoreTaskId String 恢复任务ID

错误码

错误码 错误信息 描述
RestoreTaskNotCreate Restore Task not Create. 无法创建恢复任务