Consulta os trabalhos de restauração que correspondem aos critérios especificados.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
hbr:DescribeRestoreJobs2 |
get |
*All Resource
|
Nenhuma | Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| PageNumber |
integer |
Não |
O número da página. As páginas começam em 1. Valor padrão: 1. |
1 |
| PageSize |
integer |
Não |
O número de entradas por página. Valores válidos: 1 a 99. Valor padrão: 10. |
10 |
| RestoreType |
string |
Não |
O tipo de fonte de dados. Valores válidos:
|
ECS_FILE |
| Filters |
array<object> |
Não |
As condições de filtro. |
|
|
object |
Não |
Um filtro para consultar trabalhos de restauração. |
||
| Key |
string |
Não |
A chave do filtro. Valores válidos:
|
VaultId |
| Values |
array |
Não |
Uma matriz de valores para a chave de filtro especificada. |
|
|
string |
Não |
Um valor para correspondência. |
["v-*********************"] |
|
| Operator |
string |
Não |
O método de correspondência. O valor padrão é IN. Valores válidos:
Nota
O operador IN não é suportado quando |
IN |
| Edition |
string |
Não |
A edição. Valores válidos: |
STANDARD |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
|||
| RequestId |
string |
O ID da solicitação. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| Success |
boolean |
Indica se a solicitação foi bem-sucedida.
|
true |
| Code |
string |
O código de retorno. Um valor 200 indica que a solicitação foi bem-sucedida. |
200 |
| Message |
string |
A mensagem de resposta. Se a solicitação for bem-sucedida, "successful" será retornado. Caso contrário, uma mensagem de erro será retornada. |
successful |
| PageNumber |
integer |
O número da página retornada. As páginas começam em 1. Valor padrão: 1. |
1 |
| PageSize |
integer |
O número de entradas por página. Valores válidos: 1 a 99. Valor padrão: 10. |
1 |
| TotalCount |
integer |
O número total de entradas que correspondem à consulta. |
1 |
| RestoreJobs |
object |
Um contêiner para os detalhes do trabalho de restauração. |
|
| RestoreJob |
array<object> |
Uma lista de trabalhos de restauração. |
{'RestoreJob': []} |
|
array<object> |
Os detalhes de um trabalho de restauração. |
||
| 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 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 |
| 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.
|
{"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 |
| 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 |
| 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 |
Exemplos
Resposta de sucesso
JSON formato
{
"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"
}
]
}
}Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.