接口功能介绍
查询云硬盘快照列表。
接口是否审批
否
URI
GET /v4/ebs_snapshot/list-ebs-snap
Content-Type
application/json
路径参数
无
Query参数
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，请根据查询资源池列表接口返回值进行传参，获取“regionId”参数 | 参考请求示例 |
| diskID | 否 | String | 云硬盘ID | 参考请求示例 |
请求头header参数
无
请求体body参数
无
响应参数
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败）。 | 800 | |
| message | String | 失败时的错误描述，一般为英文描述。 | 参考响应示例 | |
| description | String | 失败时的错误描述，一般为中文描述。 | 参考响应示例 | |
| returnObj | Object | 返回数据结构体 | returnObj | |
| details | String | 可忽略 | 参考响应示例 | |
| errorCode | String | 业务细分码，为product.module.code三段式码。请参考错误码。 | 参考响应示例 | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码。请参考错误码。 | 参考响应示例 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| snapshotSize | Integer | 云硬盘快照使用量，单位B。 | 1024 | |
| snapshotTotal | Integer | 云硬盘快照总个数 | 24 | |
| snapshotList | Array of Objects | 云硬盘快照列表 | snapshotList | |
| snapshotManuTotal | Integer | 云硬盘手动快照总个数，只有传diskID查询时返回此字段。 | 8 |
表snapshotList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| availabilityZone | String | 可用区名称 | 参考响应示例 | |
| snapshotName | String | 云硬盘快照名称 | 参考响应示例 | |
| snapshotStatus | String | 云硬盘快照状态， creating/deleting/rollbacking /cloning/available/error， 分别对应创建中/ 删除中/回滚中 /从快照创建云硬盘中/ 可用/错误 |
参考响应示例 | |
| createTime | String | 创建时间 | 参考响应示例 | |
| azName | String | AZ名称 | 参考响应示例 | |
| deleteTime | String | 删除时间 | 参考响应示例 | |
| description | String | 描述信息 | 参考响应示例 | |
| expireTime | String | 过期时间 | 参考响应示例 | |
| freezing | Boolean | 是否被冻结 | true | |
| isEncryted | Boolean | 是否加密盘 | true | |
| isMaz | Boolean | 是否跨AZ | true | |
| regionID | String | regionID | 参考响应示例 | |
| isTalkOrder | Boolean | 是否是按需计费资源 | true | |
| retentionPolicy | String | 快照保留策略， custom/forever, 分别对应限时/永久 |
参考响应示例 | |
| retentionTime | String | 快照保留时间 | 参考响应示例 | |
| snapshotID | String | 快照ID | 参考响应示例 | |
| snapshotType | String | 快照类型，manu/timer, 分别对应手动/自动 |
参考响应示例 | |
| updateTime | String | 更新时间 | 参考响应示例 | |
| volumeAttr | String | 云硬盘属性， data/system, 分别对应数据盘/系统盘 |
参考响应示例 | |
| volumeName | String | 云硬盘名称 | 参考响应示例 | |
| volumeSize | Integer | 云硬盘大小 | 24 | |
| volumeSource | String | 云硬盘来源，如果为空， 则是普通云硬盘， 如果不为空， 则是由快照创建而来， 显示来源快照ID |
参考响应示例 | |
| volumeStatus | String | 云硬盘的状态， in-use/available/error /freezing/deleting/ Restoringbackup/ resizing/type_changing/ rollbacking/destroying/ snapshot_creating |
参考响应示例 | |
| diskID | String | 云硬盘ID | 参考响应示例 | |
| volumeType | String | 云硬盘类型, SATA/SAS/SSD-genric/ SSD/FAST-SSD/XSSD-1/XSSD-2 |
参考响应示例 |
枚举参数
无
请求头header示例
{
}
请求url示例
无
请求体body示例
{
"regionID":"fc862f71-d629-4a0e-9fe0-b104963b3f05",
"diskID ":"61f69121-4036-4f31-a148-457eb8a45fee"
}
响应示例
{
"statusCode": 800,
"returnObj": {
"snapshotTotal": 1,
"snapshotManuTotal": 1,
"snapshotSize": 1024,
"snapshotList":[
{
"availabilityZone" : null,
"azName" : null,
"createTime" : "2022-11-08T10:07:28Z",
"deleteTime" : null,
"description" : "",
"expireTime" : null,
"freezing" : false,
"isEncryted" : false,
"isMaz" : false,
"isTalkOrder" : true,
"snapshotName" : "ksjdhfkkasjdhfk",
"regionID" : "73f321ea-62ff-11ec-a8bc-005056898fe0",
"retentionPolicy" : "forever",
"retentionTime" : 0,
"snapshotID" : "cafa8c74-42e7-4e32-921c-d7b2c75dac27",
"snapshotType" : "manu",
"snapshotStatus" : "available",
"updateTime" : "2022-11-08T10:07:28Z",
"volumeAttr" : "data",
"volumeName" : "ecm-bin005-volume-001",
"volumeSize" : 5,
"volumeSource" : "",
"volumeStatus" : "in-use",
"volumeType" : "SAS",
"diskID" : "61f69121-4036-4f31-a148-457eb8a45fee",
}
],
},
"details":"",
"message": "SUCCESS",
"description": "成功"
}
状态码
请参考状态码
