Mengkueri pekerjaan pemulihan yang sesuai dengan kriteria tertentu.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
hbr:DescribeRestoreJobs2 |
get |
*全部资源
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| PageNumber |
integer |
No |
Nomor halaman. Halaman dimulai dari 1. Nilai default: 1. |
1 |
| PageSize |
integer |
No |
Jumlah entri per halaman. Nilai valid: 1 hingga 99. Nilai default: 10. |
10 |
| RestoreType |
string |
No |
Jenis sumber data. Nilai valid:
|
ECS_FILE |
| Filters |
array<object> |
No |
Kondisi filter. |
|
|
object |
No |
A filter for querying restore jobs. |
||
| Key |
string |
No |
The filter key. Valid values:
|
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:
Catatan
The IN operator is not supported when |
IN |
| Edition |
string |
No |
Edisi. Nilai valid: BASIC dan STANDARD. Nilai default: STANDARD. |
STANDARD |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| Success |
boolean |
Indicates whether the request was successful.
|
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 |
| ErrorMessage |
string |
The error message for the restore job. |
PARTIAL_COMPLETE |
| ActualItems |
integer |
The actual number of items in the restore job. This parameter is returned only when SourceType is set to ECS_FILE. |
6 |
| VaultId |
string |
The ID of the backup repository. |
v-0006******q |
| ActualBytes |
integer |
The actual amount of data that is restored after deduplication. Unit: bytes. |
600 |
| UdmDetail |
string |
The details of the entire instance 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 |
| Options |
string |
Indicates whether to use the Volume Shadow Copy Service (VSS) to define the restore path. This parameter is required only if SourceType is set to ECS_FILE.
|
{"UseVSS":false} |
| SourceInstanceId |
string |
The ID of the source instance for the restore job. |
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 restored items. This parameter is returned only when SourceType is set to ECS_FILE. |
8 |
| BytesTotal |
integer |
The total amount of data in the data source. Unit: bytes. |
1000 |
| Exclude |
string |
The path to the files that you do not want to restore. All files in the path are not restored. The value can be up to 255 characters in length. This parameter is required only if SourceType is set to ECS_FILE. |
["/var", "/proc"] |
| ParentId |
string |
The ID of the parent job. |
r-0003hd2an3x4dyv0l18b |
| CompleteTime |
integer |
The time when the restore job was completed. This value is a UNIX timestamp. Unit: seconds. |
1554347313 |
| CreatedTime |
integer |
The time when the restore job was created. This value is a UNIX timestamp. Unit: 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 that is used for the restore. |
cl-000******hp6 |
| TargetFileSystemId |
string |
The destination file system. This parameter is returned only for NAS backups. |
0be9****9c9 |
| Progress |
integer |
The restore progress. The value is calculated using the formula: 100% × 100. |
10000 |
| ExpireTime |
integer |
The time-to-live (TTL) of the restore job. |
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 value is a UNIX timestamp. Unit: seconds. |
1554347313 |
| UpdatedTime |
integer |
The time when the restore job was updated. This value is a UNIX timestamp. Unit: seconds. |
1554347313 |
| SnapshotId |
string |
The ID of the snapshot that is 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 items in the data source. This parameter is returned only when SourceType is set to ECS_FILE. |
10 |
| Include |
string |
The restore paths that are included in the restore job. |
["/home/alice/*.pdf", "/home/bob/*.txt"] |
| BytesDone |
integer |
The amount of restored data. Unit: bytes. |
800 |
| TargetInstanceName |
string |
The name of the destination Tablestore instance for the backup. |
instancename |
| TargetTableName |
string |
The data table in the destination Tablestore instance for the backup. |
tablename |
| Speed |
integer |
The actual average backup speed. Unit: KB/s. |
500 |
| TargetTime |
integer |
The time of the destination Tablestore instance for the backup. This value is a UNIX timestamp. Unit: seconds. |
1642560261 |
| OtsDetail |
object |
The details of the Tablestore instance. |
|
| BatchChannelCount |
integer |
The number of channels that are processed by each Tablestore restore job. |
2 |
| OverwriteExisting |
boolean |
Indicates whether to overwrite an existing Tablestore restore job. |
false |
| CrossAccountType |
string |
The type of the cross-account backup. Valid values:
|
SELF_ACCOUNT |
| CrossAccountUserId |
integer |
The ID of the source account for the cross-account backup that is managed by the current account. |
158975xxxxxx4625 |
| CrossAccountRoleName |
string |
The name of the RAM role that is created in the source account for the cross-account backup and is managed by the current account. |
BackupRole |
| Report |
object |
The report of the restore job. |
|
| TotalFiles |
string |
All files that are restored based on the file list. |
/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv |
| SuccessFiles |
string |
The list of files that were successfully processed. |
/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip |
| FailedFiles |
string |
The list of files that failed to be processed. |
/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip |
| SkippedFiles |
string |
The list of skipped files. |
/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip |
| ReportTaskStatus |
string |
The status of report generation. |
COMPLETE |
| MeteringBytesDone |
integer |
The amount of restored data. Unit: bytes. This parameter is valid only when StorageClass is set to ARCHIVE. The value is rounded up to the nearest 1 MB. |
1048576 |
| MeteringBytesTotal |
integer |
The total amount of data in the data source. Unit: bytes. This parameter is valid 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 |
| FailbackDetail |
string |
The details of the VMware failback task. |
{"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 for the restore job. |
i-2ze3m7ktcgw******cs |
| SourceResourceId |
string |
i-123***7890 |
Contoh
Respons sukses
JSONformat
{
"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"
}
]
}
}Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.