调用DescribeBackupJobs2查询一个或多个备份任务-云备份-阿里云

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hbr:DescribeBackupJobs2

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	分页页码，从 1 开始，默认值为 1。	1
PageSize	integer	否	分页大小，最小值为 1，最大值为 99，默认值为 10。	10
SourceType	string	否	数据源类型，取值范围： ECS_FILE：备份 ECS 文件 OSS：备份阿里云 OSS NAS：备份阿里云 NAS OTS：备份阿里云 OTS UDM_ECS：备份 ECS 整机 UDM_ECS_DISK：ECS 整机备份-云盘备份子任务 COMMON_NAS：通用 NAS 数据源，包括归档 NAS 数据源和本地 NAS 数据源。您需要通过 Filters 的 Values 区分数据源类型。 File：本地文件备份 SYNC：数据同步	ECS_FILE
SortDirection	string	否	排序方向。取值范围： ASCEND：升序 DESCEND（默认）：降序	DESCEND
Filters	array<object>	否	查询过滤器中的键值。
	object	否	查询过滤器。
Key	string	否	查询过滤器中的键值。取值包括： RegionId：地域 ID PlanId：备份计划 ID JobId：备份任务 ID VaultId：仓库 ID InstanceId：ECS 实例 ID Bucket：OSS bucket 名称 FileSystemId：文件系统 ID Status：任务状态 CreatedTime：任务开始时间 CompleteTime：任务结束时间 InstanceName：表格存储实例名称 BackupType：备份任务（仅当 SourceType 取值为 COMMON_NAS 时，需要配置该参数） ParentId：查询子任务类型时，需要指定父类型任务的 ID。如：SourceType 取值为 UDM_ECS_DISK 时，需要指定 UDM_ECS 类型的任务 ID。	VaultId
Values	array	否	查询过滤器的变量值。
	string	否	查询过滤器的变量值。 -COMPLETE：本地 NAS 备份 0：ARCHIVE：归档数据源 NAS 1：ARCHIVE_BY_SEARCH：归档数据源 NAS	COMPLETE
Operator	string	否	匹配方式。默认为 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
Edition	string	否	版本类型，支持 BASIC 和 STANDARD，默认值为 STANDARD。	STANDARD

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	请求是否成功。 true：成功 false：失败	true
Code	string	返回码，200 表示成功。	200
Message	string	返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。	successful
PageNumber	integer	分页页码，从 1 开始，默认值为 1。	1
PageSize	integer	分页大小，最小值为 1，最大值为 99，默认值为 10。	10
TotalCount	integer	查询到的符合条件的备份任务总数。	8
BackupJobs	object
BackupJob	array<object>	符合条件的备份任务列表。
	array<object>	备份任务详情。
Status	string	备份任务状态。取值范围： COMPLETE：成功 PARTIAL_COMPLETE：部分成功 FAILED：失败	COMPLETE
ErrorMessage	string	备份任务的错误信息。	PARTIAL_COMPLETE
ActualItems	integer	仅当 SourceType 取值为ECS_FILE时，该参数有效。表示备份任务实际项目数。	6
VaultId	string	备份仓库 ID。	v-0006******q
ActualBytes	integer	去除重复后备份任务实际数据量。单位为字节。	600
CreateTime	integer	仅当 SourceType 取值为 NAS 时，该参数有效。表示文件系统创建时间。UNIX 时间，单位为秒。	1607436917
BackupType	string	备份类型。取值为 COMPLETE，表示全量备份。	COMPLETE
Prefix	string	仅当 SourceType 取值为 OSS 时，该参数有效。表示备份对象前缀。	example/
SourceType	string	数据源类型，取值范围： ECS_FILE：备份 ECS 文件 OSS：备份阿里云 OSS NAS：备份阿里云 NAS	ECS_FILE
Options	string	仅当 SourceType 取值为ECS_FILE时，需要配置该参数。表示是否使用 Windows 系统 VSS 定义备份路径。此功能仅支持 Windows 类型 ECS 实例。如果备份源中有数据更改，需要确保备份数据与源数据的一致时，才可配置为`["UseVSS":true]`。选择使用 VSS 后，不支持多个文件目录同时备份。	{"UseVSS":false}
ClientId	string	仅当 SourceType 取值为ECS_FILE时，该参数有效。表示备份客户端 ID。	c-*********************
ItemsDone	integer	仅当 SourceType 取值为ECS_FILE时，该参数有效。表示备份项目数。	8
BytesTotal	integer	数据源总数据量。单位为字节。	1000
Exclude	string	仅当 SourceType 取值为ECS_FILE时，需要配置该参数。表示不需要进行备份的路径，该路径下所有文件都不备份。最多支持 255 个字符。	["/var", "/proc"]
JobName	string	备份任务名称。	jobname
CompleteTime	integer	备份任务完成时间。UNIX 时间，单位为秒。	1554347313
CreatedTime	integer	备份任务创建时间。UNIX 时间，单位为秒。	1554347313
Bucket	string	仅当 SourceType 取值为 OSS 时，该参数有效。表示备份 OSS bucket 名称。	hbr-backup-oss
Progress	integer	备份进度。值为 100%*100。	10000
SpeedLimit	string	仅当 SourceType 取值为ECS_FILE时，需要配置该参数。表示备份流量控制。格式为`{start}\|{end}\|{bandwidth}`。多个流量控制配置使用`\|`分隔，并且配置时间不允许有重叠。 start：起始小时 end：结束小时 bandwidth：限制速率，单位 KB/s。	0:24:5120
InstanceId	string	仅当 SourceType 取值为 NAS 时，该参数有效。表示 ECS 实例 ID。	i-*********************
PlanId	string	备份计划 ID。	plan-20********35
FileSystemId	string	仅当 SourceType 取值为 NAS 时，该参数有效。表示文件系统 ID。	005494
StartTime	integer	备份任务开始时间。UNIX 时间，单位为秒。	1554347313
UpdatedTime	integer	备份任务更新时间。UNIX 时间，单位为秒。	1554347313
JobId	string	备份任务 ID。	job-000g********w7
ItemsTotal	integer	仅当 SourceType 取值为ECS_FILE时，该参数有效。表示数据源项目总数。	10
Include	string	备份任务包含的备份路径。	["/home/alice/.pdf", "/home/bob/.txt"]
BytesDone	integer	增量备份的数据量。单位为字节。	800
Paths	object
Path	array	表示备份路径。
	string	表示备份路径。	"/home"
Detail	object	ECS 整机备份任务详情。
DoCopy	boolean	是否进行异地复制。	true
DestinationNativeSnapshotId	string	异地复制快照 ID。	s-******************
DestinationNativeSnapshotProgress	integer	异地复制进度。	85
DestinationNativeSnapshotStatus	string	异地复制状态。	COMPLETE
DestinationRetention	integer	异地复制备份保留时间。	30
DestinationSnapshotId	string	异地复制备份 ID。	s-******************
DestinationNativeSnapshotErrorMessage	string	异地复制失败信息。	ECS.CreatingSnapshot
NativeSnapshotId	string	快照 ID。	s-******************
DiskNativeSnapshotIdList	object
DiskNativeSnapshotId	array	快照与云盘对应关系。
	string	快照 ID。	s-******************
InstanceInfos	object	ECS 实例信息，包含 ECS 实例名称、实例规格等。	{ "i-xxxxxxxx": { "hostName": "test", "instanceName": "test", "instanceType": "ecs.c7.xlarge", "osType": "linux", "diskIds": [ "d-xxxxxxxx01", "d-xxxxxxxx02" ], "osNameEn": "Rocky Linux 8.8 64 bit", "osName": "Rocky Linux 8.8 64位", "platform": "Rocky Linux" } }
InstanceName	string	表格存储实例名称。	instancename
OtsDetail	object	表格存储实例详情。
TableNames	object
TableName	array	表格存储实例的数据表名称列表。
	string	表格存储实例的数据表名称。	["table1", "table2", "table3"]
Speed	integer	实际的平均备份速度。单位为 KB/s。	500
TableName	string	表格存储实例的数据表名称。	table1
CrossAccountType	string	跨账号备份类型。支持： SELF_ACCOUNT：本账号备份 CROSS_ACCOUNT：跨账号备份	SELF_ACCOUNT
CrossAccountUserId	integer	被当前账号管理的跨账号备份的原账号 ID。	158975xxxxx4625
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
Identifier	string	仅 SourceType=CONTAINER 时返回，表示容器备份任务备份的集群标识。当集群类型为阿里云容器服务 Kubernetes 集群时，该值为 Kubernetes 集群 ID。	c83**************************b76
DestSourceType	string	目的端数据源类型。（仅同步需要）	OSS
DestDataSourceId	string	目的端数据源 ID。（仅同步需要）	ds-000cov4ufudxklj24zdk
DestDataSourceDetail	string	目的端数据源详情。（仅同步需要）	{\"prefix\":\"/\"}
ChangeListPath	string	增量文件同步列表的配置。（仅同步需要）	{"dataSourceId": "ds-123456789", "path": "/changelist"}
FilesTotal	integer	表示需处理文件的总数。	10
FilesDone	integer	表示文件已处理完成数。	9
ActualFiles	integer	表示实际处理的文件数。	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": [
              "s-******************"
            ]
          },
          "InstanceInfos": {
            "i-xxxxxxxx": {
              "hostName": "test",
              "instanceName": "test",
              "instanceType": "ecs.c7.xlarge",
              "osType": "linux",
              "diskIds": [
                "d-xxxxxxxx01",
                "d-xxxxxxxx02"
              ],
              "osNameEn": "Rocky Linux 8.8 64 bit",
              "osName": "Rocky Linux 8.8 64位",
              "platform": "Rocky Linux"
            }
          }
        },
        "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"
        },
        "Identifier": "c83**************************b76",
        "DestSourceType": "OSS",
        "DestDataSourceId": "ds-000cov4ufudxklj24zdk",
        "DestDataSourceDetail": "{\\\"prefix\\\":\\\"/\\\"}",
        "ChangeListPath": "{\"dataSourceId\": \"ds-123456789\", \"path\": \"/changelist\"}",
        "FilesTotal": 10,
        "FilesDone": 9,
        "ActualFiles": 8
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。