创建一个恢复任务。
接口说明
- 根据所选快照与恢复目的地，创建恢复任务。
- 目前数据源类型与恢复目的地数据源类型需要一致。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| hbr:CreateRestoreJob | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RestoreType | string | 是 | 恢复目的地数据源类型，取值范围：
| ECS_FILE |
| VaultId | string | 是 | 备份快照所属备份仓库 ID。 | v-********************* |
| SnapshotId | string | 是 | 备份快照 ID。 | s-******************** |
| SnapshotHash | string | 否 | 备份快照 HASH 值。 | f2fe... |
| SourceType | string | 是 | 数据源类型，取值范围：
| ECS_FILE |
| Options | string | 否 | 恢复任务参数 | {\"includes\":[],\"excludes\":[],\"conflictPolicy\":\"OVERWRITE_EXISTING\"} |
| TargetFileSystemId | string | 否 | 仅当 RestoreType 取值为 NAS 时，该参数有效。表示恢复目的地的文件系统 ID。 | 005494 |
| TargetCreateTime | long | 否 | 仅当 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 | 否 | 整机备份详情。 | {\"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 | long | 否 | 恢复的表格存储的时间。UNIX 时间，单位为秒。 | 1642496881 |
| OtsDetail | OtsTableRestoreDetail | 否 | 表格存储实例详情。 | |
| CrossAccountType | string | 否 | 跨账号备份类型。支持：
| SELF_ACCOUNT |
| CrossAccountUserId | long | 否 | 被当前账号管理的跨账号备份的原账号 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} |
返回参数
示例
正常返回示例
JSON格式
{
"Code": "200",
"Message": "successful",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Success": true,
"RestoreId": "r-*********************"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|