接口功能介绍
该接口提供用户查询云主机快照任务列表的功能
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
无
URI
POST /v4/ecs/snapshot-task/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| taskID | 否 | String | 任务ID | ||
| taskType | 否 | String | 任务类型，取值范围：create（生成快照任务），restore（恢复快照数据任务），apply（申请云主机任务），delete（删除快照任务） 注：不传默认全部 |
||
| instanceID | 否 | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
||
| instanceName | 否 | String | 云主机名称 | ||
| snapshotID | 否 | String | 云主机快照ID， 获取： 查 查询云主机快照列表 创 创建云主机快照 |
||
| snapshotName | 否 | String | 快照名称 | ||
| queryContent | 否 | String | 模糊查询，可匹配查询字段：任务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 | 失败时的错误描述，一般为英文描述 | ||
| 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 | |
| snapshotID | String | 快照ID | 56c2b601-5a2f-405d-bd74-1b816f288202 | |
| snapshotName | String | 快照名称 | autosnapshot-Iu9v | |
| 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：查看指定云主机ID的任务列表
在华东1资源池中查询云主机ID为3ff18cc3-cfd2-3392-f9a2-34873000c1ce的任务列表
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceID": "3ff18cc3-cfd2-3392-f9a2-34873000c1ce"
}
示例6：查找指定云主机name的任务列表
在华东1资源池中查询云主机name为ecm-9190的任务列表
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceName": "ecm-9190"
}
示例7：根据模糊字段查询任务列表
在华东1资源池根据模糊字段云主机name查询任务列表
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"queryContent": "ecm-9190"
}
响应示例
{
"returnObj": {
"currentCount": 2,
"totalCount": 2,
"totalPage": 1,
"results": [
{
"taskID": "6e6e3d3b77b74a718b3f0b9f54941a4b",
"taskStatus": "in-progress",
"taskType": "restore",
"instanceId": "5af1392a-54be-4d09-8e68-398b9459b5de",
"instanceName": "ecm-188f",
"snapshotID": "",
"snapshotName": "sp-02",
"strategyID": "",
"strategyName": "",
"startTime": "2024-08-02T03:19:05Z",
"finishTime": "",
"taskDetailDesc": ""
},
{
"taskID": "bdff90e3feac47e4a6ae1295e292b738",
"taskStatus": "successed",
"taskType": "create",
"instanceId": "5af1392a-54be-4d09-8e68-398b9459b5de",
"instanceName": "ecm-188f",
"snapshotID": "1a48bfcc-5307-4829-b062-229c359c2aee",
"snapshotName": "autosnapshot-4e90",
"strategyID": "ab1ac6e657be4d4497ca1690cec84cf1",
"strategyName": "policy-QtFk",
"startTime": "2024-08-01T16:00:15Z",
"finishTime": "2024-08-01T16:00:26Z",
"taskDetailDesc": ""
}
]
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
