工地盒子项目
v1.0.0
Base URLs:
用户管理
POST 登录
POST /api/user/login
Body 请求参数
1
2
3
4
{
"username": "admin",
"password": "111111"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
» username | body | string | 是 | none |
» password | body | string | 是 | none |
返回示例
成功
1
2
3
{
"code": 0
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none |
GET 查询
GET /api/user/query
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
id | query | string | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
POST 更新
POST /api/user/update
Body 请求参数
1
2
3
4
5
{
"id": 1,
"username": "admin",
"password": "123456"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 删除
GET /api/user/delete
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
id | query | string | 否 | none |
返回示例
成功
1
2
3
{
"code": 0
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | integer | true | none | none |
GET 列表
GET /api/user/list
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
相机管理
POST 更新
POST /api/setting/camera/update
Body 请求参数
1
2
3
4
5
{
"id": 1,
"name": "person",
"url": "rtsp://192.169.4.16/test-presoncount.mp4"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
» id | body | number | 是 | none |
» name | body | string | 是 | none |
» url | body | string | 是 | none |
返回示例
成功
1
2
3
{
"code": 0
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none |
POST 删除
POST /api/setting/camera/delete
Body 请求参数
1
2
3
4
5
6
7
8
9
10
{
"ids": [
1,
2,
3,
4,
6,
5
]
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
» ids | body | [number] | 是 | none |
返回示例
成功
1
2
3
{
"code": 0
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none |
zjy_test/任务
POST 编辑
POST /api/setting/task/update
Body 请求参数
1
2
3
4
5
6
7
8
9
10
11
12
13
{
"id": "3o8Tv",
"name": "task-123",
"start": 0,
"source": 1,
"schedulerType": "Daemon",
"models": {
"id": 1,
"duration": " ",
"start": " ",
"end": " "
}
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
» id | body | number | 是 | none |
» name | body | string | 是 | none |
» start | body | number | 是 | none |
» source | body | number | 否 | none |
» schedulerType | body | string | 是 | none |
» models | body | string | 是 | none |
返回示例
成功
1
2
3
{
"code": 0
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none |
GET 播放视频
GET /api/video/1p20U
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
POST 删除区域
POST /api/setting/task/update_task_config
Body 请求参数
1
2
3
4
5
{
"alert_time": 3,
"detect_region": null,
"threshold": 60
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
zjy_test/告警
POST 告警列表
POST /api/setting/warning_record/list
Body 请求参数
1
2
3
4
5
6
7
{
"page_size": 10,
"page": 1,
"event_id": 0,
"start_time": null,
"end_time": null
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
成功
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"code": 0,
"curr_page": 1,
"list": [
{
"boxes": "{'one':1, 'name':'hello'}",
"camera": 1,
"id": 1,
"manualLabel": 0,
"name": "one",
"task": 1,
"time": "2023-6-2 17:45:54",
"url": "/data/dagger/static/pic/one.jpg"
}
],
"total_count": 1,
"total_page": 1
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none | |
» curr_page | number | true | none | none | |
» list | [object] | true | none | none | |
»» id | number | true | none | none | |
»» name | string | true | none | none | |
»» task | number | true | none | none | |
»» camera | number | true | none | none | |
»» time | string | true | none | none | |
»» manualLabel | number | true | none | none | |
»» url | string | true | none | none | |
»» boxes | string | true | none | none |
POST 标记
POST /api/setting/warning_record/remark
Body 请求参数
1
2
3
4
{
"id": 289,
"manualLabel": 0
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
» id | body | number | 是 | none |
» manualLabel | body | number | 是 | none |
返回示例
成功
1
2
3
{
"code": 0
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none |
GET 清空告警数据
GET /api/setting/warning_record/clear
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
zjy_test/管理员
POST 删除任务数据库表
POST /api/admin/destroy_task
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
zjy_test/unit_test
POST 测试mg_send
POST /api
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
设备
GET 授权信息
GET /api/device/licence_info
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
POST 更新授权码
POST /api/device/update_licence
Body 请求参数
1
2
3
{
"licence": "HFWYU4MP-NEW6GQLD-HFWYU4MK-PFWYU4MK-6PWQUJEB-MDWWU4MK-PFXUSS53-7F8WU4QK-PFWYU4MK-PFXZ24K6-2FXYUMGK"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 机器码信息
GET /api/device/mc_info
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 设备信息
GET /api/device/info
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 获取系统配置
GET /api/device/system_config
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
PUT 更新系统配置
PUT /api/device/system_config
Body 请求参数
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
"enableNotifyEvent": false,
"autoDeleteEventThreshold": 3999,
"enableGddRecycleData": false,
"reportEventDrawImageWithROI": false,
"eventSubscribers": [
{
"address": "http://192.169.4.15",
"appKeyId": "aaassbbb",
"appKeySecret": "123",
"enable": true,
"health": true,
"name": "aaa",
"uploadType": 7
},
{
"address": "http://192.169.4.15",
"appKeyId": "aaassbbb",
"appKeySecret": "123",
"enable": true,
"health": true,
"name": "aaa",
"uploadType": 7
}
]
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
POST 更新设备信息
POST /api/device/update
Body 请求参数
1
2
3
{
"name": "aaa"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 网络地址
GET /api/device/network
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 设备时间
GET /api/device/systime
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
任务管理
POST 重置
POST /api/setting/task/reset
Body 请求参数
1
2
3
{
"id": 1
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
POST 重启
POST /api/setting/task/restart
Body 请求参数
1
2
3
{
"id": 1
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
POST 启动-2
POST /api/setting/task/start
Body 请求参数
1
2
3
{
"id": "h12t8"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
POST 暂停-2
POST /api/setting/task/stop
Body 请求参数
1
2
3
{
"id": "h12t8"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
POST 预览
POST /api/setting/task/preview
Body 请求参数
1
2
3
{
"id": 1
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 播放视频
GET /api/video/21nWT
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
告警管理
POST 预览
POST /api/setting/warning_record/preview
Body 请求参数
1
2
3
{
"id": 1
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
POST 创建
POST /api/setting/warning_record/add
Body 请求参数
1
2
3
4
5
6
7
{
"name": "one",
"url": "/data/dagger/static/pic/one.jpg",
"task": 1,
"camera": 1,
"boxes": "{'one':1, 'name':'hello'}"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
POST 大屏-折线图
POST /api/setting/warning_record/count
Body 请求参数
1
2
3
4
{
"count": 7,
"cur_time": "2023-07-24"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
成功
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"code": 0,
"curr_page": 1,
"list": [
{
"boxes": "{'one':1, 'name':'hello'}",
"camera": 1,
"id": 1,
"manualLabel": 0,
"name": "one",
"task": 1,
"time": "2023-6-2 17:45:54",
"url": "/data/dagger/static/pic/one.jpg"
}
],
"total_count": 1,
"total_page": 1
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none | |
» curr_page | number | true | none | none | |
» list | [object] | true | none | none | |
»» id | number | true | none | none | |
»» name | string | true | none | none | |
»» task | number | true | none | none | |
»» camera | number | true | none | none | |
»» time | string | true | none | none | |
»» manualLabel | number | true | none | none | |
»» url | string | true | none | none | |
»» boxes | string | true | none | none |
POST 查看告警图
POST /api/setting/warning_record/view
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
id | query | string | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
POST 获取检测框信息
POST /api/setting/warning_record/box
Body 请求参数
1
2
3
{
"id": 1
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
POST 根据事件id查询
POST /api/setting/warning_record/query_id
Body 请求参数
1
2
3
4
5
{
"page": 2,
"page_size": 5,
"event_id": 10018
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
rk_platform/相机
POST 添加
POST /api/setting/camera/add
Body 请求参数
1
2
3
4
{
"name": "company",
"url": "rtsp://admin:a1234567@192.169.7.123:554"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
» name | body | string | 是 | none |
» url | body | string | 是 | none |
返回示例
成功
1
2
3
4
{
"code": 0,
"id": 1
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none | |
» id | number | true | none | none |
GET 列表
GET /api/setting/camera/list
返回示例
成功
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"code": 0,
"curr_page": 1,
"list": [
{
"id": 1,
"name": "fire",
"updatedtime": "2023-6-2 17:27:48",
"url": "rtsp://192.169.4.16/test_fire_smoke.mp4"
}
],
"total_count": 1,
"total_page": 1
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none | |
» curr_page | number | true | none | none | |
» list | object | true | none | none | |
»» id | number | true | none | none | |
»» name | string | true | none | none | |
»» updatedtime | string | true | none | none | |
»» url | string | true | none | none | |
» total_count | number | true | none | none | |
» total_page | number | true | none | none |
rk_platform/算法
GET 列表
GET /api/setting/algorithm/list
返回示例
成功
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"code": 0,
"curr_page": 1,
"list": [
{
"id": 1,
"name": "烟火检测",
"product": "1684-SOC",
"updatedtime": "2023-6-2 17:35:10",
"vendor": "BITMAINLAND"
}
],
"total_count": 1,
"total_page": 1
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none | |
» curr_page | number | true | none | none | |
» list | [object] | true | none | none | |
»» id | number | true | none | none | |
»» product | string | true | none | none | |
»» vendor | string | true | none | none | |
»» updatedtime | string | true | none | none | |
» total_count | number | true | none | none | |
» total_page | number | true | none | none |
POST 上传
POST /api/setting/algorithm/upload
Body 请求参数
1
2
string
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
name | query | string | 否 | none |
body | body | string(binary) | 否 | none |
返回示例
成功
1
2
3
{
"code": 0
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none |
POST 删除
POST /api/setting/algorithm/batch_delete
Body 请求参数
1
2
3
4
5
6
7
{
"ids": [
1,
2,
3
]
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
» ids | body | [number] | 是 | none |
返回示例
成功
1
2
3
{
"code": 0
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none |
rk_platform/用户
GET 用户
GET /api/user/login
Body 请求参数
1
2
3
4
{
"username": "admin",
"password": "111111"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
POST 注册
POST /api/user/signup
Body 请求参数
1
2
3
4
{
"username": "admin",
"password": "111111"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
rk_platform/告警
GET 告警列表
GET /api/setting/warning_record/list
Body 请求参数
1
2
3
4
5
6
7
{
"page_size": 10,
"page": 1,
"event_id": 0,
"start_time": null,
"end_time": null
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
成功
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"code": 0,
"curr_page": 1,
"list": [
{
"boxes": "{'one':1, 'name':'hello'}",
"camera": 1,
"id": 1,
"manualLabel": 0,
"name": "one",
"task": 1,
"time": "2023-6-2 17:45:54",
"url": "/data/dagger/static/pic/one.jpg"
}
],
"total_count": 1,
"total_page": 1
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none | |
» curr_page | number | true | none | none | |
» list | [object] | true | none | none | |
»» id | number | true | none | none | |
»» name | string | true | none | none | |
»» task | number | true | none | none | |
»» camera | number | true | none | none | |
»» time | string | true | none | none | |
»» manualLabel | number | true | none | none | |
»» url | string | true | none | none | |
»» boxes | string | true | none | none |
POST 删除
POST /api/setting/warning_record/batch_delete
Body 请求参数
1
2
3
4
5
6
{
"ids": [
167,
165
]
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
成功
1
2
3
{
"code": 0
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none |
POST 大屏-获取最新告警
POST /api/setting/warning_record/latest
Body 请求参数
1
2
3
{
"count": 20
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
成功
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"code": 0,
"curr_page": 1,
"list": [
{
"boxes": "{'one':1, 'name':'hello'}",
"camera": 1,
"id": 1,
"manualLabel": 0,
"name": "one",
"task": 1,
"time": "2023-6-2 17:45:54",
"url": "/data/dagger/static/pic/one.jpg"
}
],
"total_count": 1,
"total_page": 1
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none | |
» curr_page | number | true | none | none | |
» list | [object] | true | none | none | |
»» id | number | true | none | none | |
»» name | string | true | none | none | |
»» task | number | true | none | none | |
»» camera | number | true | none | none | |
»» time | string | true | none | none | |
»» manualLabel | number | true | none | none | |
»» url | string | true | none | none | |
»» boxes | string | true | none | none |
rk_platform/任务
GET 列表
GET /api/setting/task/list
返回示例
成功
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"code": 0,
"curr_page": 1,
"list": [
{
"id": 1,
"models": "one",
"name": "task2",
"schedulerType": "Daemon",
"source": 1,
"start": 1
}
],
"total_count": 1,
"total_page": 1
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none | |
» curr_page | number | true | none | none | |
» list | [object] | true | none | none | |
»» id | number | true | none | none | |
»» name | string | true | none | none | |
»» schedulerType | string | true | none | none | |
»» source | number | true | none | none | |
»» start | number | true | none | none | |
» total_count | number | true | none | none | |
» total_page | number | true | none | none |
POST 创建
POST /api/setting/task/add
Body 请求参数
1
2
3
4
5
6
7
8
9
10
11
12
{
"name": "区域入侵",
"start": 0,
"source": 1,
"schedulerType": "Daemon",
"models": {
"id": 4,
"duration": " ",
"start": " ",
"end": " "
}
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
成功
1
2
3
4
{
"code": 0,
"id": 1
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none | |
» id | number | true | none | none |
POST 删除
POST /api/setting/task/delete
Body 请求参数
1
2
3
4
5
{
"ids": [
"iY4N9"
]
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
» ids | body | [number] | 是 | none |
返回示例
成功
1
2
3
{
"code": 0
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | number | true | none | none |
GET 播放视频
GET /api/video/KLco3
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 获取任务配置
GET /api/setting/task/get_task_config
Body 请求参数
1
2
3
{
"id": "8Q45w"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
body | body | object | 否 | none |
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
rk_platform/管理员
POST 删除告警数据库表
POST /api/admin/destroy_warning
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
接口文档
GET 接口文档列表
GET /api/docs/api_list
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 相机列表接口文档
GET /api/docs/file/camera/list
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 事件推送接口文档
GET /api/docs/file/warning_record/upload_alarm
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 添加相机接口文档
GET /api/docs/file/camera/add
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 告警列表接口文档
GET /api/docs/file/warning_record/list
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 更新相机接口文档
GET /api/docs/file/camera/update
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 删除相机接口文档
GET /api/docs/file/camera/delete
返回示例
200 Response
1
{}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 查看告警图接口文档
GET /api/docs/file/warning_record/view
返回示例
成功
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 删除告警接口文档
GET /api/docs/file/warning_record/delete
返回示例
成功
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 标记告警接口文档
GET /api/docs/file/warning_record/remark
返回示例
成功
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
GET 告警计数接口文档
GET /api/docs/file/warning_record/count
返回示例
成功
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |