7d61f114
 Liu Haoyu
查询功能修改;
|
1
2
3
4
5
6
7
8
9
|
# 1. 基础资源占用
## 1.1 获取指定module的输出
| 调用方式 | 接口地址 |
| ------------ | :-------------------------------------------------------- |
| POST | http://ip:port/occupationOfBasicResources/getInfoByModule |
| Content-Type | application/json;charset=UTF-8 |
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
10
11
12
13
|
| 请求参数 | | | | |
| -------- | -------- | ------ | ---- | ---- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| module | 功能编码 | string | 是 | |
|
|
7d61f114
Liu Haoyu
查询功能修改;
|
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
```
请求示例
{
"module": "disk_partitions"
}
```
| 返回结果 | | | |
| -------- | -------- | ------ | -------------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 返回提示信息 |
| data | 返回信息 | string | 200,返回操作成功；其他code对应失败信息 |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": []// 对应module返回内容信息
}
```
## 1.2 jar包发布
| 调用方式 | 接口地址 |
| ------------ | :------------------------------------------------------ |
| POST | http://ip:port/occupationOfBasicResources/deployJarFile |
| Content-Type | application/json;charset=UTF-8 |
|
|
f1d1834f
Liu Haoyu
代码重构;
|
44
45
46
47
48
49
50
|
| 请求参数 | | | | |
| ----------- | ------------- | ------ | ---- | -------------------------------------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| filePath | jar包保存位置 | string | 是 | jar包保存位置 |
| logPath | 日志输出位置 | string | 否 | 默认jar包相同位置名称和jar包文件名相同 |
| user | 用户信息 | string | 否 | 用户信息(权限用, 默认-1, 表示超级管理员权限) |
| startListen | 是否开启监听 | int | 否 | 传1 表示直接开始监听 |
|
|
7d61f114
Liu Haoyu
查询功能修改;
|
51
52
53
54
|
```
请求示例
{
|
|
f1d1834f
Liu Haoyu
代码重构;
|
55
56
57
58
|
"filePath": "/home/liuhaoyu/linuxTest/linuxTest-1.0-SNAPSHOT.jar",
"logPath": "/home/liuhaoyu/linuxTest/linuxTest.log",
"user": "1",
"startListen": "1"
|
|
7d61f114
Liu Haoyu
查询功能修改;
|
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
}
```
| 返回结果 | | | |
| -------- | -------- | ------ | ------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 返回提示信息 |
| data | 返回信息 | string | 发布包对应的进程id |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {
"taskId" : "12390"
}
}
```
## 1.3 获取当前进行中的java服务
| 调用方式 | 接口地址 |
| ------------ | :-------------------------------------------------------- |
| POST | http://ip:port/occupationOfBasicResources/getJpsInfo |
| Content-Type | application/json;charset=UTF-8 |
| 返回结果 | | | |
| -------- | -------- | -------- | ------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 返回提示信息 |
| data | 返回信息 | string | |
| +process | 线程信息 | string[] | 对应的进程信息 |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {
"process": [
"39921 Jps",
"39864 linuxListener-0.0.1-SNAPSHOT.jar"
]
}
}
```
## 1.4 停止jar包进程
| 调用方式 | 接口地址 |
| ------------ | :---------------------------------------------------- |
| POST | http://ip:port/occupationOfBasicResources/killJarTask |
| Content-Type | application/json;charset=UTF-8 |
| 请求参数 | | | | |
| -------- | -------- | ------ | ---- | ---------------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| taskId | 进程号 | string | 是 | 需要停止的进程号 |
| user | 用户信息 | string | 是 | 用户信息(做权限控制用) |
```
请求示例
{
"user": "-1",
"taskId": "37527"
}
```
| 返回结果 | | | |
| -------- | -------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {}
}
```
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
147
148
149
|
## 1.5 配置启动服务
### 1.5.1 创建
|
|
42a94730
Liu Haoyu
可视化功能完善;
|
150
151
152
153
|
| 调用方式 | 接口地址 |
| ------------ | :-------------------------------------- |
| POST | http://ip:port/background/createService |
| Content-Type | application/json;charset=UTF-8 |
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
154
|
|
|
14574303
Liu Haoyu
接口文档参数修改;
|
155
156
157
158
159
160
161
162
163
|
| 请求参数 | | | | |
| ------------ | ------------ | ------- | ---- | -------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| config | 配置内容 | | 是 | |
| +serviceName | 服务名称 | string | 是 | 服务名称 |
| items | 配置参数信息 | | | |
| +itemName | 配置参数名称 | string | 是 | 配置参数名称 |
| +itemValue | 配置参数值 | string | 是 | 配置参数值 |
| +sort | 配置参数顺序 | Integer | 是 | 参数显示的顺序 |
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
164
165
166
167
|
```
请求示例
{
|
|
14574303
Liu Haoyu
接口文档参数修改;
|
168
169
170
171
172
173
174
175
|
"config":{
"serviceName" : "test service 1"
},
"items":[{
"itemName" : "port",
"itemValue" : 3000,
"sort" : 1
}]
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
}
```
| 返回结果 | | | |
| -------- | -------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {}
}
```
### 1.5.2 更新
|
|
42a94730
Liu Haoyu
可视化功能完善;
|
197
198
199
200
|
| 调用方式 | 接口地址 |
| ------------ | :-------------------------------------- |
| POST | http://ip:port/background/updateService |
| Content-Type | application/json;charset=UTF-8 |
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
201
|
|
|
14574303
Liu Haoyu
接口文档参数修改;
|
202
203
204
205
206
207
208
209
210
211
|
| 请求参数 | | | | |
| ------------ | ------------ | ------- | ---- | -------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| config | 配置内容 | | | |
| +id | 服务主键 | Integer | 是 | 主键 |
| +serviceName | 服务名称 | string | 是 | 服务名称 |
| items | 配置参数信息 | | | |
| +itemName | 配置参数名称 | string | 是 | 配置参数名称 |
| +itemValue | 配置参数值 | string | 是 | 配置参数值 |
| +sort | 配置参数顺序 | Integer | 是 | 参数显示的顺序 |
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
212
213
214
215
|
```
请求示例
{
|
|
14574303
Liu Haoyu
接口文档参数修改;
|
216
217
218
219
|
"config": {
"id": 1,
"serviceName": "1111"
}
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
"items": [
{"itemName": "1111",
"itemValue": "13",
"sort": 1},
...
]
}
```
| 返回结果 | | | |
| -------- | -------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {}
}
```
### 1.5.3 删除
|
|
42a94730
Liu Haoyu
可视化功能完善;
|
247
248
249
250
|
| 调用方式 | 接口地址 |
| ------------ | :-------------------------------------- |
| POST | http://ip:port/background/deleteService |
| Content-Type | application/json;charset=UTF-8 |
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
| 请求参数 | | | | |
| -------- | -------- | ------- | ---- | ------------------ |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| id | 服务主键 | Integer | 是 | 主键(formdata形式) |
```
请求示例
"id": 1
```
| 返回结果 | | | |
| -------- | -------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {}
}
```
|
|
42a94730
Liu Haoyu
可视化功能完善;
|
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
|
### 1.5.4 操作已经配置好的服务
| 调用方式 | 接口地址 |
| ------------ | :-------------------------------------- |
| POST | http://ip:port/background/serviceAction |
| Content-Type | application/json;charset=UTF-8 |
| 请求参数 | | | | |
| -------- | -------- | ------- | ---- | --------------------------------------------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| id | 服务主键 | Integer | 是 | 主键(formdata形式) |
| action | 操作类型 | String | 是 | start/status/restart/stop/remove/load(formdata形式) |
```
请求示例
"id": 1
"action": "start"
```
| 返回结果 | | | |
| -------- | -------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
| result | 操作结果 | string | 操作成功或者失败原因 |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {}
}
```
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
314
315
|
## 1.6 查询配置好的服务运行情况
|
|
42a94730
Liu Haoyu
可视化功能完善;
|
316
317
318
319
|
| 调用方式 | 接口地址 |
| ------------ | :------------------------------------- |
| POST | http://ip:port/background/serviceQuery |
| Content-Type | application/json;charset=UTF-8 |
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
| 请求参数 | | | | |
| ----------- | -------- | ------- | ---- | ---------------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| currentPage | 页码 | Integer | 是 | 页码(formdata形式) |
| pageVolume | 页面容量 | Integer | 是 | 页面容量(formdata形式) |
```
请求示例
{
"currentPage": 1,
"pageVolume": 20
}
```
| 返回结果 | | | |
| ----------- | ------------ | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
| +gpuId | 显卡id | String | 显卡id |
| +port | ip和端口号 | String | ip和端口号 |
| +items | 配置项 | String | 配置项 |
| +status | 运行状态 | String | 运行状态 |
| +updateTime | 最后更新时间 | String | 最后更新时间 |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": [
{
"gpuId": "1",
"port":"192.168.10.117:8845",
"items":"1,2,3,4,5,6",
"status":"0",
"updateTime":"2019-12-24 10:13:00"
},
...
]
}
```
|
|
bb33dcc2
Liu Haoyu
添加获取GPU的列表接口;
|
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
|
## 1.7 获取GPU的列表
| 调用方式 | 接口地址 |
| ------------ | :---------------------------------------------------- |
| POST | http://ip:port/occupationOfBasicResources/getGpuItems |
| Content-Type | application/json;charset=UTF-8 |
| 返回结果 | | | |
| -------- | ----------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
| +uuid | GPU对应uuid | String | GPU对应uuid |
| +index | gpu编号 | String | gpu编号 |
| +gpuName | GPU名称 | String | GPU名称 |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": [
{
"gpuName": "GeForce GTX 1080 Ti",
"index": "GPU 0",
"uuid": " GPU-99b735ea-99c6-a569-fadb-01f39ae045f7"
},
{
"gpuName": "GeForce RTX 2080",
"index": "GPU 1",
"uuid": " GPU-c8f60855-479c-6658-16d1-140dac044159"
},
{
"gpuName": "Tesla P4",
"index": "GPU 2",
"uuid": " GPU-0d60b67b-8df9-e3bb-2aa0-c632b1726ef1"
},
{
"gpuName": "Tesla P4",
"index": "GPU 3",
"uuid": " GPU-95e656d9-fbe3-b17c-3f37-a05814bbcc79"
}
]
}
```
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
411
412
|
|
|
7d61f114
Liu Haoyu
查询功能修改;
|
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
|
# 2. 日志监控
## 2.1 设置log文件所在位置信息
| 调用方式 | 接口地址 |
| ------------ | :----------------------------------- |
| POST | http://ip:port/logListener/setLogMsg |
| Content-Type | application/json;charset=UTF-8 |
| 请求参数 | | | | |
| -------- | ---------------- | ------ | ---- | ---------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| filePath | 日志文件存在位置 | string | 是 | 日志文件存在位置 |
```
请求示例
{
"filePath": "/home/liuhaoyu/linuxTest.log"
}
```
| 返回结果 | | | |
| -------- | ------------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
| +logKey | 监听用日志key | String | 监听用日志key |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {
"logKey": "linuxTest-1.0-SNAPSHOT.log|1575596806840"
}
}
```
## 2.2 开启日志监控输出
| 调用方式 | 接口地址 |
| ------------ | :------------------------------------------ |
| POST | http://ip:port/logListener/startLogListener |
| Content-Type | application/json;charset=UTF-8 |
| 请求参数 | | | | |
| -------- | ------------- | ------ | ---- | ------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| logKey | 监听用日志key | string | 是 | 监听用日志key |
```
请求示例
{
"logKey": "linuxTest-1.0-SNAPSHOT.log|1575596806840"
}
```
| 返回结果 | | | |
| -------- | -------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": null
}
```
## 2.3 获取日志的输出内容
| 调用方式 | 接口地址 |
| ------------ | :-------------------------------------- |
| POST | http://ip:port/logListener/getLogOutput |
| Content-Type | application/json;charset=UTF-8 |
| 请求参数 | | | | |
| -------- | ------------- | ------ | ---- | ------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| logKey | 监听用日志key | string | 是 | 监听用日志key |
```
请求示例
{
"logKey": "linuxTest-1.0-SNAPSHOT.log|1575596806840"
}
```
| 返回结果 | | | |
| -------- | -------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | String | 时间段内日志的具体输出 |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": "0\n****************swapUse*****************\n6810\n*****************memUse*****************\n执行命令[ cat /proc/meminfo]\n0\n****************swapUse*****************\n6808\n*****************memUse*****************\n执行命令[ cat /proc/meminfo]\n0\n****************swapUse*****************\n6806\n*****************memUse*****************\n执行命令[ cat /proc/meminfo]\n0\n****************swapUse*****************\n6804\n*****************memUse*****************\n执行命令[ cat /proc/meminfo]\n0\n****************swapUse*****************\n6799\n*****************memUse*****************\n执行命令[ cat /proc/meminfo]"
}
```
## 2.4 停止日志监控输出
| 调用方式 | 接口地址 |
| ------------ | :----------------------------------------- |
| POST | http://ip:port/logListener/stopLogListener |
| Content-Type | application/json;charset=UTF-8 |
| 请求参数 | | | | |
| -------- | ------------- | ------ | ---- | ------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| logKey | 监听用日志key | string | 是 | 监听用日志key |
```
请求示例
{
"logKey": "linuxTest-1.0-SNAPSHOT.log|1575596806840"
}
```
| 返回结果 | | | |
| -------- | -------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": null
}
```
|
|
f1d1834f
Liu Haoyu
代码重构;
|
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
|
## 2.5 获取所有正在监听中的日志
| 调用方式 | 接口地址 |
| ------------ | :-------------------------------------------- |
| POST | http://ip:port/logListener/getAllListeningLog |
| Content-Type | application/json;charset=UTF-8 |
| 返回结果 | | | |
| -------- | ------------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | 数组 | |
| +logKey | 日志存在的key | string | 日志存在的key |
| +logPath | 日志位置 | string | 日志位置 |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": [
{
"logKey": "linuxTest-1.0-SNAPSHOT-1575604486338.log|1575604486582",
"logPath": "/home/.../linuxTest/linuxTest-1.0-SNAPSHOT-1575604486338.log"
}
]
}
```
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
594
595
|
## 2.6 下载日志文件
|
|
2a1e7730
Liu Haoyu
新增服务内接口调用相关功能(接口文...
|
596
597
598
599
|
| 调用方式 | 接口地址 |
| ------------ | :---------------------------------- |
| POST | http://ip:port/logListener/download |
| Content-Type | application/json;charset=UTF-8 |
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
600
601
602
603
604
|
| 请求参数 | | | | |
| -------- | ------------- | ------ | ---- | --------------------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| logKey | 监听用日志key | string | 是 | 监听用日志key(formdata格式) |
|
|
f1d1834f
Liu Haoyu
代码重构;
|
605
|
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
|
| 返回结果 | | | |
| -------- | -------- | ------ | ----------------------------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败(成功时会直接开启下载) |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {}
}
```
|
|
7d61f114
Liu Haoyu
查询功能修改;
|
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
|
# 3. 监控器调度
## 3.1 获取正在生效的监控功能
| 调用方式 | 接口地址 |
| ------------ | :----------------------------------------- |
| POST | http://ip:port/background/getWorkingListener |
| Content-Type | application/json;charset=UTF-8 |
| 返回结果 | | | |
| -------- | ---------------- | -------- | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
| +result | 生效中的监控功能 | String[] | 生效中的监控功能 |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {
"result": [
"cpu_utilization",
"memory_info"
]
}
}
```
## 3.2 添加新的监控器
| 调用方式 | 接口地址 |
| ------------ | :------------------------------------------- |
| POST | http://ip:port/background/addWorkingListener |
| Content-Type | application/json;charset=UTF-8 |
| 请求参数 | | | | |
| -------- | ------------------ | -------- | ---- | ------------------ |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| modules | 添加到监听的功能id | string[] | 是 | 添加到监听的功能id |
```
请求示例
{
"modules": ["cpu_utilization", "memory_info"]
}
```
| 返回结果 | | | |
| -------- | -------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {}
}
```
## 3.3 删除存在的监控器
| 调用方式 | 接口地址 |
| ------------ | :---------------------------------------------- |
| POST | http://ip:port/background/removeWorkingListener |
| Content-Type | application/json;charset=UTF-8 |
| 请求参数 | | | | |
| -------- | ---------------- | -------- | ---- | ---------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| modules | 停止监听的功能id | string[] | 是 | 停止监听的功能id |
```
请求示例
{
"modules": ["cpu_utilization", "memory_info"]
}
```
| 返回结果 | | | |
| -------- | -------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {}
}
```
## 3.4 获取module对应的内容
|
|
5d9e899f
Liu Haoyu
接口文档维护;
|
734
735
736
737
|
| 调用方式 | 接口地址 |
| ------------ | :-------------------------------------- |
| POST | http://ip:port/background/getModuleInfo |
| Content-Type | application/json;charset=UTF-8 |
|
|
7d61f114
Liu Haoyu
查询功能修改;
|
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
|
| 请求参数 | | | | |
| --------- | -------- | ------ | ---- | ---------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| modules | 功能id | string | 是 | 功能id |
| startTime | 开始时间 | long | 是 | 开始时间戳 |
| endTime | 结束时间 | long | 是 | 结束时间戳 |
```
请求示例
{
"module": "cpu_utilization",
"startTime": 1575599542344,
"endTime": 1575599545346
}
```
| 返回结果 | | | |
| --------------- | ------------ | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
| +id | 主键 | string | 主键 |
| +moduleId | 功能id | string | 功能id |
| +occurrenceTime | 数据获取时间 | long | 数据获取时间 |
| +occupancy | 占用率 | double | 占用率 |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": [
{
"id": "1",
"moduleId": "cpu_utilization",
"occurrenceTime": 1575599542344,
"occupancy": 1.0
},
{
"id": "2",
"moduleId": "cpu_utilization",
"occurrenceTime": 1575599545346,
"occupancy": 4.0
}
]
}
```
|
|
8e622034
Liu Haoyu
配置文件由39修改到117上;
|
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
|
## 3.5 sdk控制器
| 调用方式 | 接口地址 |
| ------------ | :---------------------------------------------- |
| POST | http://ip:port/background/sdkController |
| Content-Type | application/json;charset=UTF-8 |
| 请求参数 | | | | |
| -------------------------------------- | ---------------------------------------------------------- | ------ | ------ | --------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| action | 操作功能 | string | 是 | 操作功能 |
| vehicle_car_win_detect_config | 是否启动车车窗检测 | int | 是 | 0：关闭 1：开启 |
| vehicle_recg_config | 是否启动车型识别 | int | 是 | 0：关闭 1：开启 |
| vehicle_plate_det_recg_config | 是否启动车牌检测识别 | int | 是 | 0：关闭 1：开启 |
| vehicle_color_config | 是否启动车辆颜色识别 | int | 是 | 0：关闭 1：开启 |
| vehicle_pendant_det_config | 是否启动车辆属性识别 | int | 是 | 0：关闭 1：开启 |
| vehicle_illegal_config | 是否启动车违规行为检测 | int | 是 | 0：关闭 1：开启 |
| vehicle_feature_config | 是否启动车辆特征提取 | long | 是 | 0：关闭 1：开启 |
| vehicle_special_config | 是否启动特殊品类车型识别 | int | 是 | 0：关闭 1：开启 |
| gpuId | 显卡号 | int | 显卡号 | 0：关闭 1：开启 |
| log | 日志 | int | 日志 | 0：关闭 1：开启 |
| vehicle_image_quality_config | 是否启动车辆图像清晰度识别 | int | 是 | 0：关闭 1：开启 |
| vehicle_motor_tricycle_analysis_config | 否启动摩托车是否载人/摩托车驾驶人是否戴头盔/农用车是否载人 | int | 是 | 0：关闭 1：开启 |
| port | 端口号 | int | 是 | 端口号 |
```
请求示例
{
"vehicle_car_win_detect_config": 1,
"vehicle_recg_config": 1,
"vehicle_plate_det_recg_config": 1,
"vehicle_color_config": 1,
"vehicle_pendant_det_config": 1,
"vehicle_illegal_config": 1,
"vehicle_feature_config": 1,
"vehicle_special_config": 1,
"gpuId": 3,
"log": 1,
"vehicle_image_quality_config": 1,
"vehicle_motor_tricycle_analysis_config": 1,
"action": "start",
"port": 8080
}
```
| 返回结果 | | | |
| -------- | -------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": null
}
```
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
|
# 4 用户控制
## 4.1 登录
| 调用方式 | 接口地址 |
| ------------ | :----------------------------- |
| POST | http://ip:port/user/login |
| Content-Type | application/json;charset=UTF-8 |
| 请求参数 | | | | |
| -------- | ------ | ------ | ---- | ----------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| username | 用户名 | string | 是 | 用户名(param格式) |
| password | 密码 | string | 是 | 密码(param格式) |
```
请求示例
{
"username": admin,
"password": admin
}
```
| 返回结果 | | | |
| -------- | -------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": null
}
```
## 4.2 修改密码
| 调用方式 | 接口地址 |
| ------------ | :------------------------------- |
| POST | http://ip:port/user/changePasswd |
| Content-Type | application/json;charset=UTF-8 |
| 请求参数 | | | | |
| -------- | ------ | ------ | ---- | ----------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| username | 用户名 | string | 是 | 用户名(param格式) |
| password | 新密码 | string | 是 | 新密码(param格式) |
```
请求示例
{
"username": admin,
"password": admin
}
```
| 返回结果 | | | |
| -------- | -------- | ------ | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": null
}
```
## 4.3 创建用户
|
|
8e622034
Liu Haoyu
配置文件由39修改到117上;
|
929
|
|
|
66b3bbb4
Liu Haoyu
添加功能配置接口;
|
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
|
| 调用方式 | 接口地址 |
| ------------ | :----------------------------- |
| POST | http://ip:port/user/addUser |
| Content-Type | application/json;charset=UTF-8 |
| 请求参数 | | | | |
| -------- | ------ | ------ | ---- | ----------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| username | 用户名 | string | 是 | 用户名(param格式) |
| password | 新密码 | string | 是 | 新密码(param格式) |
```
请求示例
{
"username": admin,
"password": admin
}
```
| 返回结果 | | | |
| -------- | -------- | ------- | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
| +id | 主键 | Integer | 主键 |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {"id": 1}
}
```
## 4.4 查询用户信息
| 调用方式 | 接口地址 |
| ------------ | :------------------------------ |
| POST | http://ip:port/user/searchUsers |
| Content-Type | application/json;charset=UTF-8 |
| 请求参数 | | | | |
| ----------- | -------- | ------- | ---- | ------------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| username | 用户名 | string | 是 | 用户名(param格式) |
| currentPage | 页码 | Integer | 是 | 页码(param格式) |
| pageVolume | 页面容量 | Integer | 是 | 页面容量(param格式) |
```
请求示例
{
"username": admin,
"currentPage": 1,
"pageVolume": 20
}
```
| 返回结果 | | | |
| --------- | -------- | ------- | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
| +id | 主键 | Integer | 主键 |
| +username | 用户名 | String | 用户名 |
| +password | 密码 | String | 密码 |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {
"id": 1,
"username": "admin",
"password": "admin"
}
}
```
## 4.5 校验用户是否存在
| 调用方式 | 接口地址 |
| ------------ | :----------------------------- |
| POST | http://ip:port/user/checkUser |
| Content-Type | application/json;charset=UTF-8 |
| 请求参数 | | | | |
| -------- | ------ | ------ | ---- | ----------------- |
| 参数项 | 名称 | 类型 | 必选 | 描述 |
| username | 用户名 | string | 是 | 用户名(param格式) |
```
请求示例
{
"username": admin
}
```
| 返回结果 | | | |
| -------- | -------- | ------- | --------------------------------- |
| 参数项 | 名称 | 类型 | 描述 |
| code | 响应码 | int | 200为操作成功，其他code表示失败 |
| message | 提示信息 | string | 200为操作成功, 其他为对应错误信息 |
| data | 返回信息 | | |
| +count | 存在条数 | Integer | 存在条数 |
```
响应示例
{
"code": 200,
"message": "操作成功",
"data": {"count": 1}
}
```
|
