接口功能介绍
调用此接口可查询用户在指定资源池云主机监控中内存使用率Top-N。
接口约束
regionID(资源池)存在。
URI
POST /v4/monitor/query-mem-top
请求参数
请求体body参数
参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
---|---|---|---|---|---|
regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
number | Integer | 否 | 3 | 选取TOP值的数量,不传默认为3,当传入值或默认值超过用户实际拥有的资源数量,以用户的实际资源数量为准 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Success | |
msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 返回对象 | returnObj |
表returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
memList | Array of Objects | 内存利用率列表 | mem |
表mem
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
deviceID | String | 设备ID | 3080069a-ca2b-fca1-f038-5e6e00dd7630 | |
name | String | 设备名字 | ecm-be47 | |
value | String | 内存利用率的值 | 78.1777 |
请求示例
POST /v4/monitor/query-mem-top
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"number":3
}
响应示例
{
"statusCode":800,
"returnObj":{
"memList":[
{
"deviceID":"b7862cdf-6b1b-bdfd-8410-ba71d2a7ecb8",
"name":"ecm-71e7",
"value":"79.4129"
},
{
"deviceID":"43eaf44d-aa29-ceee-7ac1-32d3251b3c29",
"name":"as-config-82abuz79",
"value":"78.4591"
},
{
"deviceID":"3080069a-ca2b-fca1-f038-5e6e00dd7630",
"name":"ecm-be47",
"value":"78.1777"
}
]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
其他 | 参见公共错误码说明 |