实时监控数据查询
实时监控数据：查询
接口功能介绍
查询指定设备的实时监控数据。
接口约束
参见请求参数说明。
URI
POST /v4.2/monitor/query-latest-metric-data
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| service | 是 | String | 云监控服务，具体服务参见云监控：查询服务维度及监控项 | ecs | |
| dimension | 是 | String | 云监控维度，具体维度参见云监控：查询服务维度及监控项 | ecs | |
| itemNameList | 是 | Array of Strings | 待查监控项名称，单次请求长度限制为10，具体设备对应监控项参见云监控：查询服务维度及监控项 | ['cpu_util','disk_write_bytes_rate'] | |
| dimensions | 是 | Array of Objects | 查询设备标签列表，用于定位目标设备，多标签查询取交集，单次请求设备数量限制为10 | dimension |
表 dimension
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 设备标签键 | uuid | |
| value | 是 | Array of Strings | 设备标签键所对应的值，最大数量限制为10 | ['9dc48979-4e19-45e2-b523-5d3c70d516b3'] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| itemList | Array of Objects | 监控项数据 | itemList |
表 itemList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| itemName | String | 监控项名称，具体设备对应监控项参见云监控：查询服务维度及监控项 | cpu_util | |
| itemDesc | String | 监控项中文介绍 | CPU使用率 | |
| itemUnit | String | 监控项单位 | bit/s | |
| value | Float | 监控项值，具体请参考对应监控项文档 | 0.2169 | |
| timestamp | Integer | 监控数据采样Unix时间戳 | 1667816712 | |
| dimensions | Array of Objects | 监控项标签 | dimension |
表 dimension
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 监控项标签键 | uuid | |
| value | String | 监控项标签键对应的值 | 9dc48979-4e19-45e2-b523-5d3c70d516b3 |
请求示例
请求url
/v4.2/monitor/query-latest-metric-data
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"service":"ecs",
"dimension":"ecs",
"itemNameList":[
"cpu_util",
"disk_util"
],
"dimensions":[
{
"name":"uuid",
"value":[
"000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"00229aa9-ce6b-b46f-4b7d-df61f48a5903"
]
}
]
}
响应示例
{
"statusCode":800,
"returnObj":{
"itemList":[
{
"itemName":"cpu_util",
"itemDesc":"CPU使用率",
"itemUnit":"%",
"value":0.2169,
"timestamp":1666251788,
"dimensions":[
{
"name":"uuid",
"value":"000f0322-1f4d-8cc8-bb2e-1c30fb751aa5"
}
]
},
{
"itemName":"disk_util",
"itemDesc":"磁盘使用率",
"itemUnit":"%",
"value":7.6032,
"timestamp":1666251788,
"dimensions":[
{
"name":"uuid",
"value":"000f0322-1f4d-8cc8-bb2e-1c30fb751aa5"
}
]
}
]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Openapi.RegionInfo.Empty | 找不到资源池 |
| Openapi.Parameter.Error | 请求参数错误，可能是未传入必填项、参数类型错误、参数范围错误 |
| Monitor.DataQuery.AccessFailed | 访问内部系统失败 |
| Monitor.DataQuery.ResponseError | 访问内部系统返回错误 |
