说明
当前接口使用前请使用资源池概况信息查询接口查询带对接的资源池信息,如资源池信息"regionVersion": "v4.0",即可使用;如资源池信息"regionVersion": "v3.0", 不可使用。
接口功能介绍
1、查询云硬盘快照列表;
2、查询云硬盘下快照使用量;
URI
GET /v4/ebs_snapshot/list-ebs-snap
请求参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,请根据查询资源池列表接口返回值进行传参,获取“regionId”参数 | 参考请求示例 | |
diskID | 否 | String | 云硬盘ID | 参考请求示例 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为失败) | 参考响应示例 | |
message | 是 | String | 失败时的错误描述,一般为英文描述 | 参考响应示例 | |
description | 是 | String | 失败时的错误描述,一般为中文描述 | 参考响应示例 | |
details | 是 | String | 可忽略 | 参考响应示例 | |
returnObj | 是 | Object | returnObj | 参考响应示例 | returnObj |
errorCode | 是 | String | 业务细分码,为product.module.code三段式码.参考通用结果码 | 参考响应示例 |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
snapshotSize | 是 | Integer | 云硬盘快照使用量,单位B | 参考响应示例 | |
snapshotTotal | 是 | Integer | 云硬盘快照总量 | 参考响应示例 | |
snapshotList | 是 | Array of Object | 云硬盘快照列表 | 参考响应示例 | snapshotList |
表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 | 是否被冻结 | 参考响应示例 | |
isEncryted | 是 | Boolean | 是否加密盘 | 参考响应示例 | |
isMaz | 是 | Boolean | 是否跨AZ | 参考响应示例 | |
regionID | 是 | String | regionID | 参考响应示例 | |
isTalkOrder | 是 | Boolean | 是否是按需计费资源 | 参考响应示例 | |
retentionPolicy | 是 | String | 快照保留策略,custom/forever,分别对应限时/永久 | 参考响应示例 | |
retentionTime | 是 | String | 快照保留时间 | 参考响应示例 | |
snapshotID | 是 | String | 快照ID | 参考响应示例 | |
snapshotType | 是 | String | 快照类型,manu/timer,分别对应手动/自动 | 参考响应示例 | |
updateTime | 是 | String | 更新时间 | 参考响应示例 | |
volumeAttr | 是 | String | 云硬盘属性,data/system,分别对应数据盘/系统盘 | 参考响应示例 | |
volumeName | 是 | String | 云硬盘名称 | 参考响应示例 | |
volumeSize | 是 | Integer | 云硬盘大小 | 参考响应示例 | |
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 | 参考响应示例 |
请求示例
请求头header
{
}
请求体body
{
"regionID":"fc862f71-d629-4a0e-9fe0-b104963b3f05",
"diskID ":"61f69121-4036-4f31-a148-457eb8a45fee"
}
响应示例
{
"statusCode": 800,
"returnObj": {
"snapshotTotal": 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": "成功"
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
错误码
请参考通用结果码。