文档

DescribeRestoreJobs2 - 查询恢复任务

更新时间:

查询一个或者多个符合条件的恢复任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PageNumberinteger

分页页码,从 1 开始,默认值为 1。

1
PageSizeinteger

分页大小,最小值为 1,最大值为 99,默认值为 10。

10
RestoreTypestring

数据源类型,取值范围:

  • ECS_FILE:恢复 ECS 文件。
  • OSS:恢复阿里云 OSS。
  • NAS:恢复阿里云 NAS。
  • OTS_TABLE:恢复到阿里云 OTS。
  • UDM_ECS_ROLLBACK:恢复到阿里云 ECS 整机。
ECS_FILE
Filtersobject []

查询过滤器中的键值。

Keystring

查询过滤器中的键值。取值包括:

  • RegionId:地域 ID
  • PlanId:备份计划 ID
  • JobId:备份任务 ID
  • VaultId:仓库 ID
  • InstanceId:ECS 实例 ID
  • Bucket:OSS Bucket 名称
  • FileSystemId:文件系统 ID
  • Status:任务状态
  • CompleteTime:任务结束时间
VaultId
Valuesarray

查询过滤器中的待匹配的值。

string

查询过滤器中的待匹配的值。

["v-*********************"]
Operatorstring

匹配方式。默认为 IN。即过滤器中 Key 和 Value 支持的匹配操作(Operator)方式,取值可包括:

  • EQUAL:等于
  • NOT_EQUAL:不等于
  • GREATER_THAN:大于
  • GREATER_THAN_OR_EQUAL:大于等于
  • LESS_THAN:小于
  • LESS_THAN_OR_EQUAL:小于等于
  • BETWEEN:区间,value 为 JSON 数组[下届,上届]
  • IN:在集合中,value 为数组。
说明 当使用 CompleteTime 作为 Key 查询时,暂时不支持 IN 操作。
IN

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Successboolean

请求是否成功。

  • true:成功
  • false:失败
true
Codestring

返回码,200 表示成功。

200
Messagestring

返回信息描述,成功一般返回 successful,错误时会返回相应错误信息。

successful
PageNumberinteger

分页页码,从 1 开始,默认值为 1。

1
PageSizeinteger

分页大小,最小值为 1,最大值为 99,默认值为 10。

1
TotalCountinteger

总记录数。

1
RestoreJobsobject []

恢复任务详情。

{'RestoreJob': []}
SnapshotHashstring

备份快照 HASH 值。

f2fe...
Statusstring

恢复任务状态。取值范围:

  • COMPLETE:成功
  • PARTIAL_COMPLETE:部分成功
  • FAILED:失败
COMPLETE
ErrorMessagestring

恢复任务的错误信息。

PARTIAL_COMPLETE
ActualItemslong

仅当 SourceType 取值为ECS_FILE时,该参数有效。表示恢复任务实际项目数。

6
VaultIdstring

备份仓库 ID。

v-0006******q
ActualByteslong

去除重复后恢复任务实际数据量。单位为字节。

600
UdmDetailstring

整机备份详情。

{\"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}
SourceTypestring

数据源类型,取值范围:

  • ECS_FILE:恢复 ECS 文件
  • OSS:恢复阿里云 OSS
  • NAS:恢复阿里云 NAS
  • OTS_TABLE:恢复阿里云 OTS
  • UDM_ECS:恢复阿里云 ECS 整机
ECS_FILE
Optionsstring

仅当 SourceType 取值为ECS_FILE时,需要配置该参数。表示是否使用 Windows 系统 VSS 定义恢复路径。

  • 此功能仅支持 Windows 类型 ECS 实例。
  • 如果备份源中有数据更改,需要确保备份数据与源数据的一致时,才可配置为["UseVSS":true]
  • 选择使用 VSS 后,不支持多个文件目录同时恢复。
{"UseVSS":false}
TargetInstanceIdstring

恢复任务目标实例 ID。

i-2ze3m7ktcgw******cs
RestoreTypestring

恢复任务类型。

ECS_FILE
TargetCreateTimelong

仅 NAS 备份有效。恢复的目标文件系统创建时间。

1634714531
ItemsDonelong

仅当 SourceType 取值为ECS_FILE时,该参数有效。表示恢复项目数。

8
BytesTotallong

数据源总数据量。单位为字节。

1000
Excludestring

仅当 SourceType 取值为ECS_FILE时,需要配置该参数。表示不需要进行恢复的路径,该路径下所有文件都不恢复。最多支持 255 个字符。

["/var", "/proc"]
ParentIdstring

父任务 ID。

r-0003hd2an3x4dyv0l18b
CompleteTimelong

恢复任务完成时间。UNIX 时间,单位为秒。

1554347313
CreatedTimelong

恢复任务创建时间。UNIX 时间,单位为秒。

1554347313
TargetBucketstring

仅 OSS 备份有效,恢复的目标 Bucket。

target-bucket
ClusterIdstring

恢复使用的客户端组 ID。

cl-000******hp6
TargetFileSystemIdstring

仅 NAS 备份有效,恢复的目标文件系统。

0be9****9c9
Progressinteger

恢复进度。值为 100%*100。

10000
ExpireTimelong

恢复任务过期时间。

1634714531
TargetDataSourceIdstring

恢复的目标数据源 ID。

ds-000*****997
TargetPrefixstring

仅 OSS 备份有效,恢复的目标前缀。

"/target"
TargetPathstring

恢复任务目标路径。

"D:\\rebk"
ErrorFilestring

恢复失败文件列表。

"test.csv"
StartTimelong

恢复任务开始时间。UNIX 时间,单位为秒。

1554347313
UpdatedTimelong

恢复任务更新时间。UNIX 时间,单位为秒。

1554347313
SnapshotIdstring

恢复使用的快照 ID。

s-0002******ga88
RestoreIdstring

恢复任务 ID。

r-0003*****8a
TargetClientIdstring

恢复的目标客户端 ID。

c-000e*****397
ItemsTotallong

仅当 SourceType 取值为ECS_FILE时,该参数有效。表示数据源项目总数。

10
Includestring

恢复任务包含的恢复路径。

["/home/alice/*.pdf", "/home/bob/*.txt"]
BytesDonelong

恢复的数据量。单位为字节。

800
TargetInstanceNamestring

备份目标表格存储实例名称。

instancename
TargetTableNamestring

备份目标表格存储实例的数据表。

tablename
Speedlong

实际的平均备份速度。单位为 KB/s。

500
TargetTimelong

备份目标表格存储实例的时间。UNIX 时间,单位为秒。

1642560261
OtsDetailobject

表格存储实例详情

BatchChannelCountinteger

每个表格存储恢复任务处理的 channel 数量。

2
OverwriteExistingboolean

是否覆盖已存在的表格存储恢复任务。

false
CrossAccountTypestring

跨账号备份类型。支持:

  • SELF_ACCOUNT:本账号备份
  • CROSS_ACCOUNT:跨账号备份
SELF_ACCOUNT
CrossAccountUserIdlong

被当前账号管理的跨账号备份的原账号 ID。

158975xxxxxx4625
CrossAccountRoleNamestring

被当前账号管理的跨账号备份的原账号 RAM 中创建的角色名。

BackupRole
Reportobject

恢复任务报告。

TotalFilesstring

根据文件列表恢复时的全量文件。

/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv
SuccessFilesstring

成功执行的文件列表。

/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip
FailedFilesstring

执行失败的文件列表。

/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip
SkippedFilesstring

跳过的文件列表。

/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip
ReportTaskStatusstring

报告生成状态。

COMPLETE
MeteringBytesDonelong

恢复的数据量。单位为字节。仅 StorageClass=ARCHIVE 时有效,按照 1MB 对齐。

1048576
MeteringBytesTotallong

数据源总数据量。单位为字节。仅 StorageClass=ARCHIVE 时有效,按照 1MB 对齐。

1048576
StorageClassstring

备份数据存储类型。取值:

  • STANDARD:标准。
  • ARCHIVE:归档。
STANDARD
FailbackDetailstring

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}

示例

正常返回示例

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}",
        "TargetInstanceId": "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}"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史