文档

DescribeRestoreJobs - 查询防勒索恢复任务的详情

更新时间:

查询防勒索恢复任务(即数据备份)的详情。

接口说明

如果您的服务器数据已被勒索病毒入侵,云安全中心通过执行恢复任务,使用备份数据来恢复当前服务器的数据。

说明 您启用防勒索防护策略时,防勒索功能会备份您的服务器数据。关于防勒索防护策略的介绍,请参见管理防护策略

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

恢复状态。 取值:

  • RUNNING:恢复任务执行中
  • COMPLETE:恢复任务已完成
  • FAILED:恢复任务执行失败
  • CANCELING:恢复任务取消中
  • CANCELED:恢复任务已取消
  • PARTIAL_COMPLETE:恢复任务部分成功
  • CREATED:恢复任务已创建,但尚未开始启动
  • EXPIRED:恢复任务未更新
  • QUEUED:恢复任务在等待启动中
  • CLIENT_DELETED:防勒索客户端已被删除,任务执行失败
RUNNING
MachineRemarkstring

执行防勒索恢复任务的服务器的标识符,例如:服务器 IP 地址或服务器名称。

1.1.XX.XX
PageSizeinteger

设置分页查询时,每页显示的恢复任务的数量。默认值为 10,表示每页显示 10 条恢复任务。

10
CurrentPageinteger

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

0ED92280-4363-57D3-A4D3-4D3FBC99B29F
PageInfoobject

页面上显示的查询结果信息。

CurrentPageinteger

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,每页显示的恢复任务的数量。默认值为 10,表示每页显示 10 条恢复任务。

10
TotalCountinteger

查询到的恢复任务的总数量。

69
Countinteger

查询到的当前结果页面中恢复任务的条数。

2
RestoreJobsarray<object>

恢复任务的详细信息。

object
Statusstring

数据备份的状态。 取值:

  • RUNNING:恢复任务执行中

  • COMPLETE:恢复任务已完成

  • FAILED:恢复任务执行失败

  • CANCELING:恢复任务取消中

  • CANCELED:恢复任务已取消

  • PARTIAL_COMPLETE:恢复任务部分成功

  • CREATED:恢复任务已创建,但尚未开始启动

  • EXPIRED:恢复任务未更新

  • QUEUED:恢复任务在等待启动中

  • CLIENT_DELETED:防勒索客户端已被删除,任务执行失败

COMPLETE
SnapshotHashstring

备份服务器数据时,存储备份数据的快照 Hash 值。

a3992de83f529b844135fe795d949181735a7d20e0ac8539485c61b7983e618f
SourceClientIdstring

生成备份数据的防勒索客户端的 ID。

c-000gmcypy5dyf9ey3uv7
ErrorFileUrlstring

恢复任务失败的 CSV 文件下载的 URL。

["/home/user"]
Includesstring

恢复文件原所在的目录。该目录是在创建防勒索防护策略时指定的,即需要防护的目录。

["/root/disk-uuid-test","/root/install.sh"]
RestoreNamestring

恢复任务的名称。

Restore
InternetIpstring

恢复数据的服务器的公网 IP 地址。

1.1.XX.XX
VaultIdstring

备份数据存入的仓库的 ID。

v-000b0v0jqzmse2yz06zw
ActualByteslong

备份文件的大小,单位为 Bytes。

20
Messagestring

错误码消息。

successful
Percentageinteger

恢复任务的进度百分比。

100
GmtModifiedstring

恢复任务更新的时间。

2021-04-25T19:11Z
RestoreTypestring

恢复文件的类型。取值:

  • ECS_FILE:来自云服务器 ECS 的文件

  • FILE:来自本地主机文件

ECS_FILE
ExitCodestring

恢复任务的返回值。

0
ClientIdstring

恢复任务客户端的 ID。

c-000frxwusjauhp9ajpu6
ItemsDonelong

成功恢复的文件的数量。

0
BytesTotallong

需要恢复的数据总量,单位为 Bytes。

20
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

0ED92280-4363-57D3-A4D3-4D3FBC99B29F
InstanceNamestring

需要恢复数据的服务器的名称。

win2012-01
CompleteTimelong

恢复任务的完成时间戳,单位为毫秒。

1583289054000
ErrorTypestring

恢复任务的错误码。

NONE
SnapshotVersionstring

服务器数据的恢复版本(即备份版本)。

2020-03-03 18:00
Targetstring

备份数据存储的目标文件夹。创建恢复任务后,备份数据会恢复至该文件夹中。

/home
CreatedTimelong

恢复任务的创建时间戳,单位为毫秒。

1583289052000
InstanceIdstring

需要恢复数据的服务器的实例 ID。

i-bp12xnvdax6307gw****
Sourcestring

恢复内容。

["/home/admin","\\\\servername\\sharename"]
IntranetIpstring

需要恢复数据的服务器的内网 IP 地址。

2.1.XX.XX
ErrorFilestring

恢复失败的文件列表的 CSV 文件名称。

s-000f4wxm8f7gur6g2otm.csv
Uuidstring

需要恢复备份数据的服务器的 UUID。

6E3DABB6-3F6A-40DB-9492-2C8B59C****
Excludesstring

恢复文件中所排除的目录。该目录是在创建防勒索防护策略时指定的,即无需防护的目录。

["/home/user"]
Speedlong

数据恢复的速度,单位为 Byte/s。

25766558
SnapshotIdstring

备份服务器数据时,存储备份数据的快照 Hash 值 ID。

s-000gmcypy5dy54e39yny
UpdatedTimelong

备份任务最后更新的时间戳,单位为毫秒。

1583289054000
RestoreIdstring

恢复任务的 ID。

r-000gmcypy5dyf9ey3uv7
GmtCreatestring

恢复任务创建的时间。

2021-04-25T19:11Z
Etalong

进行中的恢复任务的预计完成时间戳,单位为秒。

1583299054
Durationlong

恢复任务的持续时间,单位为秒。

100
ErrorCountlong

报错的恢复任务的数量。

0
ItemsTotallong

需要恢复的文件的总数量。

0
BytesDonelong

成功恢复的数据总量,单位为 Bytes。

20
VaultRegionIdstring

备份仓库所属的地域 ID。

cn-hangzhou

示例

正常返回示例

JSON格式

{
  "RequestId": "0ED92280-4363-57D3-A4D3-4D3FBC99B29F",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalCount": 69,
    "Count": 2
  },
  "RestoreJobs": [
    {
      "Status": "COMPLETE",
      "SnapshotHash": "a3992de83f529b844135fe795d949181735a7d20e0ac8539485c61b7983e618f",
      "SourceClientId": "c-000gmcypy5dyf9ey3uv7",
      "ErrorFileUrl": "[\"/home/user\"]",
      "Includes": "[\"/root/disk-uuid-test\",\"/root/install.sh\"]",
      "RestoreName": "Restore",
      "InternetIp": "1.1.XX.XX",
      "VaultId": "v-000b0v0jqzmse2yz06zw",
      "ActualBytes": 20,
      "Message": "successful",
      "Percentage": 100,
      "GmtModified": "2021-04-25T19:11Z",
      "RestoreType": "ECS_FILE",
      "ExitCode": "0",
      "ClientId": "c-000frxwusjauhp9ajpu6",
      "ItemsDone": 0,
      "BytesTotal": 20,
      "RequestId": "0ED92280-4363-57D3-A4D3-4D3FBC99B29F",
      "InstanceName": "win2012-01",
      "CompleteTime": 1583289054000,
      "ErrorType": "NONE",
      "SnapshotVersion": "2020-03-03 18:00",
      "Target": "/home",
      "CreatedTime": 1583289052000,
      "InstanceId": "i-bp12xnvdax6307gw****",
      "Source": "[\"/home/admin\",\"\\\\\\\\servername\\\\sharename\"]",
      "IntranetIp": "2.1.XX.XX",
      "ErrorFile": "s-000f4wxm8f7gur6g2otm.csv",
      "Uuid": "6E3DABB6-3F6A-40DB-9492-2C8B59C****",
      "Excludes": "[\"/home/user\"]",
      "Speed": 25766558,
      "SnapshotId": "s-000gmcypy5dy54e39yny",
      "UpdatedTime": 1583289054000,
      "RestoreId": "r-000gmcypy5dyf9ey3uv7",
      "GmtCreate": "2021-04-25T19:11Z",
      "Eta": 1583299054,
      "Duration": 100,
      "ErrorCount": 0,
      "ItemsTotal": 0,
      "BytesDone": 20,
      "VaultRegionId": "cn-hangzhou"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

变更时间变更内容概要操作
2023-12-06OpenAPI 返回结构发生变更查看变更详情