文档

DescribeBackupJobs2 - 查询备份任务

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hbr:DescribeBackupJobs2
  • 全部资源
    acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}

请求参数

名称类型必填描述示例值
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 整机备份-云盘备份子任务
  • COMMON_NAS:通用 NAS 数据源,包括归档 NAS 数据源和本地 NAS 数据源。您需要通过 Filters 的 Values 区分数据源类型。
  • File:本地文件备份
ECS_FILE
SortDirectionstring

排序方向。取值范围:

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

查询过滤器中的键值。

object

查询过滤器。

Keystring

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

  • RegionId:地域 ID
  • PlanId:备份计划 ID
  • JobId:备份任务 ID
  • VaultId:仓库 ID
  • InstanceId:ECS 实例 ID
  • Bucket:OSS bucket 名称
  • FileSystemId:文件系统 ID
  • Status:任务状态
  • CreatedTime:任务开始时间
  • CompleteTime:任务结束时间
  • InstanceName:表格存储实例名称
  • BackupType:备份任务(仅当 SourceType 取值为 COMMON_NAS 时,需要配置该参数)
VaultId
Valuesarray

查询过滤器的变量值。

string

查询过滤器的变量值。

-COMPLETE:本地 NAS 备份

0:ARCHIVE:归档数据源 NAS

1:ARCHIVE_BY_SEARCH:归档数据源 NAS

["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>

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

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
Identifierstring

仅 SourceType=CONTAINER 时返回,表示容器备份任务备份的集群标识。当集群类型为阿里云容器服务 Kubernetes 集群时,该值为 Kubernetes 集群 ID。

c83**************************b76
DestSourceTypestring

目的端数据源类型。(仅同步需要)

OSS
DestDataSourceIdstring

目的端数据源 ID。(仅同步需要)

ds-000cov4ufudxklj24zdk
DestDataSourceDetailstring

目的端数据源详情。(仅同步需要)

{\"prefix\":\"/\"}
ChangeListPathstring

增量文件同步列表的配置。(仅同步需要)

{"dataSourceId": "ds-123456789", "path": "/changelist"}
FilesTotallong

表示需处理文件的总数。

10
FilesDonelong

表示文件已处理完成数。

9
ActualFileslong

表示实际处理的文件数。

8

示例

正常返回示例

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",
        "Identifier": "c83**************************b76",
        "DestSourceType": "OSS",
        "DestDataSourceId": "ds-000cov4ufudxklj24zdk",
        "DestDataSourceDetail": "{\\\"prefix\\\":\\\"/\\\"}",
        "ChangeListPath": "{\"dataSourceId\": \"ds-123456789\", \"path\": \"/changelist\"}",
        "FilesTotal": 10,
        "FilesDone": 9,
        "ActualFiles": 8
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-16OpenAPI 返回结构发生变更查看变更详情
2023-09-21OpenAPI 返回结构发生变更查看变更详情
2023-07-31OpenAPI 返回结构发生变更查看变更详情
2023-04-21OpenAPI 返回结构发生变更查看变更详情
2023-03-29OpenAPI 返回结构发生变更查看变更详情