1. 设备查询
- 接口功能描述：对设备信息查询；
- 接口路径：[GET] http://设备IP:9091/ks/device；
- 请求参数说明：无
- 请求示例；
| 项目 | 详情 |
|---|---|
| 请求格式 | Query String |
- 响应参数说明；
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| error_code | Int | 返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误 |
| message | String | 返回响应信息 |
| data | Object | 返回数据,具体字段看下发接口 |
- 响应示例。
| 项目 | 详情 |
|---|---|
| 报文格式 | JSON |
| 报文内容 |
{
"error_code": 0,
"message": {
"zh": "查询设备信息成功！",
"en": "Query device information successful!"
},
"data": {
"id": 1,
"device_id": "881b4776-30f2-47ee-b191-579d262d40ad",
"device_name": "盒子99",
"device_desc": ""
}
}
|
2. HTTP告警推送headers配置
- 接口功能描述：修改HTTP告警推送的headers；
- 接口路径：[PUT] http://设备IP:9091/ks/api/http/headers;
- 请求参数说明；
| 参数名称 | 数据类型 | 是否必须 | 说明 |
|---|---|---|---|
| headers | File | 是 | python文件，应为.py类型文件 |
表. 请求参数
- 请求示例；
| 项目 | 详情 |
|---|---|
| 请求格式 | Form Data |
| headers | (binary) |
- 响应参数说明；
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| error_code | Int | 返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误 |
| message | String | 返回响应信息 |
| data | Object | 返回数据,具体字段看下发接口 |
- 响应示例。
| 项目 | 详情 |
|---|---|
| 报文格式 | JSON |
| 报文内容 |
{
"error_code": 0,
"message": {
"zh": "更新http headers文件成功！",
"en": "Update http headers file successful!"
},
"data": null
}
|
回复