CreateRestoreJob - 创建恢复任务

更新时间:2025-03-21 02:25

创建一个恢复任务。

接口说明

  • 根据所选快照与恢复目的地,创建恢复任务。
  • 目前数据源类型与恢复目的地数据源类型需要一致。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
RestoreTypestring

恢复目的地数据源类型,取值范围:

  • ECS_FILE:恢复到 ECS 文件。
  • OSS:恢复到阿里云 OSS。
  • NAS:恢复到阿里云 NAS。
  • OTS_TABLE:恢复到阿里云 OTS。
  • UDM_ECS_ROLLBACK:恢复到阿里云 ECS 整机。
ECS_FILE
VaultIdstring

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

v-*********************
SnapshotIdstring

备份快照 ID。

s-********************
SnapshotHashstring

备份快照 HASH 值。

f2fe...
SourceTypestring

数据源类型,取值范围:

  • ECS_FILE:恢复 ECS 文件。
  • OSS:恢复阿里云 OSS。
  • NAS:恢复阿里云 NAS。
  • OTS_TABLE:恢复到阿里云 OTS。
  • UDM_ECS:恢复到阿里云 ECS 整机。
ECS_FILE
Optionsstring

恢复任务参数

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

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

005494
TargetCreateTimelong

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

1554347313
TargetPathstring

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

C:\
TargetBucketstring

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

hbr-backup-oss
TargetPrefixstring

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

hbr
UdmDetailobject

仅当 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}
UdmRegionIdstring

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

cn-shanghai
TargetInstanceIdstring

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

i-*********************
Includestring

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

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

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

["/var", "/proc"]
TargetContainerstring

恢复的目标容器详情。

{\"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\":\"/\"}
InitiatedByAckboolean

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

false
TargetContainerClusterIdstring

恢复的目标容器集群 ID。

cc-000amjsc7o1h9506oob7
TargetInstanceNamestring

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

instancename
TargetTableNamestring

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

tablename
TargetTimelong

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

1642496881
OtsDetailOtsTableRestoreDetail

表格存储实例详情。

CrossAccountTypestring

跨账号备份类型。支持:

  • SELF_ACCOUNT:本账号备份
  • CROSS_ACCOUNT:跨账号备份
SELF_ACCOUNT
CrossAccountUserIdlong

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

158975xxxxx4625
CrossAccountRoleNamestring

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

BackupRole
FailbackDetailobject

恢复至本地的详细信息。

{"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}

返回参数

名称类型描述示例值
名称类型描述示例值
object
Codestring

返回码,200 表示成功。

200
Messagestring

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

successful
RequestIdstring

请求 ID。

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

请求是否成功。

  • true:成功
  • false:失败
true
RestoreIdstring

恢复任务 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
  • 接口说明
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
文档反馈
phone 联系我们

立即和Alibaba Cloud在线服务人员进行交谈,获取您想了解的产品信息以及最新折扣。

alicare alicarealicarealicare