Queries the details about a restoration task.

If the data on your servers is encrypted by ransomware, you can create a restoration task to restore the data on your servers by using backup data in Security Center.

Note After you enable an anti-ransomware policy, the data on your servers is backed up based on the policy. For more information about anti-ransomware policies, see Manage protection policies.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeRestoreJobs

The operation that you want to perform. Set the value to DescribeRestoreJobs.

Status String No RUNNING

The status of the restoration task. Valid values:

  • RUNNING: The task is running.
  • COMPLETE: The task is complete.
  • FAILED: The task fails.
  • CANCELING: The task is being canceled.
  • CANCELED: The task is canceled.
  • PARTIAL_COMPLETE: The task is partially successful.
  • CREATED: The task was created but is not run.
  • EXPIRED: The task is not updated.
  • QUEUED: The task is waiting to be run.
  • CLIENT_DELETED: The task fails because the anti-ransomware agent is uninstalled.
MachineRemark String No 1.1.XX.XX

The unique identifier of the server on which the restoration task is run. For example, you can use the IP address or the name of the server.

PageSize Integer Yes 10

The number of entries to return on each page. Default value: 10.

CurrentPage Integer Yes 1

The number of the page to return. Default value: 1.

Response parameters

Parameter Type Example Description
RequestId String 0ED92280-4363-57D3-A4D3-4D3FBC99B29F

The ID of the request, which is used to locate and troubleshoot issues.

PageInfo Object

The pagination information.

CurrentPage Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page. Default value: 10.

TotalCount Integer 69

The total number of restoration tasks returned.

Count Integer 2

The number of restoration tasks returned on the current page.

RestoreJobs Array of RestoreJob

The details about the restoration task.

Status String COMPLETE

The status of the restoration task. Valid values:

  • RUNNING: The task is running.
  • COMPLETE: The task is complete.
  • FAILED: The task fails.
  • CANCELING: The task is being canceled.
  • CANCELED: The task is canceled.
  • PARTIAL_COMPLETE: The task is partially successful.
  • CREATED: The task was created but is not run.
  • EXPIRED: The task is not updated.
  • QUEUED: The task is waiting to be run.
  • CLIENT_DELETED: The task fails because the anti-ransomware agent is uninstalled.
SnapshotHash String a3992de83f529b844135fe795d949181735a7d20e0ac8539485c61b7983e618f

The hash value of the backup data.

SourceClientId String c-000gmcypy5dyf9ey3uv7

The ID of the anti-ransomware agent that is used to back up data.

ErrorFileUrl String ["/home/user"]

The URL of the CSV file that contains the files failed to be restored.

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

The directory included in the file that is restored. This parameter is specified when you create the anti-ransomware policy. The value is a directory that requires protection.

RestoreName String Restore

The name of the restoration task.

InternetIp String 1.1.XX.XX

The public IP address of the server whose data is stored.

VaultId String v-000b0v0jqzmse2yz06zw

The ID of the repository in which the backup data is stored.

ActualBytes Long 20

The size of data that is restored. Unit: bytes.

Message String successful

The returned error code.

Percentage Integer 100

The progress of the restoration task in percentage.

GmtModified String 2021-04-25T19:11Z

The time when the restoration task is updated.

RestoreType String ECS_FILE

The type of the file that is restored. Valid values:

  • ECS_FILE: files on Elastic Compute Service (ECS) instances
  • FILE: files on servers in data centers
ExitCode String 0

The return value of the restoration task.

ClientId String c-000frxwusjauhp9ajpu6

The ID of the anti-ransomware agent.

ItemsDone Long 0

The number of files that are backed up.

BytesTotal Long 20

The total size of data that you want to restore. Unit: bytes.

RequestId String 0ED92280-4363-57D3-A4D3-4D3FBC99B29F

The ID of the request, which is used to locate and troubleshoot issues.

InstanceName String win2012-01

The name of the server whose data you want to restore.

CompleteTime Long 1583289054000

The timestamp when the restoration task is complete. Unit: milliseconds.

ErrorType String NONE

The error code that is returned for the restoration task.

SnapshotVersion String 2020-03-03 18:00

The version of the backup file.

Target String /home

The folder in which the backup data is stored. After you create the restoration task, the backup data is restored to the specified folder.

CreatedTime Long 1583289052000

The timestamp when the restoration task is created. Unit: milliseconds.

InstanceId String i-bp12xnvdax6307gw****

The ID of the server whose data you want to restore.

Source String ["/home/admin","\\\\servername\\sharename"]

The path to the file that you want to back up.

IntranetIp String 2.1.XX.XX

The internal IP address of the server whose data you want to restore.

ErrorFile String s-000f4wxm8f7gur6g2otm.csv

The name of the CSV file that contains the files failed to be restored.

Uuid String 6E3DABB6-3F6A-40DB-9492-2C8B59C****

The UUID of the server whose data you want to restore.

Excludes String ["/home/user"]

The directory excluded from the file that is restored. This parameter is specified when you create the anti-ransomware policy. The value is a directory that does not require protection.

Speed Long 25766558

The speed of data backup. Unit: byte/s.

SnapshotId String s-000gmcypy5dy54e39yny

The hash value ID of the backup data.

UpdatedTime Long 1583289054000

The timestamp when the restoration task was last updated. Unit: milliseconds.

RestoreId String r-000gmcypy5dyf9ey3uv7

The ID of the restoration task.

GmtCreate String 2021-04-25T19:11Z

The time when the restoration task is created.

Eta Long 1583299054

The timestamp when the in-progress restoration task is expected to be complete. Unit: seconds.

Duration Long 100

The duration of the restoration task. Unit: seconds.

ErrorCount Long 0

The number of the restoration tasks on which errors occur.

ItemsTotal Long 0

The total number of files that you want to back up.

BytesDone Long 20

The total size of data that is restored. Unit: bytes.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeRestoreJobs
&Status=RUNNING
&MachineRemark=1.1.XX.XX
&PageSize=10
&CurrentPage=1
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/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
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.