调用CreateRestoreTask API创建恢复任务-数据管理 DMS-阿里云

该接口用于创建DBS恢复任务。

接口说明

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dbs:CreateRestoreTask

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
BackupPlanId	string	是	备份计划 ID。	dbs1hvb0ww****
DestinationEndpointInstanceType	string	是	数据库所在位置，取值： RDS ECS Express：通过专线/VPN 网关/智能网关接入的数据库 Agent：通过备份网关接入的数据库 DDS：云 MongoDB Other：通过 IP:Port 直连的数据库 dg：无公网 IP:Port 的自建数据库（通过数据库网关 DG 接入）	RDS
DestinationEndpointRegion	string	否	数据库实例的地域。说明 DestinationEndpointInstanceType 为 RDS、ECS、DDS、Express、Agent 时，该参数必传。	cn-hangzhou
DestinationEndpointInstanceID	string	否	数据库实例 ID。说明 DestinationEndpointInstanceType 为 RDS、ECS、DDS、Express 时，该参数必传。	rm-bp1p8c29*****
DestinationEndpointIP	string	否	数据库连接地址。说明 DestinationEndpointInstanceType 为 express、agent、other，该参数必传。	rm-bp*****9jv8pxero.mysql.rds.aliyuncs.com
DestinationEndpointPort	integer	否	数据库端口。说明 DestinationEndpointInstanceType 为 express、agent、other、ECS，该参数必传。	3306
DestinationEndpointDatabaseName	string	否	数据库名称。说明数据库类型为 PostgreSQL、MongoDB 时，该参数必传。	test
DestinationEndpointUserName	string	否	数据库账号。说明数据库类型为 Redis，或者数据库所在位置为 agent 且数据库类型为 MSSQL 时该参数非必须，其他场景均必传。	test
DestinationEndpointPassword	string	否	密码。说明数据库类型为 Redis，或者数据库所在位置为 agent 且数据库类型为 MSSQL 时该参数非必须，其他场景均必传。	Test
BackupGatewayId	integer	否	备份网关 ID。说明 DestinationEndpointInstanceType 为 agent 时，该参数必传。	4312****
RestoreObjects	string	否	恢复对象。详情请参见下面的 RestoreObjects 参数定义，当数据库所在位置为 agent 时，该参数非必须，其他场景均必传。传入模板：`[{ "DBName": "待恢复库名", "NewDBName": "目标待恢复库名" }]` 说明使用本 API 接口恢复对象仅支持恢复到数据库级别，如需配置指定表的恢复，请前往控制台进行操作。具体请参见恢复数据库。	MySQL表级别恢复示例如下： [{\"DBName\":\"dbname\", \"NewDBName\":\"dbname1\"}]
RestoreTime	integer	否	恢复时间，取值：1554560477000。	1554560477000
BackupSetId	string	否	恢复所使用的全量备份集 ID，和 RestoreTime 互斥。	dbs1hvb0w*****
RestoreTaskName	string	是	恢复任务名称。	test
DestinationEndpointOracleSID	string	否	Oracle SID 名称。说明数据库类型为 Oracle 时，该参数必传。	test
RestoreDir	string	否	DestinationEndpointInstanceType 为 agent 且备份计划为 MySQL 时必传。	test
RestoreHome	string	否	数据库程序目录。	test
DuplicateConflict	string	否	同名对象冲突处理方式，当前支持： renamenew：遇到同名对象则重命名	renamenew
CrossAliyunId	string	否	跨阿里云账号备份的 UID。	2749528728********
CrossRoleName	string	否	跨阿里云账号备份的 RAM 角色名称。	test123
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。	ETnLKlblzczshOTUbOC********

返回参数

名称	类型	描述	示例值
	object	返回参数详情如下。
HttpStatusCode	integer	HTTP 状态码。	200
RequestId	string	请求 ID。	60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC
ErrCode	string	错误码。	Param.NotFound
Success	boolean	是否成功。	true
ErrMessage	string	错误信息。	The specified parameter %s value is not valid.
RestoreTaskId	string	恢复任务 ID。	s102h*****

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.  ",
  "RestoreTaskId": "s102h*****"
}

错误码

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

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

变更历史

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

CreateRestoreTask - 创建恢复任务

接口说明

相关操作文档

调试

授权信息

请求参数

返回参数

示例

错误码

变更历史