接口功能介绍
查询某个region下的快照总量。
接口约束
无
接口是否审批
否
URI
GET /v4/ebs_snapshot/query_size-ebs-snap
Content-Type
application/json
路径参数
无
Query参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
regionID | 是 | 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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
snapshotTotalSize | Integer | region下的所有云硬盘快照的使用量,单位B。 | 1024 | |
snapshotTotalCount | Integer | 云硬盘快照数量 | 2 | |
azDisplayName | String | az展示名称 | 参考响应示例 | |
details | Array of Objects | 不同类型的快照占用的使用量详情 | details |
表 details
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
volumeType | String | 云硬盘类型,SATA/SAS/SSD-genric/SSD/FAST-SSD/XSSD-1/XSSD-2 | 参考响应示例 | |
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":""
}
}
状态码
请参考状态码