接口功能介绍
查询用户云主机统计信息
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
指定企业项目ID（projectID）查询时，确保企业项目ID对应的企业项目存在
URI
GET /v4/ecs/statistics-instance
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| projectID | 否 | String | 企业项目ID，企业项目管理服务提供统一的云资源按企业项目管理，以及企业项目内的资源管理，成员管理。您可以通过查看创建企业项目了解如何创建企业项目 | 0 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceStatistics | Object | 分页明细 | instanceStatistics |
表 instanceStatistics
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| totalCount | Integer | 云主机总数 | 85 | |
| RunningCount | Integer | 运行中的云主机数量 | 1 | |
| shutdownCount | Integer | 关机数量 | 2 | |
| expireCount | Integer | 过期数量 | 0 | |
| expireRunningCount | Integer | 过期运行中数量 | 0 | |
| expireShutdownCount | Integer | 过期已关机数量 | 0 | |
| cpuCount | Integer | cpu数量 | 90 | |
| memoryCount | Integer | 内存总量，单位为GB | 100 |
枚举参数
无
请求示例
请求url
示例1：查询当前资源池所有云主机的统计信息
查询华东1资源池下所有云主机统计信息
GET '.../v4/ecs/statistics-instance?regionID=bb9fdb42056f11eda1610242ac110002'
示例2：查询当前资源池下，指定企业项目的云主机统计信息
查询华东1资源池下，projectID为6732237e53bc4591b0e67d750030ebe3云主机统计信息
GET '.../v4/ecs/statistics-instance?regionID=bb9fdb42056f11eda1610242ac110002&projectID=6732237e53bc4591b0e67d750030ebe3'
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"instanceStatistics": {
"totalCount": 85,
"cpuCount": 90,
"shutdownCount": 2,
"expireCount": 0,
"memoryCount": 100,
"expireRunningCount": 0,
"RunningCount": 1,
"expireShutdownCount": 0
}
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
