云主机备份统计
接口功能介绍
统计用户虚机盘总大小及备份总个数
准备工作 :
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
1.使用限制,本接口只支持在拉萨3、上海7、广州6、郴州2、长沙3、北京5、内蒙6、南京3、重庆2、合肥2、成都4、晋中、昆明2、乌鲁木齐27、福州25、衡阳3、长沙37、张家界2、华北2、央企北京1、华东1、上海32、上海33、上海36资源池进行公测
2.目前非多可用区类型资源池只返回默认企业项目下的备份统计信息。
URI
POST /v4/ecs/backup-instance-resource
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取:查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
totalVolumeSize | Integer | 虚机磁盘占用大小 | 510 | |
totalBackupCount | Integer | 磁盘备份个数 | 12 |
请求示例
请求头header
无
请求体body
示例:查询云主机的磁盘总容量,和磁盘备份的个数
{
"regionID": "bb9fdb42056f11eda1610242ac110002"
}
响应示例
{
"returnObj": {
"totalVolumeSize": 0,
"totalBackupCount": 0
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
EcsBackup.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
EcsBackup.Backup.QueryFailed | 查询云主机备份失败 |