AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云备份 开发参考 API参考 API目录 恢复任务 CreateRestoreJob - 创建恢复任务

CreateRestoreJob - 创建恢复任务

更新时间：
产品详情
我的收藏

创建一个恢复任务。

接口说明

  • 根据所选快照与恢复目的地，创建恢复任务。

  • 目前数据源类型与恢复目的地数据源类型需要一致。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hbr:CreateRestoreJob

create

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
RestoreType

string

是

恢复目的地数据源类型，取值范围：

  • ECS_FILE：恢复到 ECS 文件。

  • OSS：恢复到阿里云 OSS。

  • NAS：恢复到阿里云 NAS。

  • OTS_TABLE：恢复到阿里云 OTS。

  • UDM_ECS_ROLLBACK：恢复到阿里云 ECS 整机。

ECS_FILE
VaultId

string

否

备份快照所属备份仓库 ID。

v-*********************
SnapshotId

string

否

备份快照 ID。

s-********************
SnapshotHash

string

否

备份快照 HASH 值。

f2fe...
SourceType

string

是

数据源类型，取值范围：

  • ECS_FILE：恢复 ECS 文件。

  • OSS：恢复阿里云 OSS。

  • NAS：恢复阿里云 NAS。

  • OTS_TABLE：恢复到阿里云 OTS。

  • UDM_ECS：恢复到阿里云 ECS 整机。

ECS_FILE
Options

string

否

恢复任务参数

{\"includes\":[],\"excludes\":[],\"conflictPolicy\":\"OVERWRITE_EXISTING\"}
TargetFileSystemId

string

否

仅当 RestoreType 取值为 NAS 时，该参数有效。表示恢复目的地的文件系统 ID。

005494
TargetCreateTime

integer

否

仅当 RestoreType 取值为 NAS 时，该参数有效。表示恢复目的地的文件系统创建时间。

1554347313
TargetPath

string

否

仅当 RestoreType 取值为ECS_FILE时，该参数有效。表示恢复目的地的文件路径。

C:\
TargetBucket

string

否

仅当 RestoreType 取值为 OSS 时，该参数有效。表示恢复目的地的 OSS bucket 名称。

hbr-backup-oss
TargetPrefix

string

否

仅当 RestoreType 取值为 OSS 时，该参数有效。表示恢复目的地的对象前缀。

hbr
UdmDetail

object

否

仅当 SourceType 取值为 UDM_ECS 时，该参数有效。表示整机备份详情。该参数为 JSON 字符串，根据 RestoreType 取值不同，该参数需传入的详情信息如下：

  • UDM_ECS_DISK: ECS 云盘克隆。

    • targetInstanceId: string 类型，必填，表示克隆出来的云盘需要挂载的目标 ECS 实例 ID。

    • diskCategory: string 类型，必填，表示目标云盘类型。

    • diskPerformanceLevel: string 类型，当 diskCategory=essd 时，表示云盘性能等级，支持 PL0、PL1、PL2 和 PL3，默认 PL1。

  • UDM_ECS_DISK_ROLLBACK: ECS 云盘恢复。

    • sourceInstanceId: string 类型，必填，表示源 ECS 实例 ID。

    • foreceRestore: bool 类型，默认值为 false，表示是否强制恢复。当 foreceRestore=true 时，如果备份的云盘已经从原 ECS 实例卸载，或挂载到新的 ECS 实例，恢复任务仍然会进行云盘恢复，请谨慎操作。

    • bootAfterRestore: bool 类型，默认值为 false，表示恢复后是否启动 ECS 实例。

  • UDM_ECS: ECS 整机克隆。

    • bootAfterRestore: bool 类型，默认值为 false，表示恢复后是否启动 ECS 实例。

    • diskCategory: string 类型，必填，表示目标云盘类型。

    • diskPerformanceLevel: string 类型，当 diskCategory=essd 时，表示云盘性能等级，支持 PL0、PL1、PL2 和 PL3，默认 PL1。

    • instanceType: string 类型，必填，表示目标 ECS 实例规格。

    • restoredNetwork: string 类型，必填，表示目标 ECS 实例的虚拟交换机 ID。

    • securityGroup: string 类型，必填，表示目标 ECS 实例的安全组 ID。

    • restoredName: string 类型，必填，表示目标 ECS 实例的实例名称。

    • restoredHostName: string 类型，必填，表示目标 ECS 实例的主机名称。

    • allocatePublicIp: bool 类型，默认值为 false，表示目标 ECS 实例是否分配公网 IP。

    • privateIpAddress: string 类型，表示目标 ECS 实例的内网 IP，如果未指定，将使用 DHCP 随机分配。

  • UDM_ECS_ROLLBACK: ECS 整机恢复。

    • sourceInstanceId: string 类型，必填，表示源 ECS 实例 ID。

    • forceRestore: bool 类型，默认值为 false，表示是否强制恢复。当 foreceRestore=true 时，如果备份的云盘已经从原 ECS 实例卸载，或挂载到新的 ECS 实例，恢复任务仍然会进行云盘恢复，请谨慎操作。

    • bootAfterRestore: bool 类型，默认值为 false，表示恢复后是否启动 ECS 实例。

{\"sourceInstanceId\":\"i-uf62te6pm3iwsyxyz66q\",\"bootAfterRestore\":false}
UdmRegionId

string

否

仅当 SourceType 取值为UDM_ECS时，该参数有效。表示恢复的目标地域。

cn-shanghai
TargetInstanceId

string

否

仅当 RestoreType 取值为ECS_FILE时，该参数有效。表示恢复目的地的 ECS 实例 ID。

i-*********************
Include

string

否

恢复的路径。该路径下所有文档都会被恢复。最多 255 个字符。

["/home/alice/*.pdf", "/home/bob/*.txt"]
Exclude

string

否

不做恢复的路径。该路径下所有文档都不会被恢复。最多 255 个字符。

["/var", "/proc"]
TargetContainer

string

否

恢复的目标容器详情。

{\"host\":\"k8s-node1\",\"hostPrefix\":\"/var/lib/kubelet/pods/4acb31fe-8577-40ff-bc8c-eccabd835f73/volumes/kubernetes.io~csi/pvc-b050b00e-ef17-4792-aab1-1642355cf1f4/mount\",\"pvPath\":\"/\"}
InitiatedByAck

boolean

否

是否由容器服务调用。默认为 false。

false
TargetContainerClusterId

string

否

恢复的目标容器集群 ID。

cc-000amjsc7o1h9506oob7
TargetInstanceName

string

否

恢复的目标表格存储实例名称。

instancename
TargetTableName

string

否

恢复的目标表格存储的数据表名称。

tablename
TargetTime

integer

否

恢复的表格存储的时间。UNIX 时间，单位为秒。

1642496881
OtsDetail OtsTableRestoreDetail

否

表格存储实例详情。

CrossAccountType

string

否

跨账号备份类型。支持：

  • SELF_ACCOUNT：本账号备份

  • CROSS_ACCOUNT：跨账号备份

SELF_ACCOUNT
CrossAccountUserId

integer

否

被当前账号管理的跨账号备份的原账号 ID。

158975xxxxx4625
CrossAccountRoleName

string

否

被当前账号管理的跨账号备份的原账号 RAM 中创建的角色名。

BackupRole
FailbackDetail

object

否

恢复至本地的详细信息。

{"cpu":4,"extra":"{\"restoreVMNamePrefix\":\"627-\",\"dataCenterName\":\"SDDC-Datacenter\",\"dataStoreId\":\"datastore-50\",\"folderId\":\"group-v49\",\"resourcePoolId\":\"resgroup-46\",\"locationName\":\"vcenter.pc-uf600a******1.acvs.aliyuncs.com/SDDC-Datacenter/Workloads\",\"computeResourceName\":\"SDDC-Datacenter/Default_c-uf600a******\",\"dataStoreName\":\"Default_c-uf600a******/WorkloadDatastore\",\"networkMoReference\":\"DistributedVirtualPortgroup:dvportgroup-1001\",\"useHotAdd\":false}","instanceId":"i-2vc******z","memoryInMB":8192,"serverId":"0fdc0c86-eb92-4e05-91ab-eeaf9fb6ad01","uefiBoot":false}
Edition

string

否

云备份功能版本，支持：

  • STANDARD: 标准版，默认值。

  • BASIC：基础版。目前仅支持 ECS 文件备份基础版。

STANDARD

返回参数

名称

类型

描述

示例值

object

Code

string

返回码，200 表示成功。

200
Message

string

返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。

successful
RequestId

string

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success

boolean

请求是否成功。

  • true：成功

  • false：失败

true
RestoreId

string

恢复任务 ID。

r-*********************

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "RestoreId": "r-*********************"
}

错误码

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

变更历史

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

上一篇：恢复任务下一篇：CancelRestoreJob - 取消恢复任务