DescribeRestoreJobs2-阿里云帮助中心

Queries restore jobs that match specified criteria.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hbr:DescribeRestoreJobs2

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Pages start from 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 99. Default value: 10.	10
RestoreType	string	No	The data source type. Valid values: ECS_FILE: Restores ECS files. OSS: Restores OSS objects. NAS: Restores NAS files. COMMON_FILE_SYSTEM: Restores data to a CPFS file system. OTS_TABLE: Restores an OTS table. UDM_ECS_ROLLBACK: Restores an entire ECS instance.	ECS_FILE
Filters	array<object>	No	The filter conditions.
	object	No	A filter for querying restore jobs.
Key	string	No	The filter key. Valid values: RegionId: region ID PlanId: backup plan ID JobId: backup job ID VaultId: vault ID InstanceId: ECS instance ID Bucket: OSS bucket name FileSystemId: file system ID Status: job status CompleteTime: completion time	VaultId
Values	array	No	An array of values for the specified filter key.
	string	No	A value to match.	["v-*********************"]
Operator	string	No	The matching method. The default value is IN. Valid values: EQUAL: Equal to NOT_EQUAL: Not equal to GREATER_THAN: Greater than GREATER_THAN_OR_EQUAL: Greater than or equal to LESS_THAN: Less than LESS_THAN_OR_EQUAL: Less than or equal to BETWEEN: The value is within a specified range. The `Values` parameter must be a JSON array in the `[min, max]` format. IN: The value is in a specified set. The `Values` parameter must be an array. Note The IN operator is not supported when `Key` is CompleteTime.	IN
Edition	string	No	The edition. Valid values: `BASIC` and `STANDARD`. Default value: `STANDARD`.	STANDARD

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true
Code	string	The return code. A value of 200 indicates that the request was successful.	200
Message	string	The response message. If the request is successful, "successful" is returned. Otherwise, an error message is returned.	successful
PageNumber	integer	The page number of the returned page. Pages start from 1. Default: 1.	1
PageSize	integer	The number of entries per page. Valid values: 1 to 99. Default: 10.	1
TotalCount	integer	The total number of entries that match the query.	1
RestoreJobs	object	A container for the restore job details.
RestoreJob	array<object>	A list of restore jobs.	{'RestoreJob': []}
	array<object>	The details of a restore job.
SnapshotHash	string	The hash value of the backup snapshot.	f2fe...
Status	string	The status of the restore job. Valid values: COMPLETE: The job is complete. PARTIAL_COMPLETE: The job is partially complete. FAILED: The job failed.	COMPLETE
ErrorMessage	string	The error message for the restore job.	PARTIAL_COMPLETE
ActualItems	integer	The actual number of files restored. This parameter is returned only if SourceType is set to ECS_FILE.	6
VaultId	string	The ID of the backup vault.	v-0006******q
ActualBytes	integer	The actual amount of data restored after deduplication, in bytes.	600
UdmDetail	string	The details of the entire machine backup.	{\"doCopy\":true,\"doBackup\":false,\"instanceName\":\"instance example\",\"appConsistent\":false,\"destinationRegionId\":\"cn-shanghai\",\"enableFsFreeze\":true,\"osNameEn\":\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\",\"osName\":\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\",\"diskIdList\":[],\"backupVaultId\":\"\",\"snapshotGroup\":true,\"destinationRetention\":35,\"platform\":\"Windows Server 2012\",\"timeoutInSeconds\":60,\"backupRetention\":1,\"osType\":\"windows\",\"preScriptPath\":\"\",\"postScriptPath\":\"\",\"enableWriters\":true,\"ecsDeleted\":false}
SourceType	string	The type of the data source. Valid values: ECS_FILE: ECS files OSS: OSS objects NAS: NAS files OTS_TABLE: Tablestore tables UDM_ECS: ECS instance	ECS_FILE
Options	string	The advanced restore options. This parameter is returned only if SourceType is set to ECS_FILE. It indicates whether Volume Shadow Copy Service (VSS) was used. This feature is available only for Windows ECS instances. The `["UseVSS":true]` option indicates that VSS was used to ensure data consistency, which is useful when the source data changes during the backup process. If you use VSS, you cannot restore files from multiple directories at the same time.	{"UseVSS":false}
SourceInstanceId	string	The ID of the source instance.	i-2ze3m7ktcgw******cs
RestoreType	string	The type of the restore job.	ECS_FILE
TargetCreateTime	integer	The time when the destination file system was created. This parameter is returned only for NAS backups.	1634714531
ItemsDone	integer	The number of files that have been restored. This parameter is returned only if SourceType is set to ECS_FILE.	8
BytesTotal	integer	The total size of the data source, in bytes.	1000
Exclude	string	The paths to files that were excluded from the restore job. This parameter is returned only if SourceType is set to ECS_FILE. Each path can be up to 255 characters long.	["/var", "/proc"]
ParentId	string	The ID of the parent job.	r-0003hd2an3x4dyv0l18b
CompleteTime	integer	The time when the restore job completed. This is a UNIX timestamp in seconds.	1554347313
CreatedTime	integer	The time when the restore job was created. This is a UNIX timestamp in seconds.	1554347313
TargetBucket	string	The destination bucket. This parameter is returned only for OSS backups.	target-bucket
ClusterId	string	The ID of the client group used for the restore job.	cl-000******hp6
TargetFileSystemId	string	The ID of the destination file system. This parameter is returned only for NAS backups.	0be9****9c9
Progress	integer	The progress of the restore job, where a value of 10000 indicates 100% completion.	10000
ExpireTime	integer	The time when the restore job expires.	1634714531
TargetDataSourceId	string	The ID of the destination data source.	ds-000*****997
TargetPrefix	string	The destination prefix. This parameter is returned only for OSS backups.	"/target"
TargetPath	string	The destination path of the restore job.	"D:\\rebk"
ErrorFile	string	The list of files that failed to be restored.	"test.csv"
StartTime	integer	The time when the restore job started. This is a UNIX timestamp in seconds.	1554347313
UpdatedTime	integer	The time when the restore job was last updated. This is a UNIX timestamp in seconds.	1554347313
SnapshotId	string	The ID of the snapshot used for the restore.	s-0002******ga88
RestoreId	string	The ID of the restore job.	r-0003*****8a
TargetClientId	string	The ID of the destination client.	c-000e*****397
ItemsTotal	integer	The total number of files in the data source. This parameter is returned only if SourceType is set to ECS_FILE.	10
Include	string	The paths to the files that are included in the restore job.	["/home/alice/.pdf", "/home/bob/.txt"]
BytesDone	integer	The amount of data restored, in bytes.	800
TargetInstanceName	string	The name of the destination Tablestore instance.	instancename
TargetTableName	string	The data table in the destination Tablestore instance.	tablename
Speed	integer	The average restore speed, in KB/s.	500
TargetTime	integer	The point in time to which the Tablestore instance is restored. This is a UNIX timestamp in seconds.	1642560261
OtsDetail	object	The details of the Tablestore restore.
BatchChannelCount	integer	The number of channels processed by each Tablestore restore job.	2
OverwriteExisting	boolean	Indicates whether existing data in the destination table was overwritten.	false
CrossAccountType	string	The type of the cross-account backup. Valid values: SELF_ACCOUNT: a backup within the same account CROSS_ACCOUNT: a cross-account backup	SELF_ACCOUNT
CrossAccountUserId	integer	The ID of the Alibaba Cloud account that owns the backup data. This parameter is returned for cross-account restores.	158975xxxxxx4625
CrossAccountRoleName	string	The name of the RAM role that was assumed in the source account to perform the cross-account restore.	BackupRole
Report	object	The report of the restore job.
TotalFiles	string	The path to the list of all files for a file-based restore.	/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv
SuccessFiles	string	The path to the list of successfully restored files.	/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip
FailedFiles	string	The path to the list of files that failed to be restored.	/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip
SkippedFiles	string	The path to the list of skipped files.	/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip
ReportTaskStatus	string	The status of the report generation task.	COMPLETE
MeteringBytesDone	integer	The billable amount of restored data, in bytes. This parameter is returned only when StorageClass is set to ARCHIVE. The value is rounded up to the nearest 1 MB.	1048576
MeteringBytesTotal	integer	The total billable amount of data in the data source, in bytes. This parameter is returned only when StorageClass is set to ARCHIVE. The value is rounded up to the nearest 1 MB.	1048576
StorageClass	string	The storage class of the backup data. Valid values: STANDARD: Standard storage. ARCHIVE: Archive storage.	STANDARD
FailbackDetail	string	The details of the VMware failback job.	{"cpu":4,"extra":"{\"restoreVMNamePrefix\":\"627-\",\"dataCenterName\":\"SDDC-Datacenter\",\"dataStoreId\":\"datastore-50\",\"folderId\":\"group-v49\",\"resourcePoolId\":\"resgroup-46\",\"locationName\":\"vcenter.pc-uf600arcwi9td3eyj641.acvs.aliyuncs.com/SDDC-Datacenter/Workloads\",\"computeResourceName\":\"SDDC-Datacenter/Default_c-uf600arcwi9td3eyj640\",\"dataStoreName\":\"Default_c-uf600arcwi9td3eyj640/WorkloadDatastore\",\"networkMoReference\":\"DistributedVirtualPortgroup:dvportgroup-1001\",\"useHotAdd\":false}","instanceId":"i-2vc357i2eannmmotcagz","memoryInMB":8192,"serverId":"0fdc0c86-eb92-4e05-91ab-eeaf9fb6ad01","uefiBoot":false}
TargetInstanceId	string	The ID of the destination instance.	i-2ze3m7ktcgw******cs
SourceResourceId	string	The ID of the source resource.	i-123***7890

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 1,
  "TotalCount": 1,
  "RestoreJobs": {
    "RestoreJob": [
      {
        "SnapshotHash": "f2fe...",
        "Status": "COMPLETE",
        "ErrorMessage": "PARTIAL_COMPLETE",
        "ActualItems": 6,
        "VaultId": "v-0006******q",
        "ActualBytes": 600,
        "UdmDetail": "{\\\"doCopy\\\":true,\\\"doBackup\\\":false,\\\"instanceName\\\":\\\"instance example\\\",\\\"appConsistent\\\":false,\\\"destinationRegionId\\\":\\\"cn-shanghai\\\",\\\"enableFsFreeze\\\":true,\\\"osNameEn\\\":\\\"Windows Server  2019 Data Center Edition 64bit Chinese Edition\\\",\\\"osName\\\":\\\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\\\",\\\"diskIdList\\\":[],\\\"backupVaultId\\\":\\\"\\\",\\\"snapshotGroup\\\":true,\\\"destinationRetention\\\":35,\\\"platform\\\":\\\"Windows Server 2012\\\",\\\"timeoutInSeconds\\\":60,\\\"backupRetention\\\":1,\\\"osType\\\":\\\"windows\\\",\\\"preScriptPath\\\":\\\"\\\",\\\"postScriptPath\\\":\\\"\\\",\\\"enableWriters\\\":true,\\\"ecsDeleted\\\":false}",
        "SourceType": "ECS_FILE",
        "Options": "{\"UseVSS\":false}",
        "SourceInstanceId": "i-2ze3m7ktcgw******cs",
        "RestoreType": "ECS_FILE",
        "TargetCreateTime": 1634714531,
        "ItemsDone": 8,
        "BytesTotal": 1000,
        "Exclude": "[\"/var\", \"/proc\"]",
        "ParentId": "r-0003hd2an3x4dyv0l18b",
        "CompleteTime": 1554347313,
        "CreatedTime": 1554347313,
        "TargetBucket": "target-bucket",
        "ClusterId": "cl-000******hp6",
        "TargetFileSystemId": "0be9****9c9",
        "Progress": 10000,
        "ExpireTime": 1634714531,
        "TargetDataSourceId": "ds-000*****997",
        "TargetPrefix": "\"/target\"",
        "TargetPath": "\"D:\\\\rebk\"",
        "ErrorFile": "\"test.csv\"",
        "StartTime": 1554347313,
        "UpdatedTime": 1554347313,
        "SnapshotId": "s-0002******ga88",
        "RestoreId": "r-0003*****8a",
        "TargetClientId": "c-000e*****397",
        "ItemsTotal": 10,
        "Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
        "BytesDone": 800,
        "TargetInstanceName": "instancename",
        "TargetTableName": "tablename",
        "Speed": 500,
        "TargetTime": 1642560261,
        "OtsDetail": {
          "BatchChannelCount": 2,
          "OverwriteExisting": false
        },
        "CrossAccountType": "SELF_ACCOUNT",
        "CrossAccountUserId": 0,
        "CrossAccountRoleName": "BackupRole",
        "Report": {
          "TotalFiles": "/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv",
          "SuccessFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip\n",
          "FailedFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip",
          "SkippedFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip",
          "ReportTaskStatus": "COMPLETE"
        },
        "MeteringBytesDone": 1048576,
        "MeteringBytesTotal": 1048576,
        "StorageClass": "STANDARD",
        "FailbackDetail": "{\"cpu\":4,\"extra\":\"{\\\"restoreVMNamePrefix\\\":\\\"627-\\\",\\\"dataCenterName\\\":\\\"SDDC-Datacenter\\\",\\\"dataStoreId\\\":\\\"datastore-50\\\",\\\"folderId\\\":\\\"group-v49\\\",\\\"resourcePoolId\\\":\\\"resgroup-46\\\",\\\"locationName\\\":\\\"vcenter.pc-uf600arcwi9td3eyj641.acvs.aliyuncs.com/SDDC-Datacenter/Workloads\\\",\\\"computeResourceName\\\":\\\"SDDC-Datacenter/Default_c-uf600arcwi9td3eyj640\\\",\\\"dataStoreName\\\":\\\"Default_c-uf600arcwi9td3eyj640/WorkloadDatastore\\\",\\\"networkMoReference\\\":\\\"DistributedVirtualPortgroup:dvportgroup-1001\\\",\\\"useHotAdd\\\":false}\",\"instanceId\":\"i-2vc357i2eannmmotcagz\",\"memoryInMB\":8192,\"serverId\":\"0fdc0c86-eb92-4e05-91ab-eeaf9fb6ad01\",\"uefiBoot\":false}",
        "TargetInstanceId": "i-2ze3m7ktcgw******cs",
        "SourceResourceId": "i-123***7890"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.