接口功能介绍
查询云硬盘备份任务列表。
接口约束
无
接口是否审批
否
URI
GET /v4/ebs-backup/task/list-task
Content-Type
application/json
路径参数
无
Query参数
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
81f7728662dd11ec810800155d307d5b |
| taskID | 否 | String | 云硬盘备份任务ID | 59093d15-8a3c-53b9-b61b-484af10a3e97 |
| queryContent | 否 | String | 该参数，可用于模糊过滤 任务ID/云硬盘ID/云硬盘名称/备份任务ID/备份名称/存储库名称，即上述6个字段如果包含该参数的值，则会被过滤出 | 9915c3f4-8d78-445a-a1da-d8d9287d506b |
| taskStatus | 否 | String | 任务状态： 执行中:"running" 成功:"success" 失败:"failed" 已取消:"canceled" 取消中:"canceling" |
running |
| taskType | 否 | Integer | 任务类型： 1:创建任务 2:删除任务 3:恢复任务 |
1 |
请求头header参数
无
请求体body参数
无
响应参数
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| message | String | 错误信息的英文描述 | SUCCESS | |
| description | String | 错误信息的本地化描述（中文） | 成功 | |
| returnObj | Object | 成功时返回对象 | returnObj | |
| errorCode | String | 业务错误细分码，发生错误时返回，为product.module.code三段式码 | 参考错误码 | |
| error | String | 业务错误细分码，发生错误时返回，为product.module.code三段式码 | 参考错误码 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| taskList | Array of Objects | 云硬盘备份任务列表 | taskList | |
| totalCount | Integer | 云硬盘备份任务总数 | 11 | |
| currentCount | Integer | 当前页云硬盘备份任务数 | 10 |
表 taskList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| taskID | String | 备份任务ID | 9915c3f4-8d78-445a-a1da-d8d9287d506b | |
| taskType | String | 任务类型: 创建任务:create 删除任务:delete 恢复任务:restore |
delete | |
| backupID | String | 备份ID | 59093d15-8a3c-53b9-b61b-484af10a3e97 | |
| backupName | String | 备份名称 | test-backup-01 | |
| diskID | String | 云硬盘ID | 59093d15-8a3c-53b9-b61b-484af10a3e98 | |
| diskName | String | 云硬盘名称 | ebs-001 | |
| repositoryID | String | 备份存储库ID | 9915c3f4-8d78-445a-a1da-d8d9287d506b | |
| repositoryName | String | 备份存储库名称 | test-repo | |
| statusCode | String | 任务状态码 | success | |
| taskProgress | String | 任务进度 | 80 | |
| status | String | 任务状态描述: 成功:success 执行中:running 失败:failed 已取消：canceled 取消中：canceling |
success | |
| taskStartTime | String | 任务开始时间 | 2024-03-06 04:00:24 | |
| taskDoneTime | String | 任务完成时间 | 2024-03-06 04:20:24 | |
| taskErrMsg | String | 任务执行过程中的错误信息描述 | null | |
| taskDetail | String | 任务执行过程中附加信息描述 | null | |
| description | String | 任务描述 | null | |
| policyTaskID | String | 关联策略ID | 21bad727-43de-484b-af69-2b38864bc99c | |
| backupType | String | 备份类型: 全量备份:totalReplication 增量备份:incrementalReplication |
totalReplication |
枚举参数
无
请求头header示例
无
请求url示例
无
请求体body示例
无
响应示例
{
"httpstatus":200,
"httpresult":{
"returnObj":{
"currentCount":1,
"totalCount":1,
"backupTaskList":[
{
"status":"success",
"diskName":"evs-f2f8",
"statusCode":null,
"taskDoneTime":1717523947,
"backupName":"Manual_bk_701b",
"taskDetail":null,
"regionID":"81f7728662dd11ec810800155d307d5b",
"taskErrMsg":null,
"taskProgress":null,
"repositoryID":"2594f840-c43a-49e5-8b14-6f11f7b15cf6",
"backupType":"totalReplication",
"policyTaskID":null,
"taskID":"21bad727-43de-484b-af69-2b38864bc99c",
"taskStartTime":1717523916,
"backupID":"aed9eb29-3429-4006-ab17-173b2a3037a4",
"repositoryName":"repo-8074",
"taskType":"delete",
"diskID":"27209acb-fb58-4e4d-afb8-3a57331b5a6e",
"description":null
}
]
},
"details":"",
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}
}
状态码
请参考状态码
错误码
请参考错误码
