接口功能介绍
查询备份策略创建的备份任务列表
接口约束
无
URI
GET /v4/ebs-backup/policy/list-tasks
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| policyID | 是 | String | 备份策略ID | d15e7d402f8f11ed81370242ac110006 | |
| pageNo | 否 | Integer | 页码，默认值1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目 ,默认10 | 10 | |
| asc | 否 | Boolean | 和sort配合使用，是否升序排列，默认降序 | true | |
| sort | 否 | String | 和asc配合使用，指定用于排序的字段。可选字段：createdTime/completedTime，默认createdTime | createdTime | |
| taskStatus | 否 | Integer | 备份任务状态，-1-失败，0-执行中，1-成功 | 1 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 是否必填 | 类型 | 描述 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| message | 是 | String | 错误信息的英文描述 | SUCCESS | |
| description | 是 | String | 错误信息的本地化描述（中文） | 成功 | |
| returnObj | 否 | Object | 成功时返回对象 | returnObj | |
| errorCode | 否 | String | 业务错误细分码，发生错误时返回 | 参考错误码 |
表 returnObj
| 参数名 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| taskList | 是 | Array | 备份任务列表 | taskList | |
| totalCount | 是 | Integer | 备份任务总数 | 20 | |
| currentCount | 是 | Integer | 当前页备份任务数 | 10 |
表 taskList
| 参数名 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| taskID | 是 | String | 备份任务ID | 798aa810a1d511ed97520242ac110007 | |
| taskStatus | 是 | Integer | 备份任务状态，-1-失败，0-执行中，1-成功 | 1 | |
| diskID | 是 | String | 云硬盘ID | 4c26cefe-1aac-4b5a-9ac0-2a8eee8169d4 | |
| diskName | 是 | String | 云硬盘名称 | ebs-2f62 | |
| backupName | 是 | String | 云硬盘备份名称 | autobk-6an5 | |
| createdTime | 是 | Integer | 创建时间 | 663136607 | |
| completedTime | 是 | Integer | 完成时间 | 663136607 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"totalCount": 2,
"currentCount": 2,
"taskList": [{
"diskName": "ebs-2f62",
"backupName": "autobk-6an5",
"completedTime": 1675188576,
"taskStatus": 1,
"taskID": "798aa810a1d511ed97520242ac110007",
"createdTime": 1675188575,
"diskID": "4c26cefe-1aac-4b5a-9ac0-2a8eee8169d4"
}, {
"diskName": "ebs-2f62",
"backupName": "autobk-p56f",
"completedTime": 1675360807,
"taskStatus": 1,
"taskID": "77d42bc6a36611ed8f550242ac110007",
"createdTime": 1675360800,
"diskID": "4c26cefe-1aac-4b5a-9ac0-2a8eee8169d4"
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
错误码
| errorCode | 描述 |
|---|---|
| EbsBackup.RegionInfo.Empty | 查询资源池信息为空或资源池不存在，请确认资源池ID是否有效 |
| EbsBackup.RegionInfo.AccessFailed | 查询资源池失败，请重试。如果多次尝试失败，请提交工单 |
| EbsBackup.RegionInfo.DataDamaged | 查询资源池信息不符预期，请重试。如果多次尝试失败，请提交工单 |
| EbsBackup.Parameter.InvalidPageParams | 请求参数错误:{错误原因} |
| EbsBackup.Parameter.InvalidTaskStatus | 请求参数错误:{错误原因} |
| EbsBackup.Parameter.InvalidPolicyID | 请求参数错误:{错误原因} |
| EbsBackup.Parameter.InvalidRegionID | 请求参数错误：{错误原因} |
