接口功能介绍
无
接口约束
无
URI
POST /v4/ecs/backup-task/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| taskID | 否 | String | 任务ID | ||
| taskType | 否 | String | 任务类型，取值范围：create（生成备份副本任务），restore（恢复备份数据任务），delete（删除备份副本任务） 注：不传默认全部 |
||
| taskStatus | 否 | String | 任务状态，取值范围：successed（成功），failed（失败），in-progress（执行中），canceling（取消中），canceled（已取消） 注：不传默认全部 |
||
| instanceID | 否 | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 |
||
| backupID | 否 | String | 备份ID | ||
| backupName | 否 | String | 备份名称 | ||
| queryContent | 否 | String | 模糊查询，可匹配查询字段：任务ID、备份副本ID、备份副本名称、云主机ID、云主机名称、存储库ID、存储库名称 | ||
| pageNo | 否 | Integer | 页码，取值范围：正整数（≥1），注：默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目，取值范围：[1, 50]，注：默认值为10 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页记录数目 | 1 | |
| totalCount | Integer | 总记录数 | 10 | |
| totalPage | Integer | 总页数 | 1 | |
| results | Array of Objects | 分页明细 | results |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| taskID | String | 任务ID | ||
| taskStatus | String | 任务状态 | in-progress | |
| taskType | String | 任务类型 | create | |
| instanceID | String | 云主机ID | ec14b339-d538-4e64-abae-f7c4bbe1a25d | |
| instanceName | String | 云主机名称 | ecm-8683 | |
| backupID | String | 备份ID | bbe6064b-62e0-4cef-a92b-f849c65b4def | |
| backupName | String | 备份名称 | Manual-a7950-202408271814 | |
| repositoryID | String | 存储库ID | 7be48eac-da8f-4ff8-a9ba-b9cc8c0994c1 | |
| repositoryName | String | 存储库名称 | repo-7359 | |
| strategyID | String | 策略的ID，非策略触发执行时为空 | ||
| strategyName | String | 策略的名称，非策略触发执行时为空 | ||
| startTime | String | 开始时间 | 2024-07-21T09:01:03Z | |
| finishTime | String | 完成时间 | 2024-07-21T09:01:03Z | |
| taskDetailDesc | String | 任务详情 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例1：指定每页记录数目，查询指定页云主机备份任务信息
在华东1资源池指定每页记录数目为3，查看第2页云主机备份任务信息
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"pageNo": 2,
"pageSize": 3
}
示例2：查看指定ID的任务信息
在华东1资源池查询ID为496ac7fa-15fc-4582-86dc-3e8fd75b953a的任务信息
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"taskID": "496ac7fa-15fc-4582-86dc-3e8fd75b953a"
}
示例4：筛选指定类型的任务列表
在华东1资源池查询类型为restore的任务列表
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"taskType": "restore"
}
示例5：筛选指定状态的任务列表
在华东1资源池查询类型为successed的任务列表
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"taskStatus": "successed"
}
示例6：查看指定云主机ID的任务列表
在华东1资源池中查询云主机ID为3ff18cc3-cfd2-3392-f9a2-34873000c1ce的任务列表
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceID": "3ff18cc3-cfd2-3392-f9a2-34873000c1ce"
}
示例7：根据模糊字段查询任务列表
在华东1资源池根据模糊字段云主机name查询任务列表
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"queryContent": "ecm-9190"
}
响应示例
{
"returnObj": {
"currentCount": 2,
"totalCount": 2,
"totalPage": 1,
"results": [
{
"taskID": "5015afbd-3ffa-49d1-95b2-8f75b05fe4d7",
"taskStatus": "successed",
"taskType": "create",
"instanceID": "e05f2e5b-6684-59a0-fe17-fe3057c39784",
"instanceName": "test-789",
"backupID": "23c119e4-f669-bea0-8aa2-60f01243b443",
"backupName": "bak-test",
"repositoryID": "af463253-6ced-44da-8104-c7f68a29f9e7",
"repositoryName": "yul-repo-6d05",
"strategyID": "",
"strategyName": "",
"startTime": "2024-08-09T07:22:42Z",
"finishTime": "2024-08-09T07:24:47Z",
"taskDetailDesc": ""
},
{
"taskID": "f1eec1cf-4017-4655-9ce5-50e6aa610380",
"taskStatus": "successed",
"taskType": "delete",
"instanceID": "2e01a3c8-76d4-865c-5c16-ba26ce2cbb29",
"instanceName": "api-0524195242364582",
"backupID": "b472ac8c-9f57-067d-7f53-8d6e89a88220",
"backupName": "Manual_bk_74f3",
"repositoryID": "af463253-6ced-44da-8104-c7f68a29f9e7",
"repositoryName": "yul-repo-6d05",
"strategyID": "",
"strategyName": "",
"startTime": "2024-07-31T07:21:10Z",
"finishTime": "2024-08-27T10:30:07Z",
"taskDetailDesc": ""
}
]
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
