IT网管接口
推送网元实时数据
URL地址:http://<ip>:<port>/api/pushitdata
HTTP POST方式,请求参数为一个JSON字符串,示例如下:
json
[
{
"device_id": "IT001",
"device_name": "网元1",
"extensions": {},
"tables": [
{
"table_name": "接口信息",
"headers": [
{
"header_name": "序号",
"show": false
},
{
"header_name": "监控项名称",
"show": true,
"width": 0.25
},
{
"header_name": "接收包丢弃数",
"show": true,
"width": 0.25
},
{
"header_name": "接收包错误数",
"show": true,
"width": 0.25
},
{
"header_name": "入流量",
"show": true,
"width": 0.25
}
],
"values": [
[
"1",
"Gi0/1",
"0",
"0",
"0bps"
],
[
"2",
"Gi0/2",
"1",
"0",
"80bps"
]
]
},
{
"table_name": "CPU",
"headers": [
{
"header_name": "序号",
"show": true,
"width": 0.25
},
{
"header_name": "监控项名称",
"show": true,
"width": 0.25
},
{
"header_name": "读数",
"show": true,
"width": 0.25
},
{
"header_name": "最新数据时间",
"show": true,
"width": 0.25
}
],
"values": [
[
"1",
"CPU使用率",
"39%",
"2024-04-11 14:13:22"
]
]
}
]
}
]
JSON是一个数组对象,每个对象就是一个网元设备。可以一次性推送1~n个网元设备数据,单次推送数据量建议不要超过1M。
网元设备对象字段描述
属性名称 | 说明 |
---|---|
device_id | 网元设备唯一ID |
device_name | 网元设备名称 |
extensions | 扩展,留作后用,默认给个空对象{} 即可 |
tables | 数据表格,数组对象,可以有多个表格 |
网元数据表格对象字段描述
属性名称 | 说明 |
---|---|
table_name | 表格名称 |
headers | 表头,数组对象 |
values | 数据值,二维数组对象,每个一维数组表示一条数据记录,一维数组的元素个数应与表头的元素个数保持一致 |
表头对象字段描述
属性名称 | 说明 |
---|---|
header_name | 表头名称 |
show | 是否显示该列,布尔类型 |
width | 该列显示的宽度占比,用小数表示。如果show为false,则可以不定义;所有列宽加起来应该刚好等于1。 |
HTTP返回结果为一个JSON字符串,示例如下:
json
{
"code": "1",
"message": "推送网元实时数据成功!"
}
其中,code表示接口执行状态,值为“0”(失败)或“1”(成功);message表示消息。
注意
请勿推送网元实时告警,实时告警有专门的推送接口,参考下文。
推送网元实时告警
URL地址:http://<ip>:<port>/api/pushitalarm
HTTP POST方式,请求参数为一个JSON字符串,示例如下:
json
[
{
"alarm_id": "a0001",
"device_id": "IT001",
"alarm_content": "网络Ping不同",
"start_time": "2024-04-11 15:16:41"
},
{
"alarm_id": "a0002",
"device_id": "IT002",
"alarm_content": "无SNMP数据可收集",
"start_time": "2024-04-11 15:16:41"
}
]
JSON是一个数组对象,每个对象就是一条网元实时告警数据。需要一次性推送所有网元的实时告警数据,DCVM在写入实时告警数据之前,会把之前的实时告警数据清空!
网元实时告警对象字段描述
属性名称 | 说明 |
---|---|
alarm_id | 告警唯一ID |
device_id | 网元设备唯一ID |
alarm_content | 告警内容描述 |
start_time | 告警开始时间 |
HTTP返回结果为一个JSON字符串,示例如下:
json
{
"code": "1",
"message": "推送网元实时告警成功!"
}
其中,code表示接口执行状态,值为“0”(失败)或“1”(成功);message表示消息。