调用CreateRestoreTask接口，创建DBS恢复任务。

调试

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

请求参数

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

系统规定参数。取值：CreateRestoreTask。

BackupPlanId String 是 dbs1hvb0wwXXXX

备份计划ID。
DestinationEndpointInstanceType String 是 RDS

数据库所在位置，取值：

  • RDS
  • ECS
  • Express：通过专线/VPN网关/智能网关接入的数据库
  • Agent：通过备份网关接入的数据库
  • DDS：云MongoDB
  • Other：通过IP:Port直连的数据库
RestoreTaskName String 是 test

恢复任务名称。
DestinationEndpointRegion String 否 100.X.X.10:33204

数据库地域。

说明 DestinationEndpointInstanceType为RDS、ECS、DDS、Express、Agent时，该参数必传。
DestinationEndpointInstanceID String 否 rm-bp1p8c29XXXXX

数据库实例ID。

说明 DestinationEndpointInstanceType为RDS、ECS、DDS、Express时，该参数必传。
DestinationEndpointIP String 否 rm-bpXXXXX9jv8pxero.mysql.rds.aliyuncs.com

数据库连接地址。

说明 DestinationEndpointInstanceType为express、agent、other，该参数必传。
DestinationEndpointPort Integer 否 3306

数据库端口。

说明 DestinationEndpointInstanceType为express、agent、other、ECS，该参数必传。
DestinationEndpointDatabaseName String 否 test

数据库名称。

说明 数据库类型为PostgreSQL、MongoDB时，该参数必传。
DestinationEndpointUserName String 否 test

数据库账号。

说明 数据库类型为Redis，或者数据库所在位置为agent且数据库类型为MSSQL时该参数非必须，其他场景均必传。
DestinationEndpointPassword String 否 Test

密码。

说明 数据库类型为Redis，或者数据库所在位置为agent且数据库类型为MSSQL时该参数非必须，其他场景均必传。
BackupGatewayId Long 否 43123424

备份网关ID。

说明 DestinationEndpointInstanceType为agent时，该参数必传。
RestoreObjects String 否 [ { "DBName":"待恢复库名", "NewDBName":"目标待恢复库名", "SchemaName":"待恢复 Schema 名", "NewSchemaName":"目标待恢复 Schema 名"}]

恢复对象。

说明 详见下面的RestoreObjects参数定义，当数据库所在位置为agent时，该参数非必须，其他场景均必传。
RestoreTime Long 否 1554560477000

恢复时间，取值：1554560477000。
BackupSetId String 否 dbs1hvb0wXXXXX

恢复所使用的全量备份集ID，和RestoreTime互斥。
DestinationEndpointOracleSID String 否 test

Oracle SID名称。

说明 数据库类型为Oracle时，该参数必传。
RestoreDir String 否 test

DestinationEndpointInstanceType为agent且备份计划为MySQL时必传。

RestoreHome String 否 test

数据库程序目录。
DuplicateConflict String 否 failure

同名对象冲突处理方式，取值：

  • failure：遇到同名对象则失败（默认值）
  • renamenew：遇到同名对象则重命名
RegionId String 否 cn-hangzhou

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

ClientToken String 否 ETnLKlblzczshOTUbOCzxxxxxxx

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

返回数据

名称 类型 示例值 描述
ErrCode String Param.NotFound

错误码。
ErrMessage String The specified parameter %s value is not valid.

错误信息。
HttpStatusCode Integer 200

HTTP状态码。
RequestId String 60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC

请求ID。
RestoreTaskId String s102hXXXXX

恢复任务ID。
Success Boolean true

是否成功。

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=CreateRestoreTask
&BackupPlanId=dbs1hvb0wwXXXX
&DestinationEndpointInstanceType=rds
&RestoreTaskName=test
&<公共请求参数>

正常返回示例

XML 格式 

<CreateRestoreTaskResponse>
  <RestoreTaskId>s102hXXXXX</RestoreTaskId>
  <RequestId>60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC</RequestId>
  <HttpStatusCode>200</HttpStatusCode>
  <Success>true</Success>
</CreateRestoreTaskResponse>

JSON 格式 

{
	"RestoreTaskId": "s102hXXXXX",
	"RequestId": "60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC",
	"HttpStatusCode": 200,
	"Success": true
}

错误码

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