接口功能介绍
查询快照列表
接口约束
无
URI
GET /v3/snapshot/describe
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| name | 否 | String | 快照名称 | API_KZ | |
| snapshotOid | 否 | String | 快照ID | ss-41l5yfe2lg4fdsm4vags5 | |
| desktopOid | 否 | String | 云电脑ID | D0023092701181644 | |
| status | 否 | String | 状态（Creating-创建中;Active-已激活;Deleting-删除中;Unhealthy-异常） | Active | |
| pageNum | 否 | Integer | 页码，至少1，默认1 | 1 | |
| pageSize | 否 | Integer | 每页数量，最大100，默认10 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK | |
| returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Long | 总记录数 | ||
| list | Array of Objects | 数据列表 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| snapshotOid | String | 快照ID | ss-41l5yfe2lg4fdsm4vags5 | |
| name | String | 快照名称 | API_KZ | |
| desktopOid | String | 云电脑ID | D0023092701181644 | |
| description | String | 描述 | API测试 | |
| type | String | 快照类型，枚举值范围：[sys,data,all]（sys-系统盘;data-数据盘;all-系统盘和数据盘） | sys | |
| status | String | 状态（Creating-创建中;Active-已激活;Deleting-删除中;Unhealthy-异常） | Active | |
| createTime | String | 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | 2023-09-27T08:40:25Z |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"snapshotOid":"ss-foo","name":"foo","desktopOid":"XXXXXXXXXXXXX6925","description":"foo","type":"sys","status":"Active","createTime":"2022-09-25T08:26:29Z"}]}}
状态码
请参考 状态码
错误码
请参考 错误码
