DescribeRestoreJobs - Security Center - Alibaba Cloud Documentation Center

Queries the details about restoration tasks.

Operation description

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeRestoreJobs	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Status	string	No	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 is 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.	RUNNING
MachineRemark	string	No	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.	1.1.XX.XX
PageSize	integer	Yes	The number of entries to return on each page. Default value: 10.	10
CurrentPage	integer	Yes	The number of the page to return. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	0ED92280-4363-57D3-A4D3-4D3FBC99B29F
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page. Default value: 10.	10
TotalCount	integer	The total number of restoration tasks returned.	69
Count	integer	The number of restoration tasks returned on the current page.	2
RestoreJobs	array<object>	The details about the restoration tasks.
RestoreJob	object
Status	string	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.	COMPLETE
SnapshotHash	string	The hash value of the snapshot that stores backup data when the data is backed up.	a3992de83f529b844135fe795d949181735a7d20e0ac8539485c61b7983e618f
SourceClientId	string	The ID of the anti-ransomware agent that is used to back up data.	c-000gmcypy5dyf9ey3uv7
ErrorFileUrl	string	The URL to download the CSV file. The CSV file contains the files that fail to be restored.	["/home/user"]
Includes	string	The directory in which the restored file is stored. The value is the directory that you specify for protection when you create the anti-ransomware policy	["/root/disk-uuid-test","/root/install.sh"]
RestoreName	string	The name of the restoration task.	Restore
InternetIp	string	The public IP address of the server whose data you want to restore.	1.1.XX.XX
VaultId	string	The ID of the backup vault in which the backup data is stored.	v-000b0v0jqzmse2yz06zw
ActualBytes	long	The size of backup data. Unit: bytes.	20
Message	string	The error message.	successful
Percentage	integer	The progress of the restoration task in percentage.	100
GmtModified	string	The time when the restoration task is updated.	2021-04-25T19:11Z
RestoreType	string	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	ECS_FILE
ExitCode	string	The return value of the restoration task.	0
ClientId	string	The ID of the anti-ransomware agent that is used to perform the restoration task.	c-000frxwusjauhp9ajpu6
ItemsDone	long	The number of files that are restored.	0
BytesTotal	long	The total size of data that you want to restore. Unit: bytes.	20
RequestId	string	The request ID.	0ED92280-4363-57D3-A4D3-4D3FBC99B29F
InstanceName	string	The name of the server whose data you want to restore.	win2012-01
CompleteTime	long	The timestamp when the restoration task is complete. Unit: milliseconds.	1583289054000
ErrorType	string	The error code that is returned for the restoration task.	NONE
SnapshotVersion	string	The version of the backup data.	2020-03-03 18:00
Target	string	The folder to which the backup data is restored. After you create the restoration task, the backup data is restored to the specified folder.	/home
CreatedTime	long	The timestamp when the restoration task is created. Unit: milliseconds.	1583289052000
InstanceId	string	The ID of the server whose data you want to restore.	i-bp12xnvdax6307gw****
Source	string	The restored content.	["/home/admin","\\\\servername\\sharename"]
IntranetIp	string	The internal IP address of the server whose data you want to restore.	2.1.XX.XX
ErrorFile	string	The name of the CSV file. The CSV file contains the files that fail to be restored.	s-000f4wxm8f7gur6g2otm.csv
Uuid	string	The UUID of the server whose data you want to restore.	6E3DABB6-3F6A-40DB-9492-2C8B59C****
Excludes	string	The directory excluded from the anti-ransomware policy. The value is the directory that you specify to skip protection when you create the anti-ransomware policy.	["/home/user"]
Speed	long	The speed at which data is restored. Unit: byte/s.	25766558
SnapshotId	string	The hash value ID of the snapshot that stores backup data when the data is backed up.	s-000gmcypy5dy54e39yny
UpdatedTime	long	The timestamp when the restoration task was last updated. Unit: milliseconds.	1583289054000
RestoreId	string	The ID of the restoration task.	r-000gmcypy5dyf9ey3uv7
GmtCreate	string	The time when the restoration task is created.	2021-04-25T19:11Z
Eta	long	The timestamp when the in-progress restoration task is expected to be complete. Unit: seconds.	1583299054
Duration	long	The duration of the restoration task. Unit: seconds.	100
ErrorCount	long	The number of the restoration tasks on which errors occur.	0
ItemsTotal	long	The total number of files that need to be restored.	0
BytesDone	long	The total size of data that is restored. Unit: bytes.	20
VaultRegionId	string	The ID of the region where the backup vault resides.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-12-06	The response structure of the API has changed	View Change Details