查询备份任务列表
更新时间 2026-04-02 15:46:07
最近更新时间: 2026-04-02 15:46:07
接口功能介绍
获取该用户所有备份任务列表
接口约束
无
URI
GET /v4/backup/query-task-backup
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| backupSrcInstanceID | 否 | String | 备份云主机ID | 31f777-827f25f-595ffa3-deb5d15d | |
| queryContent | 否 | String | 可选查询：备份计划名称/主机名称/备份副本名称或ID | test-policy | |
| backupTaskStatus | 否 | String | 状态查询: Completed-执行完成/Executing-执行中/Failed-执行失败/Preparing-执行准备中/Canceling-取消中 | Completed | |
| isCloud | 否 | Boolean | 是否是云上资源(默认true)，true：弹性云主机，false：本地客户主机。推荐使用sourceType参数，该参数后续即将下线 | true | |
| sourceType | 否 | String | 产品服务类型(默认CT-ECS)，CT-ECS：弹性云主机，CT-DPS：裸金属物理机，CT-LS：本地客户主机 | CT-DPS |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| message | String | 成功或失败时的描述，一般为英文描述 | SUCCESS | |
| description | String | 成功或失败时的描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回对象 | returnObj 表 | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | backup.regionInfo.empty | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码 | Backup.RegionInfo.Empty |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| bakupTaskCount | Integer | 备份任务的数量。推荐使用backupTaskCount参数，该参数后续即将下线 | 1 | |
| backupTaskCount | Integer | 备份任务的数量 | 1 | |
| backupTaskList | Array of Objects | 备份任务的详情列表 | backupTaskList表 |
表 backupTaskList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| backupTaskID | String | 备份任务ID | cfcaa4f9-4267-4851-98ae-16bd8d1ca264 | |
| backupPolicyName | String | 备份计划名称 | backup-1a01 | |
| backupSrcInstanceID | String | 备份主机ID | 8e8ead59-28db-ae63-0782-295b99ab1535 | |
| backupSrcInstanceName | String | 备份主机名称 | ecm-2d47 | |
| backupStorageID | String | 存储库ID | 90be5bb9-ec6f-4512-a832-862e93381c4d | |
| backupStorageName | String | 存储库名称 | test-20240124-01 | |
| backupPaths | Array of Strings | 备份路径列表 | ["/"] | |
| backupFileCount | Integer | 已备份文件数量 | 1 | |
| backupTaskStatus | String | 备份任务状态描述（5种，执行中，执行准备中，执行失败，执行完成，未知） | 执行中 | |
| backupTaskStatusCode | String | 备份任务状态码 | Executing | |
| backupTaskStartTime | String | 备份任务开始时间 | 2024-03-06 04:00:24 | |
| backupTaskDoneTime | String | 备份任务完成时间 | 2024-03-06 04:05:22 | |
| backupTaskErrMsg | String | 备份任务执行过程中的错误信息描述 | -- | |
| backupTaskPercent | Integer | 备份任务执行百分比 | 100 | |
| backupTaskName | String | 备份任务名称 | test-task | |
| backupTaskRate | String | 备份任务执行速率 | 209.28 KB/s |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"bakupTaskCount": 1,
"backupTaskList": [
{
"backupTaskErrMsg": "任务执行成功",
"backupFileCount": 12,
"backupSrcInstanceName": "openapi-20250212",
"backupTaskName": "snap_1739427020_policy_426_x_backup",
"backupSrcInstanceID": "e290c1db-be8f-a6c5-2836-bf8c790def21",
"backupTaskID": "57d9e2d2-72df-4942-9d72-c83bf09e5bb8",
"backupStorageName": "backupStorageName-azNEu",
"backupTaskDoneTime": "2025-02-13 14:11:01",
"backupTaskStartTime": "2025-02-13 14:10:20",
"backupPaths": [
"/root",
"/"
],
"backupTaskRate": "209.28 KB/s",
"backupPolicyName": "backupPolicyName-YxWYW",
"backupSnapID": "16c7bb4b-affa-401c-a00a-8870a42f570e",
"backupSnapName": "snap_1739427020_policy_426_x",
"backupTaskStatus": "执行完成",
"backupTaskStatusCode": "Completed",
"backupTaskPercent": 100,
"backupStorageID": "e1bc4a9b-8589-4dce-9917-9a9e4ff46e96"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码
