接口功能介绍
该接口提供用户查询云主机快照任务列表的功能
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
分页查询：当前查询结果以分页形式进行展示，单次查询最多显示50条数据
接口约束
确保当前请求资源池下，该快照策略存在（即snapshotPolicyID真实存在且与regionID相对应）
URI
POST /v4/ecs/snapshot-policy/task-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
81f7728662dd11ec810800155d307d5b | |
| snapshotPolicyID | 是 | String | 云主机快照策略ID，32字节 获取： 查 查询云主机快照策略列表 创 创建云主机快照策略 |
4f69f096066011ee9caf0242ac110002 | |
| 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 | |
| taskList | Array of Objects | 分页明细 | taskList |
表 taskList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| taskID | String | 任务ID | 2e76e38209d311eea4090242ac110005 | |
| taskStatus | String | 任务状态，范围： createSucceeded（创建成功）， createFailed（创建失败）， deleteSucceeded（删除成功）， deleteFailed（删除失败）。 |
pending | |
| snapshotStatus | String | 快照状态，范围： pending（创建中）， available（可用）， unavailable（不可用）， error（错误）， deleted（已删除）。 |
||
| instanceID | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
5730653c-bfa5-2257-f644-bcc5b61fa820 | |
| snapshotID | String | 云主机快照ID | ||
| snapshotName | String | 云主机快照名称。满足以下规则：不能使用中文，且长度为2-63字符 | ce8a0b0b-61d4-8934-99fd-b6a4c18a3564 | |
| createTime | String | 任务创建时间 | 2023-06-13T10:15:11Z | |
| completeTime | String | 任务完成时间 | 2023-06-13T10:15:12Z |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"pageNo":1,
"pageSize":50,
"snapshotPolicyID": "b6e2966d-7b1c-385e-abe4-d940caa273b7"
}
响应示例
{
"returnObj": {
"currentCount": null,
"totalCount": 1,
"totalPage": 1,
"taskList": [
{
"instanceID": "5730653c-bfa5-2257-f644-bcc5b61fa820",
"taskID": "2e76e38209d311eea4090242ac110005",
"snapshotID":"2325cb2a-085b-1447-837d-4eafd945c143",
"taskStatus": "createSucceeded",
"snapshotStatus": "pending",
"snapshotName": "ce8a0b0b-61d4-8934-99fd-b6a4c18a3564",
"createTime": "2023-06-13T10:15:11Z",
"completeTime": "2023-06-13T10:15:12Z"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
