查詢一個或者多個合格恢複任務。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
hbr:DescribeRestoreJobs2 |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| PageNumber |
integer |
否 |
分頁頁碼，從 1 開始，預設值為 1。 |
1 |
| PageSize |
integer |
否 |
分頁大小，最小值為 1，最大值為 99，預設值為 10。 |
10 |
| RestoreType |
string |
否 |
資料來源類型，取值範圍：
|
ECS_FILE |
| Filters |
array<object> |
否 |
查詢過濾器中的索引值。 |
|
|
object |
否 |
查詢過濾器中的索引值。 |
||
| Key |
string |
否 |
查詢過濾器中的索引值。取值包括：
|
VaultId |
| Values |
array |
否 |
查詢過濾器中的待匹配的值。 |
|
|
string |
否 |
查詢過濾器中的待匹配的值。 |
["v-*********************"] |
|
| Operator |
string |
否 |
匹配方式。預設為 IN。即過濾器中 Key 和 Value 支援的匹配操作（Operator）方式，取值可包括：
說明
當使用 CompleteTime 作為 Key 查詢時，暫時不支援 IN 操作。 |
IN |
| Edition |
string |
否 |
版本類型，支援 BASIC 和 STANDARD，預設值為 STANDARD。 |
STANDARD |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| Success |
boolean |
請求是否成功。
|
true |
| Code |
string |
返回碼，200 表示成功。 |
200 |
| Message |
string |
返回資訊描述，成功一般返回 successful，錯誤時會返回相應錯誤資訊。 |
successful |
| PageNumber |
integer |
分頁頁碼，從 1 開始，預設值為 1。 |
1 |
| PageSize |
integer |
分頁大小，最小值為 1，最大值為 99，預設值為 10。 |
1 |
| TotalCount |
integer |
總記錄數。 |
1 |
| RestoreJobs |
object |
||
| RestoreJob |
array<object> |
恢複任務詳情。 |
{'RestoreJob': []} |
|
array<object> |
恢複任務詳情。 |
||
| SnapshotHash |
string |
備份快照 HASH 值。 |
f2fe... |
| Status |
string |
恢複任務狀態。取值範圍：
|
COMPLETE |
| ErrorMessage |
string |
恢複任務的錯誤資訊。 |
PARTIAL_COMPLETE |
| ActualItems |
integer |
僅當 SourceType 取值為ECS_FILE時，該參數有效。表示恢複任務實際專案數。 |
6 |
| VaultId |
string |
備份倉庫 ID。 |
v-0006******q |
| ActualBytes |
integer |
去除重複後恢複任務實際資料量。單位為位元組。 |
600 |
| UdmDetail |
string |
整機備份詳情。 |
{\"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 |
資料來源類型，取值範圍：
|
ECS_FILE |
| Options |
string |
僅當 SourceType 取值為ECS_FILE時，需要配置該參數。表示是否使用 Windows 系統 VSS 定義復原路徑。
|
{"UseVSS":false} |
| SourceInstanceId |
string |
恢複任務源端執行個體 ID。 |
i-2ze3m7ktcgw******cs |
| RestoreType |
string |
恢複任務類型。 |
ECS_FILE |
| TargetCreateTime |
integer |
僅 NAS 備份有效。恢複的目標檔案系統建立時間。 |
1634714531 |
| ItemsDone |
integer |
僅當 SourceType 取值為ECS_FILE時，該參數有效。表示恢複專案數。 |
8 |
| BytesTotal |
integer |
資料來源總資料量。單位為位元組。 |
1000 |
| Exclude |
string |
僅當 SourceType 取值為ECS_FILE時，需要配置該參數。表示不需要進行恢複的路徑，該路徑下所有檔案都不恢複。最多支援 255 個字元。 |
["/var", "/proc"] |
| ParentId |
string |
父任務 ID。 |
r-0003hd2an3x4dyv0l18b |
| CompleteTime |
integer |
恢複任務完成時間。UNIX 時間，單位為秒。 |
1554347313 |
| CreatedTime |
integer |
恢複任務建立時間。UNIX 時間，單位為秒。 |
1554347313 |
| TargetBucket |
string |
僅 OSS 備份有效，恢複的目標 Bucket。 |
target-bucket |
| ClusterId |
string |
恢複使用的用戶端組 ID。 |
cl-000******hp6 |
| TargetFileSystemId |
string |
僅 NAS 備份有效，恢複的目標檔案系統。 |
0be9****9c9 |
| Progress |
integer |
恢複進度。值為 100%*100。 |
10000 |
| ExpireTime |
integer |
恢複任務到期時間。 |
1634714531 |
| TargetDataSourceId |
string |
恢複的目標資料來源 ID。 |
ds-000*****997 |
| TargetPrefix |
string |
僅 OSS 備份有效，恢複的目標首碼。 |
"/target" |
| TargetPath |
string |
恢複任務目標路徑。 |
"D:\\rebk" |
| ErrorFile |
string |
恢複失敗檔案清單。 |
"test.csv" |
| StartTime |
integer |
恢複任務開始時間。UNIX 時間，單位為秒。 |
1554347313 |
| UpdatedTime |
integer |
恢複任務更新時間。UNIX 時間，單位為秒。 |
1554347313 |
| SnapshotId |
string |
恢複使用的快照 ID。 |
s-0002******ga88 |
| RestoreId |
string |
恢複任務 ID。 |
r-0003*****8a |
| TargetClientId |
string |
恢複的勘探端 ID。 |
c-000e*****397 |
| ItemsTotal |
integer |
僅當 SourceType 取值為ECS_FILE時，該參數有效。表示資料來源專案總數。 |
10 |
| Include |
string |
恢複任務包含的復原路徑。 |
["/home/alice/*.pdf", "/home/bob/*.txt"] |
| BytesDone |
integer |
恢複的資料量。單位為位元組。 |
800 |
| TargetInstanceName |
string |
備份目標Table Store執行個體名稱。 |
instancename |
| TargetTableName |
string |
備份目標Table Store執行個體的資料表。 |
tablename |
| Speed |
integer |
實際的平均備份速度。單位為 KB/s。 |
500 |
| TargetTime |
integer |
備份目標Table Store執行個體的時間。UNIX 時間，單位為秒。 |
1642560261 |
| OtsDetail |
object |
Table Store執行個體詳情 |
|
| BatchChannelCount |
integer |
每個Table Store恢複任務處理的 channel 數量。 |
2 |
| OverwriteExisting |
boolean |
是否覆蓋已存在的Table Store恢複任務。 |
false |
| CrossAccountType |
string |
跨帳號備份類型。支援：
|
SELF_ACCOUNT |
| CrossAccountUserId |
integer |
被當前帳號管理的跨帳號備份的原帳號 ID。 |
158975xxxxxx4625 |
| CrossAccountRoleName |
string |
被當前帳號管理的跨帳號備份的原帳號 RAM 中建立的角色名稱。 |
BackupRole |
| Report |
object |
恢複任務報告。 |
|
| TotalFiles |
string |
根據檔案清單恢複時的全量檔案。 |
/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv |
| SuccessFiles |
string |
成功執行的檔案清單。 |
/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip |
| FailedFiles |
string |
執行失敗的檔案清單。 |
/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip |
| SkippedFiles |
string |
跳過的檔案清單。 |
/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip |
| ReportTaskStatus |
string |
報告產生狀態。 |
COMPLETE |
| MeteringBytesDone |
integer |
恢複的資料量。單位為位元組。僅 StorageClass=ARCHIVE 時有效，按照 1MB 對齊。 |
1048576 |
| MeteringBytesTotal |
integer |
資料來源總資料量。單位為位元組。僅 StorageClass=ARCHIVE 時有效，按照 1MB 對齊。 |
1048576 |
| StorageClass |
string |
備份資料存放區類型。取值：
|
STANDARD |
| FailbackDetail |
string |
VMware 回切任務詳情 |
{"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 |
恢複任務目標執行個體 ID。 |
i-2ze3m7ktcgw******cs |
| SourceResourceId |
string |
i-123***7890 |
樣本
正常返回樣本
JSON格式
{
"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"
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。