接口功能介绍
1、查询云硬盘快照列表；
2、查询云硬盘下快照使用量；
接口约束
无
URI
GET /v4/ebs_snapshot/list
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，请根据查询资源池列表接口返回值进行传参，获取“regionId”参数 | 参考请求示例 |
| volumeID | 否 | String | 云硬盘ID | 参考请求示例 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为失败) | 参考响应示例 | |
| message | 是 | String | 失败时的错误描述，一般为英文描述 | 参考响应示例 | |
| description | 是 | String | 失败时的错误描述，一般为中文描述 | 参考响应示例 | |
| returnObj | 是 | Object | 参考表returnObj | 参考响应示例 | 参考表returnObj |
| errorCode | 是 | String | 业务细分码，为product.module.code三段式码. 参考通用结果码 |
参考响应示例 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| size | 是 | Integer | 云硬盘快照使用量 | 参考响应示例 |
| total | 是 | Integer | 云硬盘快照总量 | 参考响应示例 |
| snapshotList | 是 | Object | 云硬盘快照列表 | 参考响应示例 |
表snapshotList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 云硬盘快照名称 | 参考响应示例 | |
| status | 是 | String | 云硬盘快照状态 | 参考响应示例 | |
| updateTime | 是 | String | 更新时间 | 参考响应示例 | |
| createTime | 是 | String | 创建时间 | 参考响应示例 | |
| customer_id | 是 | String | 租户ID | 参考响应示例 | |
| az_name | 是 | String | AZ名称 | 参考响应示例 | |
| delete_time | 是 | String | 删除时间 | 参考响应示例 | |
| description | 是 | String | 描述信息 | 参考响应示例 | |
| expire_time | 是 | String | 过期时间 | 参考响应示例 | |
| freezing | 是 | Boolean | 是否被冻结 | 参考响应示例 | |
| isEncryted | 是 | Boolean | 是否加密盘 | 参考响应示例 | |
| is_maz | 是 | Boolean | 是否跨AZ | 参考响应示例 | |
| region_id | 是 | String | regionID | 参考响应示例 | |
| resource_id | 是 | String | 资源ID | 参考响应示例 | |
| retention_policy | 是 | String | 快照保留策略 | 参考响应示例 | |
| retention_time | 是 | String | 快照保留时间 | 参考响应示例 | |
| snapshot_id | 是 | String | 快照ID | 参考响应示例 | |
| snapshot_type | 是 | String | 快照类型，手动或者自动 | 参考响应示例 | |
| update_time | 是 | String | 更新时间 | 参考响应示例 | |
| volumeAttr | 是 | String | 云硬盘属性，数据盘或者系统盘 | 参考响应示例 | |
| volumeName | 是 | String | 云硬盘名称 | 参考响应示例 | |
| volumeSize | 是 | Integer | 云硬盘大小 | 参考响应示例 | |
| volumeSource | 是 | String | 云硬盘来源，如果为空，则是普通云硬盘，如果不为空，则是由快照创建而来，显示来源快照ID | 参考响应示例 | |
| volumeStatus | 是 | String | 云硬盘的状态 | 参考响应示例 | |
| volume_id | 是 | String | 云硬盘ID | 参考响应示例 | |
| volume_type | 是 | String | 云硬盘类型 | 参考响应示例 | |
| volumeType | 是 | String | 云硬盘类型 | 参考响应示例 | |
| availability_zone | 是 | String | 可用区 | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"regionID":"fc862f71-d629-4a0e-9fe0-b104963b3f05",
"volumeID ":"ebs-7e68-5226350bb41"
}
响应示例
{
"statusCode": 800,
"returnObj": {
"total": 1,
"size": 1024,
"snapshotList":[
{
"availability_zone" : null,
"az_name" : null,
"create_time" : "2022-11-08T10:07:28Z",
"customer_id" : "17a47520-90e5-576c-87d7-8a69e5cd3484",
"delete_time" : null,
"description" : "",
"expire_time" : null,
"freezing" : false,
"isEncryted" : false,
"is_maz" : false,
"is_talk_order" : true,
"name" : "ksjdhfkkasjdhfk",
"region_id" : "73f321ea-62ff-11ec-a8bc-005056898fe0",
"resource_id" : "",
"retention_policy" : "forever",
"retention_time" : 0,
"snapshot_id" : "cafa8c74-42e7-4e32-921c-d7b2c75dac27",
"snapshot_type" : "manu",
"status" : "available",
"update_time" : "2022-11-08T10:07:28Z",
"volumeAttr" : "data",
"volumeName" : "ecm-bin005-volume-001",
"volumeSize" : 5,
"volumeSource" : "",
"volumeStatus" : "in-use",
"volumeType" : "SAS-public",
"volume_id" : "61f69121-4036-4f31-a148-457eb8a45fee",
"volume_type" : "SAS-public"
}
]
},
"details": "",
"message": "SUCCESS",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
错误码
请参考通用结果码。
