接口功能介绍
导出指定时间段内的站点监控时序指标监控数据,导出格式为csv文件。
接口约束
regionID(资源池)、deviceUUIDList(站点监控资源)、itemNameList(待查监控项名称)存在。
URI
POST /v4/monitor/export-sitemonitor-historymetricdata
请求参数
请求体body参数
参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
---|---|---|---|---|---|
regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
itemNameList | Array of String | 是 | ["ping_average_response_ms"] | 待查的监控项名称 | |
startTime | String | 是 | 1667815639 | 查询起始时间戳 | |
endTime | String | 是 | 1667817639 | 查询结束时间戳 | |
deviceUUIDList | Array of String | 是 | ["hxfi20221027191319"] | 查询设备ID列表 | |
period | Integer | 否 | 300 | 聚合周期,单位:秒,默认300 |
响应参数
根据请求参数导出监控数据为csv文件。
文件内容按照设备deviceUUID分隔,不同设备的数据以栏(多个行)为单位竖向排列。
同一设备的不同指标,按照时间戳横向排列,无数据则为空。
请求失败,返回参数参考历史监控数据查询系列接口。
请求示例
POST /v4/monitor/export-sitemonitor-historymetricdata
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"startTime": "1667815639",
"endTime": "1667817639",
"itemNameList": [
"ping_average_response_ms"
],
"deviceUUIDList": [
"hxfi20221027191319"
]
}
响应示例
csv文件内容:
deviceUUID,ping_average_response_ms,samplingTime
hxfi20221027191319,11.416,1667815639
hxfi20221027191319,11.431,1667816239
hxfi20221027191319,11.43,1667816539
hxfi20221027191319,11.58,1667816839
hxfi20221027191319,11.468,1667817139
hxfi20221027191319,11.419,1667817439
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
Monitor.DataQuery.RegionNotFound | 找不到资源池 |
Monitor.DataQuery.ItemNameUndefined | 监控项未定义 |
Monitor.DataQuery.QueryError | 查询数据失败 |
Monitor.DataQuery.AccessFailed | 访问内部系统失败 |
Monitor.DataQuery.ResponseError | 访问内部系统返回错误 |
其他 | 参见公共错误码说明 |