创建一个恢复任务。
接口说明
- 根据所选快照与恢复目的地,创建恢复任务。
- 目前数据源类型与恢复目的地数据源类型需要一致。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RestoreType | string | 是 | 恢复目的地数据源类型,取值范围:
| ECS_FILE |
VaultId | string | 是 | 备份快照所属备份仓库ID。 | v-********************* |
SnapshotId | string | 是 | 备份快照ID。 | s-******************** |
SnapshotHash | string | 否 | 备份快照HASH值。 | f2fe... |
SourceType | string | 是 | 数据源类型,取值范围:
| ECS_FILE |
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 | 否 | 整机备份详情。 | |
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 |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Message": "successful",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Success": true,
"RestoreId": "r-*********************"
}
错误码
访问错误中心查看更多错误码。