接口功能介绍
天翼云云硬盘快照服务以云硬盘的快照使用总容量为粒度进行统计并计费。您可以查询某个资源池下的快照使用量，快照使用总容量为当前云硬盘中所有快照的数据块所占用的存储空间之和。
接口约束
无
接口是否审批
否
URI
GET /v4/ebs_snapshot/query_size-ebs-snap
Content-Type
application/json
路径参数
无
Query参数
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 资源池ID。 | fc862f71-d629-4a0e-9fe0-b104963b3f05 |
请求头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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| snapshotTotalSize | Integer | region下的所有云硬盘快照的使用量，单位为B。 | 1024 | |
| snapshotTotalCount | Integer | 云硬盘快照数量。 | 2 | |
| azDisplayName | String | 可用区名称。 | 参考响应示例 | |
| details | Array of Objects | 不同类型的快照占用的使用量详情。 | details |
表 details
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| volumeType | String | 云硬盘类型，取值为： ●SATA：普通IO。 ●SAS：高IO。 ●SSD：超高IO。 ●FAST-SSD：极速型SSD。 ●XSSD-0、XSSD-1、XSSD-2：X系列云硬盘。 | 参考响应示例。 | |
| snapshotSize | Integer | 单个类型的云硬盘的快照使用量，单位为B。 | 1024 |
枚举参数
无
请求头header示例
{
}请求url示例
.../v4/ebs_snapshot/query_size-ebs-snap?regionID=fc862f71-d629-4a0e-9fe0-b104963b3f05请求体body示例
无
响应示例
{
"statusCode":800,
"message":"SUCCESS",
"description":"成功",
"details":"",
"returnObj":{
"snapshotTotalSize":1024,
"snapshotTotalCount":2,
"details":[
{
"volumeType":"SATA",
"snapshotSize":1024
}
],
"azDisplayName":""
}
}
状态码
请参考状态码
错误码
请参考错误码
