查询一个或者多个符合条件的备份任务。
调试
您可以在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 |
| SortDirection | string | 否 | 排序方向。取值范围：
| DESCEND |
| Filters | array<object> | 否 | 查询过滤器中的键值。 | |
| object | 否 | 查询过滤器。 | ||
| Key | string | 否 | 查询过滤器中的键值。取值包括：
| VaultId |
| Values | array | 否 | 查询过滤器的变量值。 | |
| string | 否 | 查询过滤器的变量值。 -COMPLETE：本地 NAS 备份 0：ARCHIVE：归档数据源 NAS 1：ARCHIVE_BY_SEARCH：归档数据源 NAS | COMPLETE | |
| Operator | string | 否 | 匹配方式。默认为 IN。即过滤器中 Key 和 Value 支持的匹配操作（Operator）方式，取值包括：
说明
当使用 CompleteTime 作为 Key 查询时，暂时不支持 IN 操作。
| IN |
返回参数
示例
正常返回示例
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": [
""
]
},
"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",
"Identifier": "c83**************************b76",
"DestSourceType": "OSS",
"DestDataSourceId": "ds-000cov4ufudxklj24zdk",
"DestDataSourceDetail": "{\\\"prefix\\\":\\\"/\\\"}",
"ChangeListPath": "{\"dataSourceId\": \"ds-123456789\", \"path\": \"/changelist\"}",
"FilesTotal": 10,
"FilesDone": 9,
"ActualFiles": 8
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-31 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-11-16 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-09-21 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-31 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-04-21 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-03-29 | OpenAPI 返回结构发生变更 | 查看变更详情 |