调用CreateRestoreJob创建一个恢复任务。

接口说明

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateRestoreJob

系统规定参数。取值:CreateRestoreJob

RestoreType String ECS_FILE

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

  • ECS_FILE:表示恢复到ECS文件。
  • OSS:表示恢复到阿里云OSS。
  • NAS:表示恢复到阿里云NAS。
SnapshotHash String f2fe...

备份快照HASH值。

SnapshotId String s-********************

备份快照ID。

SourceType String ECS_FILE

数据源类型,取值范围:

  • ECS_FILE:表示恢复ECS文件。
  • OSS:表示恢复阿里云OSS。
  • NAS:表示恢复阿里云NAS。
VaultId String v-*********************

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

TargetFileSystemId String 005494

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

TargetCreateTime Long 1554347313

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

TargetPath String C:\

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

TargetBucket String hbr-backup-oss

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

TargetPrefix String hbr

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

TargetInstanceId String i-*********************

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

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

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

Exclude String ["/var", "/proc"]

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

返回数据

名称 类型 示例值 描述
Code String 200

返回码,200表示成功。

Message String successful

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

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

RestoreId String r-*********************

恢复任务ID。

Success Boolean true

请求是否成功。

  • true表示成功。
  • false表示失败。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateRestoreJob
&RestoreType=ECS_FILE
&SnapshotHash=f2fe...
&SnapshotId=s-********************
&SourceType=ECS_FILE
&VaultId=v-*********************
&<公共请求参数>

正常返回示例

XML格式

<CreateRestoreJobResponse>
  <Message>successful</Message>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  <RestoreId>r-*********************</RestoreId>
  <Code>200</Code>
  <Success>true</Success>
</CreateRestoreJobResponse>

JSON格式

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

错误码

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