接口功能介绍
查询指定时间段内的监听器时序指标监控数据。
接口约束
regionID（资源池）、deviceUUIDList（监听器资源）、itemNameList（待查监控项名称）存在。
URI
POST /v4/monitor/query-listener-historymetricdata
请求参数
请求体body参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
| itemNameList | Array of String | 是 | ["ls_scur"] | 待查的监控项名称 | |
| startTime | String | 是 | 1667815639 | 查询起始时间戳 | |
| endTime | String | 是 | 1667817639 | 查询结束时间戳 | |
| deviceUUIDList | Array of String | 是 | ["listener-nz7f02jdzb"] | 查询设备ID列表，具体值参考监控对象查询返回字段deviceUUID | |
| period | Integer | 否 | 300 | 聚合周期，单位：秒，默认300 | |
| pageNo | Integer | 否 | 1 | 页码，默认为1 | |
| page | Integer | 否 | 1 | 页码，默认为1，建议使用pageNo，该参数后续会下线 | |
| pageSize | Integer | 否 | 2 | 页大小，默认为20 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| result | Array of Objects | 返回数据结果 | result | |
| totalCount | Integer | 获取对象数据条数 | 14 | |
| totalPage | Integer | 总页数 | 1 | |
| currentCount | Integer | 当前页记录数 | 14 | |
| page | Integer | 页码，建议参考请求参数pageNo，该参数后续会下线 | 1 | |
| pageSize | Integer | 页大小，建议参考请求参数pageSize，该参数后续会下线 | 10 |
表result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 所属资源池ID | 81f7728662dd11ec810800155d307d5b | |
| fUID | String | 唯一键 | listener-nz7f02jdzb | |
| deviceUUID | String | 设备ID | listener-nz7f02jdzb | |
| fuserLastUpdated | String | 最近更新时间 | 2022-11-07 18:25:12 | |
| itemAggregateList | Array of Objects | 监控项值列表 | itemAggregateList |
表itemAggregateList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| {itemName} | Array of Objects | 监控项内容 | valueObject |
表valueObject
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| samplingTime | Integer | 监控数据采样时间 | 1667815639 | |
| value | String | 监控项值，具体请参考对应监控项文档 | 524288 |
请求示例
POST /v4/monitor/query-listener-historymetricdata
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"itemNameList": [
"ls_scur",
"ls_inpkts"
],
"startTime": "1667815639",
"endTime": "1667817639",
"pageNo": 1,
"pageSize": 10,
"deviceUUIDList": [
"listener-nz7f02jdzb"
]
}
响应示例
{
"statusCode":800,
"returnObj":{
"result":[
{
"regionID":"73f321ea-62ff-11ec-a8bc-005056898fe0",
"fUID":"listener-nz7f02jdzb",
"deviceUUID":"listener-nz7f02jdzb",
"fuserLastUpdated":"2022-10-14 15:03:28",
"itemAggregateList":{
"ls_scur":[
{
"value":"0",
"samplingTime":1665332264
},
{
"value":"0",
"samplingTime":1665332264
},
{
"value":"0",
"samplingTime":1665329264
}
],
"ls_inpkts":[
{
"value":"0",
"samplingTime":1665332264
},
{
"value":"0",
"samplingTime":1665332264
},
{
"value":"0",
"samplingTime":1665329264
}
]
}
}
],
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"page": 1,
"pageSize": 10
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.DataQuery.RegionNotFound | 找不到资源池 |
| Monitor.DataQuery.ItemNameUndefined | 监控项未定义 |
| Monitor.DataQuery.QueryError | 查询数据失败 |
| Monitor.DataQuery.AccessFailed | 访问内部系统失败 |
| Monitor.DataQuery.ResponseError | 访问内部系统返回错误 |
| 其他 | 参见公共错误码说明 |
