全部产品
Search
文档中心

混合云备份 HBR:DescribeBackupJobs2 - 查询备份任务

更新时间:Mar 17, 2023

查询一个或者多个符合条件的备份任务。

调试

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

调试

授权信息

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

请求参数

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

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

1
PageSizeinteger

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

10
SourceTypestring

数据源类型,取值范围:

  • ECS_FILE:备份ECS文件
  • OSS:备份阿里云OSS
  • NAS:备份阿里云NAS
  • OTS:备份阿里云OTS
  • UDM_ECS:备份ECS整机
  • UDM_ECS_DISK:ECS整机备份-云盘备份子任务
ECS_FILE
SortDirectionstring

排序方向。取值范围:

  • ASCEND:升序
  • DESCEND(默认):降序
DESCEND
Filtersarray

查询过滤器中的键值。

object

查询过滤器。

Keystring

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

  • RegionId:地域ID
  • PlanId:备份计划ID
  • JobId:备份任务ID
  • VaultId:仓库ID
  • InstanceId:ECS实例ID
  • Bucket:OSS bucket名称
  • FileSystemId:文件系统ID
  • Status:任务状态
  • CreatedTime:任务开始时间
  • CompleteTime:任务结束时间
  • InstanceName:表格存储实例名称
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。

10
TotalCountlong

查询到的符合条件的备份任务总数。

8
BackupJobsarray

符合条件的备份任务列表。

object

备份任务详情。

Statusstring

备份任务状态。取值范围:

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

备份任务的错误信息。

PARTIAL_COMPLETE
ActualItemslong

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

6
VaultIdstring

备份仓库ID。

v-0006******q
ActualByteslong

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

600
CreateTimelong

仅当SourceType取值为NAS时,该参数有效。表示文件系统创建时间。UNIX时间,单位为秒。

1607436917
BackupTypestring

备份类型。取值为COMPLETE,表示全量备份。

COMPLETE
Prefixstring

仅当SourceType取值为OSS时,该参数有效。表示备份对象前缀。

example/
SourceTypestring

数据源类型,取值范围:

  • ECS_FILE:备份ECS文件
  • OSS:备份阿里云OSS
  • NAS:备份阿里云NAS
ECS_FILE
Optionsstring

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

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

仅当SourceType取值为ECS_FILE时,该参数有效。表示备份客户端ID。

c-*********************
ItemsDonelong

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

8
BytesTotallong

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

1000
Excludestring

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

["/var", "/proc"]
JobNamestring

备份任务名称。

jobname
CompleteTimelong

备份任务完成时间。UNIX时间,单位为秒。

1554347313
CreatedTimelong

备份任务创建时间。UNIX时间,单位为秒。

1554347313
Bucketstring

仅当SourceType取值为OSS时,该参数有效。表示备份OSS bucket名称。

hbr-backup-oss
Progressinteger

备份进度。值为100%*100。

10000
SpeedLimitstring

仅当SourceType取值为ECS_FILE时,需要配置该参数。表示备份流量控制。格式为{start}|{end}|{bandwidth}。多个流量控制配置使用|分隔,并且配置时间不允许有重叠。

  • start:起始小时
  • end:结束小时
  • bandwidth:限制速率,单位KB/s。
0:24:5120
InstanceIdstring

仅当SourceType取值为NAS时,该参数有效。表示ECS实例ID。

i-*********************
PlanIdstring

备份计划ID。

plan-20********35
FileSystemIdstring

仅当SourceType取值为NAS时,该参数有效。表示文件系统ID。

005494
StartTimelong

备份任务开始时间。UNIX时间,单位为秒。

1554347313
UpdatedTimelong

备份任务更新时间。UNIX时间,单位为秒。

1554347313
JobIdstring

备份任务ID。

job-000g********w7
ItemsTotallong

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

10
Includestring

备份任务包含的备份路径。

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

增量备份的数据量。单位为字节。

800
Pathsarray

表示备份路径。

string

表示备份路径。

"/home"
Detailobject

ECS整机备份任务详情。

DoCopyboolean

是否进行异地复制。

true
DestinationNativeSnapshotIdstring

异地复制快照ID。

s-******************
DestinationNativeSnapshotProgressinteger

异地复制进度。

85
DestinationNativeSnapshotStatusstring

异地复制状态。

COMPLETE
DestinationRetentionlong

异地复制备份保留时间。

30
DestinationSnapshotIdstring

异地复制备份ID。

s-******************
DestinationNativeSnapshotErrorMessagestring

异地复制失败信息。

ECS.CreatingSnapshot
NativeSnapshotIdstring

快照ID。

s-******************
DiskNativeSnapshotIdListarray

快照与云盘对应关系。

InstanceNamestring

表格存储实例名称。

instancename
OtsDetailobject

表格存储实例详情。

TableNamesarray

表格存储实例的数据表名称列表。

string

表格存储实例的数据表名称。

["table1", "table2", "table3"]
Speedlong

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

500
TableNamestring

表格存储实例的数据表名称。

table1
CrossAccountTypestring

跨账号备份类型。支持:

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

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

158975xxxxx4625
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

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "BackupJobs": {
    "BackupJob": [
      {
        "Status": "COMPLETE",
        "ErrorMessage": "PARTIAL_COMPLETE",
        "ActualItems": 6,
        "VaultId": "v-0006******q",
        "ActualBytes": 600,
        "CreateTime": 1607436917,
        "BackupType": "COMPLETE",
        "Prefix": "example/",
        "SourceType": "ECS_FILE",
        "Options": "{\"UseVSS\":false}",
        "ClientId": "c-*********************",
        "ItemsDone": 8,
        "BytesTotal": 1000,
        "Exclude": "[\"/var\", \"/proc\"]",
        "JobName": "jobname",
        "CompleteTime": 1554347313,
        "CreatedTime": 1554347313,
        "Bucket": "hbr-backup-oss",
        "Progress": 10000,
        "SpeedLimit": "0:24:5120",
        "InstanceId": "i-*********************",
        "PlanId": "plan-20********35",
        "FileSystemId": "005494",
        "StartTime": 1554347313,
        "UpdatedTime": 1554347313,
        "JobId": "job-000g********w7",
        "ItemsTotal": 10,
        "Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
        "BytesDone": 800,
        "Paths": {
          "Path": [
            "\"/home\""
          ]
        },
        "Detail": {
          "DoCopy": true,
          "DestinationNativeSnapshotId": "s-******************",
          "DestinationNativeSnapshotProgress": 85,
          "DestinationNativeSnapshotStatus": "COMPLETE",
          "DestinationRetention": 30,
          "DestinationSnapshotId": "s-******************",
          "DestinationNativeSnapshotErrorMessage": "ECS.CreatingSnapshot",
          "NativeSnapshotId": "s-******************",
          "DiskNativeSnapshotIdList": {
            "DiskNativeSnapshotId": [
              ""
            ]
          }
        },
        "InstanceName": "instancename",
        "OtsDetail": {
          "TableNames": {
            "TableName": [
              "[\"table1\", \"table2\", \"table3\"]"
            ]
          }
        },
        "Speed": 500,
        "TableName": "table1",
        "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",
          "FailedFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip",
          "SkippedFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip",
          "ReportTaskStatus": "COMPLETE"
        }
      }
    ]
  }
}

错误码

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