全部产品

边缘应用LinkVisual对接

更新时间:2020-03-05 19:12:43

登录并获取鉴权信息

1.接口描述

授权类型 APPSIGN
协议 HTTP
请求方法 Post
域名(环境变量中获取) 30.42.82.42(集群服务地址)
路径 /vision/edge/console/user/login

2.入参说明

入参名称 数据类型 是否必须 入参示例 入参描述
userName string test_model1 用户名
password string 1C35315598694F 密码

3.出参列表

出参名称 数据类型 出参描述
code 整形 响应码, 200: 成功
systemInitializeGuideFinish 字符串 系统初始化标志位(暂未使用,可忽略)
token 字符串 令牌信息
userId string 用户ID
message string 返回信息

4.请求示例

  1. public static void main(String[] args) {
  2. geturl();//测试发送请求
  3. }
  4. private Logger logger = LoggerFactory.getLogger("iot_edge");
  5. private static final String PATH_LOGIN_HOST = "/vision/edge/console/user/login";
  6. private static final String apiGatewayDomain = "30.42.82.42";
  7. private static final int port = 8080;
  8. /**
  9. * 发送HttpPost请求
  10. * <p>
  11. * <p>
  12. * json字符串,例如: "{ \"id\":\"12345\" }" ;其中属性名必须带双引号<br/>
  13. *
  14. * @return 成功:返回json字符串<br/>
  15. */
  16. public static String geturl() {
  17. JSONObject jsonObject = new JSONObject();
  18. jsonObject.put("userName", "admin");
  19. jsonObject.put("password", "admin");
  20. String params = String.valueOf(jsonObject);
  21. String url = "http://" + apiGatewayDomain + ":" + port + PATH_LOGIN_HOST;
  22. String reString = postUtil.post(url, params);
  23. System.out.println(url);
  24. System.out.println(reString);
  25. return reString;
  26. }

5.返回结果示例 JSON

  1. {
  2. "code": 200,
  3. "data": {
  4. "systemInitializeGuideFinish": false,
  5. "token": "cc8579b8be7711e991750242ac140009",
  6. "userId": "1"
  7. },
  8. "message": "success"
  9. }

6.失败返回结果示例 JSON

  1. {
  2. "code": 500,
  3. "data":
  4. },
  5. "message": "failed"
  6. }

新增算法任务

1.接口描述

鉴权方式
Cookie:{“token”: “cc8579b8be7711e991750242ac140009”, “userId”: “1”}
协议 HTTP
请求方法 Post
域名(环境变量中获取) 30.42.82.42(集群服务地址)
路径 /vision/edge/console/algorithm/createAlgoJob

2.入参说明

入参名称 数据类型 是否必须 入参示例 入参描述
jobName string test_model1 任务名称
jobDesc string 1C35315598694F string
deviceId int 01 IPC的设备ID
algoName string personVehicleDetect 算法名称,当前支持的算法名称有”personVehicleDetect”,”regionalInvasion”,”vehiclesRecognize”, “faceRecognize”, “keyAreaOccupation”(人车检测、区域入侵、车牌识别、人脸检测、重点区域占用)
name string ipcName IPC名称

3.出参列表

出参名称 数据类型 出参描述
code 整形 响应码, 200: 成功
message string 返回信息

4.请求示例

  1. public static void main(String[] args) {
  2. geturl();//测试发送请求
  3. }
  4. private Logger logger = LoggerFactory.getLogger("iot_edge");
  5. private static final String PATH_LOGIN_HOST = "/vision/edge/console/algorithm/createAlgoJob";
  6. private static final String apiGatewayDomain = "30.42.82.42";
  7. private static final int port = 8080;
  8. /**
  9. * 发送HttpPost请求
  10. * <p>
  11. * <p>
  12. * json字符串,例如: "{ \"id\":\"12345\" }" ;其中属性名必须带双引号<br/>
  13. *
  14. * @return 成功:返回json字符串<br/>
  15. */
  16. public static String geturl() {
  17. JSONObject jsonObject = new JSONObject();
  18. jsonObject.put("jobName", "人车检测");
  19. jsonObject.put("jobDesc", "111");
  20. jsonObject.put("deviceId", 318);
  21. jsonObject.put("algoName", "personVehicleDetect");
  22. jsonObject.put("name", "hik");
  23. String params = String.valueOf(jsonObject);
  24. String url = "http://" + apiGatewayDomain + ":" + port + PATH_LOGIN_HOST;
  25. String reString = postUtil.post(url, params);
  26. System.out.println(url);
  27. System.out.println(reString);
  28. return reString;
  29. }

5.返回结果示例 JSON

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

6.失败返回结果示例 JSON

  1. {
  2. "code": 500,
  3. "data":
  4. },
  5. "message": "failed"
  6. }

删除算法任务

1.接口描述

鉴权方式 Cookie:{“token”: “cc8579b8be7711e991750242ac140009”, “userId”: “1”}
协议 HTTP
请求方法 Post
域名(环境变量中获取) 30.42.82.42(集群服务地址)
路径 /vision/edge/console/algorithm/deleteAlgoJob

2.入参说明

入参名称 数据类型 是否必须 入参示例 入参描述
jobId int 01 任务号

3.出参列表

出参名称 数据类型 出参描述
code 整形 响应码, 200: 成功
message string 返回信息

4.请求示例

  1. public static void main(String[] args) {
  2. geturl();//测试发送请求
  3. }
  4. private Logger logger = LoggerFactory.getLogger("iot_edge");
  5. private static final String PATH_LOGIN_HOST = "/vision/edge/console/algorithm/deleteAlgoJob";
  6. private static final String apiGatewayDomain = "30.42.82.42";
  7. private static final int port = 8080;
  8. /**
  9. * 发送HttpPost请求
  10. * <p>
  11. * <p>
  12. * json字符串,例如: "{ \"id\":\"12345\" }" ;其中属性名必须带双引号<br/>
  13. *
  14. * @return 成功:返回json字符串<br/>
  15. */
  16. public static String geturl() {
  17. JSONObject jsonObject = new JSONObject();
  18. jsonObject.put("jobId", 13);
  19. String params = String.valueOf(jsonObject);
  20. String url = "http://" + apiGatewayDomain + ":" + port + PATH_LOGIN_HOST;
  21. String reString = postUtil.post(url, params);
  22. System.out.println(url);
  23. System.out.println(reString);
  24. return reString;
  25. }

5.返回结果示例 JSON

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

6.失败返回结果示例 JSON

  1. {
  2. "code": 500,
  3. "data":
  4. },
  5. "message": "failed"
  6. }

查询算法任务

1.接口描述

鉴权方式 Cookie:{“token”: “cc8579b8be7711e991750242ac140009”, “userId”: “1”}
协议 HTTP
请求方法 Post
域名(环境变量中获取) 30.42.82.42(集群服务地址)
路径 /vision/edge/console/algorithm/queryJobList

2.入参说明

入参名称 数据类型 是否必须 入参示例 入参描述
size int 10 每页显示的算法任务数
offset int 121 当前的算法任务索引

3.出参列表

参数 是否必须 类型 说明
code int 错误码
message string 错误信息
algoName string 算法名称
createTime int 创建时间
deviceId int 设备ID
jobDesc string 任务描述
jobId int 任务ID
jobName string 任务名称
name string IPC名称
status int 任务状态,0表示关闭,1表示开启
updateTime int 更新时间
totalNum int 任务的个数

4.请求示例

  1. public static void main(String[] args) {
  2. geturl();//测试发送请求
  3. }
  4. private Logger logger = LoggerFactory.getLogger("iot_edge");
  5. private static final String PATH_LOGIN_HOST = "/vision/edge/console/algorithm/queryJobList";
  6. private static final String apiGatewayDomain = "30.42.82.42";
  7. private static final int port = 8080;
  8. /**
  9. * 发送HttpPost请求
  10. * <p>
  11. * <p>
  12. * json字符串,例如: "{ \"id\":\"12345\" }" ;其中属性名必须带双引号<br/>
  13. *
  14. * @return 成功:返回json字符串<br/>
  15. */
  16. public static String geturl() {
  17. JSONObject jsonObject = new JSONObject();
  18. jsonObject.put("offset", 0);
  19. jsonObject.put("size", 10);
  20. String params = String.valueOf(jsonObject);
  21. String url = "http://" + apiGatewayDomain + ":" + port + PATH_LOGIN_HOST;
  22. String reString = postUtil.post(url, params);
  23. System.out.println(url);
  24. System.out.println(reString);
  25. return reString;
  26. }

5.返回结果示例 JSON

  1. {
  2. "code": 200,
  3. "data": {
  4. "list": [{
  5. "algoName": "personVehicleDetect",
  6. "createTime": 1564477661000,
  7. "deviceId": 318,
  8. "jobDesc": "",
  9. "jobId": 15,
  10. "jobName": "人车检测",
  11. "name": "hik",
  12. "status": 0,
  13. "updateTime": 1564477661000
  14. }],
  15. "totalNum": 1
  16. },
  17. "message": "success"
  18. }

6.失败返回结果示例 JSON

  1. {
  2. "code": 500,
  3. "data":
  4. },
  5. "message": "failed"
  6. }

添加设备

1.接口描述

鉴权方式 Cookie:{“token”: “cc8579b8be7711e991750242ac140009”, “userId”: “1”}
协议 HTTP
请求方法 Post
域名(环境变量中获取) 30.42.82.42(集群服务地址)
路径 /vision/edge/console/device/add

2.入参说明

参数 是否必须 类型 说明
type string 当前的设备索引
name string 每页显示的设备数
protocol string 协议
onvifUsr string ONVIF登录名
onvifSecret string ONVIF登录密码
ip string IPC的IP地址
port string IPC的端口号
extraInfo string 用户自定义信息

3.出参列表

参数 是否必须 类型 说明
code int 错误码
cloudStatus string 云端连接状态,取值为”INACTIVATED”和”ACTIVATED”,分别表示未激活和激活
deviceId int 设备的ID
name string 设备名称
protocol string 接入协议,当前支持”ONVIF”,”GB”
status string 本地连接状态,取值为”ONLINE”和”OFFLINE”,分别表示在线和离线
type string 接入类型,取值为”IPC”和”NVR”
message string 错误信息

4.请求示例

  1. public static void main(String[] args) {
  2. geturl();//测试发送请求
  3. }
  4. private Logger logger = LoggerFactory.getLogger("iot_edge");
  5. private static final String PATH_LOGIN_HOST = "/vision/edge/console/device/add";
  6. private static final String apiGatewayDomain = "30.42.82.42";
  7. private static final int port = 8080;
  8. /**
  9. * 发送HttpPost请求
  10. * <p>
  11. * <p>
  12. * json字符串,例如: "{ \"id\":\"12345\" }" ;其中属性名必须带双引号<br/>
  13. *
  14. * @return 成功:返回json字符串<br/>
  15. */
  16. public static String geturl() {
  17. JSONObject jsonObject = new JSONObject();
  18. jsonObject.put("type", "IPC");
  19. jsonObject.put("name", "hik");
  20. jsonObject.put("protocol", "ONVIF");
  21. jsonObject.put("onvifUsr", "admin");
  22. jsonObject.put("onvifSecret", "admin");
  23. jsonObject.put("ip", apiGatewayDomain);
  24. jsonObject.put("port", "8080");
  25. jsonObject.put("extraInfo", "value");
  26. String params = String.valueOf(jsonObject);
  27. String url = "http://" + apiGatewayDomain + ":" + port + PATH_LOGIN_HOST;
  28. String reString = postUtil.post(url, params);
  29. System.out.println(url);
  30. System.out.println(reString);
  31. return reString;
  32. }

5.返回结果示例 JSON

  1. {
  2. "code": 200,
  3. "data": {
  4. "device": {
  5. "cloudStatus": "INACTIVATED",
  6. "deviceId": 2,
  7. "name": "hik",
  8. "protocol": "ONVIF",
  9. "status": "RECONNECT",
  10. "type": "IPC"
  11. }
  12. },
  13. "message": "success"
  14. }

6.失败返回结果示例 JSON

  1. {
  2. "code": 500,
  3. "data":
  4. },
  5. "message": "failed"
  6. }

删除设备

1.接口描述

鉴权方式 Cookie:{“token”: “cc8579b8be7711e991750242ac140009”, “userId”: “1”}
协议 HTTP
请求方法 Post
域名(环境变量中获取) 30.42.82.42(集群服务地址)
路径 /vision/edge/console/device/delete

2.入参说明

参数 是否必须 类型 说明
deviceId int 设备的ID

3.出参列表

参数 是否必须 类型 说明
code int 错误码
message string 错误信息

4.请求示例

  1. public static void main(String[] args) {
  2. geturl();//测试发送请求
  3. }
  4. private Logger logger = LoggerFactory.getLogger("iot_edge");
  5. private static final String PATH_LOGIN_HOST = "/vision/edge/console/device/delete";
  6. private static final String apiGatewayDomain = "30.42.82.42";
  7. private static final int port = 8080;
  8. /**
  9. * 发送HttpPost请求
  10. * <p>
  11. * <p>
  12. * json字符串,例如: "{ \"id\":\"12345\" }" ;其中属性名必须带双引号<br/>
  13. *
  14. * @return 成功:返回json字符串<br/>
  15. */
  16. public static String geturl() {
  17. JSONObject jsonObject = new JSONObject();
  18. jsonObject.put("deviceId", 2);
  19. String params = String.valueOf(jsonObject);
  20. String url = "http://" + apiGatewayDomain + ":" + port + PATH_LOGIN_HOST;
  21. String reString = postUtil.post(url, params);
  22. System.out.println(url);
  23. System.out.println(reString);
  24. return reString;
  25. }

5.返回结果示例 JSON

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

6.失败返回结果示例 JSON

  1. {
  2. "code": 500,
  3. "data":
  4. },
  5. "message": "failed"
  6. }

查询设备列表

1.接口描述

鉴权方式 Cookie:{“token”: “cc8579b8be7711e991750242ac140009”, “userId”: “1”}
协议 HTTP
请求方法 Post
域名(环境变量中获取) 30.42.82.42(集群服务地址)
路径 /vision/edge/console/device/list

2.入参说明

参数 是否必须 类型 说明
size int 每页显示的设备数
offset int 当前的设备索引

3.出参列表

参数 是否必须 类型 说明
code int 错误码
cloudStatus string 云端连接状态,取值为”INACTIVATED”和”ACTIVATED”,分别表示未激活和激活
deviceId int 设备的ID
name string 设备名称
ip string 设备IP地址
protocol string 接入协议,当前支持”ONVIF”,”GB”
status string 本地连接状态,取值为”ONLINE”和”OFFLINE”,分别表示在线和离线
type string 接入类型,取值为”IPC”和”NVR”
message string 错误信息

4.请求示例

  1. public static void main(String[] args) {
  2. geturl();//测试发送请求
  3. }
  4. private Logger logger = LoggerFactory.getLogger("iot_edge");
  5. private static final String PATH_LOGIN_HOST = "/vision/edge/console/device/list";
  6. private static final String apiGatewayDomain = "30.42.82.42";
  7. private static final int port = 8080;
  8. /**
  9. * 发送HttpPost请求
  10. * <p>
  11. * <p>
  12. * json字符串,例如: "{ \"id\":\"12345\" }" ;其中属性名必须带双引号<br/>
  13. *
  14. * @return 成功:返回json字符串<br/>
  15. */
  16. public static String geturl() {
  17. JSONObject jsonObject = new JSONObject();
  18. jsonObject.put("size", 256);
  19. jsonObject.put("offset", 0);
  20. String params = String.valueOf(jsonObject);
  21. String url = "http://" + apiGatewayDomain + ":" + port + PATH_LOGIN_HOST;
  22. String reString = postUtil.post(url, params);
  23. System.out.println(url);
  24. System.out.println(reString);
  25. return reString;
  26. }

5.返回结果示例 JSON

  1. {
  2. "code": 200,
  3. "data": {
  4. "list": [
  5. {
  6. "cloudStatus": "INACTIVATED",
  7. "deviceId": 6,
  8. "name": "aihua111",
  9. "params": {
  10. "device_id": 6,
  11. "gmt_create": "Mon, 23 Sep 2019 18:16:23 GMT",
  12. "gmt_modified": "Mon, 23 Sep 2019 18:16:23 GMT",
  13. "id": 6,
  14. "ip": "192.168.1.111",
  15. "onvif_secret": "admin123",
  16. "onvif_user": "admin",
  17. "params": "{\"onvifUsr\": \"admin\", \"onvifSecret\": \"admin123\", \"ip\": \"192.168.1.111\", \"port\": \"80\"}",
  18. "port": 80
  19. },
  20. "protocol": "ONVIF",
  21. "status": "ONLINE",
  22. "type": "IPC",
  23. "extraInfo": ""
  24. }
  25. ],
  26. "totalNum": 1
  27. },
  28. "message": "success"
  29. }

6.失败返回结果示例 JSON

  1. {
  2. "code": 500,
  3. "data":
  4. },
  5. "message": "failed"
  6. }

查询单个设备列表

1.接口描述

鉴权方式 Cookie:{“token”: “cc8579b8be7711e991750242ac140009”, “userId”: “1”}
协议 HTTP
请求方法 Post
域名(环境变量中获取) 30.42.82.42(集群服务地址)
路径 vision/edge/console/device/get

2.入参说明

参数 是否必须 类型 说明
deviceId int 设备ID信息

3.出参列表

参数 是否必须 类型 说明
code int 错误码
cloudStatus string 云端连接状态,取值为”INACTIVATED”和”ACTIVATED”,分别表示未激活和激活
deviceId int 设备的ID
name string 设备名称
ip string 设备IP地址
protocol string 接入协议,当前支持”ONVIF”,”GB”
status string 本地连接状态,取值为”ONLINE”和”OFFLINE”,分别表示在线和离线
type string 接入类型,取值为”IPC”和”NVR”
message string

4.请求示例

  1. public static void main(String[] args) {
  2. geturl();//测试发送请求
  3. }
  4. private Logger logger = LoggerFactory.getLogger("iot_edge");
  5. private static final String PATH_LOGIN_HOST = "/vision/edge/console/device/get";
  6. private static final String apiGatewayDomain = "30.42.82.42";
  7. private static final int port = 8080;
  8. /**
  9. * 发送HttpPost请求
  10. * <p>
  11. * <p>
  12. * json字符串,例如: "{ \"id\":\"12345\" }" ;其中属性名必须带双引号<br/>
  13. *
  14. * @return 成功:返回json字符串<br/>
  15. */
  16. public static String geturl() {
  17. JSONObject jsonObject = new JSONObject();
  18. jsonObject.put("deviceId", 1);
  19. String params = String.valueOf(jsonObject);
  20. String url = "http://" + apiGatewayDomain + ":" + port + PATH_LOGIN_HOST;
  21. String reString = postUtil.post(url, params);
  22. System.out.println(url);
  23. System.out.println(reString);
  24. return reString;
  25. }

5.返回结果示例 JSON

  1. {
  2. "code": 200,
  3. "data":
  4. {
  5. "cloudStatus": "INACTIVATED",
  6. "deviceId": 1,
  7. "name": "aihua111",
  8. "params": {
  9. "device_id": 1,
  10. "gmt_create": "Mon, 23 Sep 2019 18:16:23 GMT",
  11. "gmt_modified": "Mon, 23 Sep 2019 18:16:23 GMT",
  12. "id": 6,
  13. "ip": "192.168.1.111",
  14. "onvif_secret": "admin123",
  15. "onvif_user": "admin",
  16. "params": "{\"onvifUsr\": \"admin\", \"onvifSecret\": \"admin123\", \"ip\": \"192.168.1.111\", \"port\": \"80\"}",
  17. "port": 80
  18. },
  19. "protocol": "ONVIF",
  20. "status": "ONLINE",
  21. "type": "IPC",
  22. "extraInfo": ""
  23. },
  24. "message": "success"
  25. }

6.失败返回结果示例 JSON

  1. {
  2. "code": 500,
  3. "data":
  4. },
  5. "message": "failed"
  6. }

区域入侵算法任务配置

1.接口描述

鉴权方式 Cookie:{“token”: “cc8579b8be7711e991750242ac140009”, “userId”: “1”}
协议 HTTP
请求方法 Post
域名(环境变量中获取) 30.42.82.42(集群服务地址)
路径 /vision/edge/console/algorithm/createAlgoJob

2.入参说明

参数 是否必须 类型 说明
jobName string 任务名称
jobDesc string 任务描述
deviceId int IPC的设备ID
algoName string 算法名称:keyAreaOccupation(重点区域占用)
areaIndex int 区域索引
areaPoint string 区域的坐标点信息
areaDirection string 区域的方向
targetType string 目标类型
areaType string 区域类型
name string IPC名称
firstDuration int 初次告警时间间隔
alertDuration int 间隔告警时间

3.请求示例

  1. public static void main(String[] args) {
  2. geturl();//测试发送请求
  3. }
  4. private Logger logger = LoggerFactory.getLogger("iot_edge");
  5. private static final String PATH_LOGIN_HOST = "/vision/edge/console/algorithm/createAlgoJob";
  6. private static final String apiGatewayDomain = "30.42.82.42";
  7. private static final int port = 8080;
  8. /**
  9. * 发送HttpPost请求
  10. * <p>
  11. * <p>
  12. * json字符串,例如: "{ \"id\":\"12345\" }" ;其中属性名必须带双引号<br/>
  13. *
  14. * @return 成功:返回json字符串<br/>
  15. */
  16. public static String geturl() {
  17. JSONObject jsonObject = new JSONObject();
  18. jsonObject.put("jobName", "1231");
  19. jsonObject.put("deviceId", 1);
  20. jsonObject.put("key", "value");
  21. ...
  22. String params = String.valueOf(jsonObject);
  23. String url = "http://" + apiGatewayDomain + ":" + port + PATH_LOGIN_HOST;
  24. String reString = postUtil.post(url, params);
  25. System.out.println(url);
  26. System.out.println(reString);
  27. return reString;
  28. }

4.返回结果示例 JSON

  1. {
  2. "jobName": "重点区域占用",
  3. "jobDesc": "",
  4. "deviceId": 1,
  5. "algoName": "keyAreaOccupation",
  6. "algoParam": {
  7. "detectArea": [{
  8. "areaIndex": 1,
  9. "areaPoint": [{
  10. "point": [0.105, 0.2167]
  11. }, {
  12. "point": [0.1605, 0.864]
  13. }, {
  14. "point": [0.5269, 0.9283]
  15. }, {
  16. "point": [0.3782, 0.2093]
  17. }, {
  18. "point": [0.2008, 0.139]
  19. }],
  20. "areaDirection": 2,
  21. "targetType": 2,
  22. "areaType": 2
  23. }],
  24. "firstDuration": 60,
  25. "alertDuration": 3600
  26. },
  27. "name": "hik"
  28. }

5.失败返回结果示例 JSON

  1. {
  2. "code": 500,
  3. "data":
  4. },
  5. "message": "failed"
  6. }

其他算法任务配置

  1. 接口描述:指定其他算法任务(非区域入侵或重点区域占用)算法任务配置
  2. 鉴权方式: Cookie:{“token”: “cc8579b8be7711e991750242ac140009”, “userId”: “1”}
  3. 请求方式:POST
  4. 请求地址:http://30.42.82.42:8080/vision/edge/console/algorithm/createAlgoJob
  5. 参数说明:
参数 是否必须 类型 说明
jobName string 任务名称
jobDesc string 任务描述
deviceId int IPC的设备ID
algoName string 算法名称,当前支持:
“personVehicleDetect”, “vehiclesRecognize”, “faceRecognize”, “keyAreaOccupation”
algoParam string 填入””即可
name string IPC名称
  1. {
  2. "jobName": "区域入侵",
  3. "jobDesc": "",
  4. "deviceId": 1,
  5. "algoName": "personVehicleDetect",
  6. "algoParam": "",
  7. "name": "hik"
  8. }

人脸识别算法图片推理

  1. 接口描述:传入人脸图片进行人脸检测和特征提取
  2. 鉴权方式:Cookie:{“token”: “cc8579b8be7711e991750242ac140009”, “userId”: “1”}
  3. 请求方式:POST
  4. 请求地址:http://30.42.82.42:8080/vision/edge/aibiz/image/inference
  5. 参数说明
参数 是否必须 类型 说明
type string 图片类型,当前的值为”local”表示本地图片,”url”表示网络图片
algorithm string 算法名称,填写”faceRecognize”
data string 文件名,当type为local时填写本地图片的绝对或相对路径;当type为url时填写图片的url地址

示例

  1. {
  2. "type": "url",
  3. "algorithm": "faceRecognize",
  4. "data": "http://www.xxx.com/test.jpeg"
  5. }

响应参数

参数 是否必须 类型 说明
message string 接口返回结果信息
result int 接口返回结果的错误码
algorithm_code int 算法结果的错误码
algorithm_message string 算法结果的信息
+rect number[4] 检测到的人脸的坐标信息
+alarmType int 报警类型
+eventTime int 人脸检测时间
+captureTime int 图片采集时间
+track_id int 跟踪ID
+conf float 人脸检测的置信度
+frame_index int 人脸检测所在的帧号
+ossUrl string 存储小视频的oss的url(暂未使用)
+ltlId string 暂未使用
+feature number[512] 人脸特征值,512维
+blur_score float 人脸的模糊度得分
+pose_score float 人脸的姿态得分
+land_mark number[6] 人脸特征点坐标

返回示例

  1. {
  2. "message": "success",
  3. "result": 0,
  4. "algorithm_code": 0,
  5. "algorithm_message": "success",
  6. "data": [{
  7. "rect": [0.387, 0.2146, 0.245, 0.4073],
  8. "alarmType": 10007,
  9. "eventTime": 1573120006201,
  10. "captureTime": 1573120006201,
  11. "track_id": -1,
  12. "conf": 0.9971,
  13. "frame_index": -1,
  14. "ossUrl": "",
  15. "ltlId": "",
  16. "feature": [0.7662, 0.2966, 0.0483, 0.4999, 0.8, 0.3786, 0.5138, 0.001, -0.2762,....
  17. "blur_score": -49.6351
  18. "pose_score": 69.8145,
  19. "land_mark": []
  20. }]
  21. }

算法任务开关

开启算法任务

  1. 接口描述:开启算法任务
  2. 鉴权方式: Cookie:{“token”: “cc8579b8be7711e991750242ac140009”, “userId”: “1”}
  3. 请求方式:POST
  4. 请求地址:http://30.42.82.42:8080/vision/edge/console/algorithm/startAlgoJob
  5. 参数说明:
参数 是否必须 类型 说明
jobId int 任务id

示例

  1. {
  2. "jobId": 13
  3. }
  1. 响应参数
参数 是否必须 类型 说明
code int 错误码
message string 错误信息

示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

关闭算法任务

  1. 接口描述:关闭算法任务
  2. 鉴权方式: Cookie:{“token”: “cc8579b8be7711e991750242ac140009”, “userId”: “1”}
  3. 请求方式:POST
  4. 请求地址:http://30.42.82.42::8080/vision/edge/console/algorithm/stopAlgoJob
  5. 参数说明:
参数 是否必须 类型 说明
jobId int 任务id

示例

  1. {
  2. "jobId": 13
  3. }
  1. 响应参数
参数 是否必须 类型 说明
code int 错误码
message string 错误信息

示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

算法结果上报

  1. 接口描述:指定区域入侵的坐标信息创建区域入侵算法任务
  2. 鉴权方式: Cookie:{“token”: “cc8579b8be7711e991750242ac140009”, “userId”: “1”}
  3. 请求方式:GET
  4. 请求地址http://30.42.82.42::8080/vision/edge/console/algorithm/noticeAlgoResult/15
  5. 参数说明:
  6. 响应参数:
参数 是否必须 类型 说明
deviceId string 任务名称
type string 任务描述
pictureUrl string 原始图地址
cutoutUrl string 抠图地址
pictureId string 抓拍图id
taskId string 任务id
AlarmType int 报警类型
Algorithm string 算法名称
ProductKey string 产品秘钥
DeviceName string 设备名称
alarmType int 报警类型
areaIndex int 区域索引
areaPoint string 区域点坐标
type string 检测类型
rect number[4] 检测到的坐标
conf float 置信度
track_id int 跟踪id
AlarmPicID string 报警图片id
  1. 示例
    1. {
    2. "transParams": {
    3. "deviceId": 318,
    4. "type": "IntelligentAlarmEvent",
    5. "pictureUrl": "http://192.168.1.179:11005/static/images/T20_2019_07_30_20_46_20_732757.jpg",
    6. "cutoutUrl": "http://192.168.1.179:11005/static/images/0_T20_2019_07_30_20_46_20_732757.jpg",
    7. "pictureId": "96fc235be4034b4595564431b3ab03d5",
    8. "taskId": "20"
    9. },
    10. "payload": {
    11. "AlarmType": 10010,
    12. "Algorithm": "regionalInvasion",
    13. "ProductKey": "",
    14. "DeviceName": "",
    15. "Data": "{
    16. "alarmType": 10010,
    17. "areaIndex": 1,
    18. "areaPoint": [{
    19. "point": [0.056539948453608255, 0.08247422680412371]
    20. }, {
    21. "point": [0.9452319587628867, 0.08247422680412371]
    22. }, {
    23. "point": [0.9452319587628867, 0.9561855670103093]
    24. }, {
    25. "point": [0.056539948453608255, 0.9561855670103093]
    26. }],
    27. "type": "person",
    28. "rect": [0.58984375, 0.16111111111111112, 0.6390625, 0.2569444444444444],
    29. "conf": 0.6067625284194946,
    30. "track_id": 0
    31. }",
    32. "AlarmPicID": "96fc235be4034b4595564431b3ab03d5"
    33. }
    34. }

算法报警抓图上报

  1. 接口描述:获取算法报警抓拍图
  2. 鉴权方式: 无
  3. 请求方式:GET
  4. 请求地址:http://30.42.82.42::11005/static/images/0_T20_2019_07_30_20_46_20_732757.jpg
  5. 参数说明:上述的请求地址是根据上面的算法结果上报的JSON字段中解析获得

查询支持的算法

  1. 接口描述:查询支持的算法
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/algorithm/querySupportAlgos
  4. 参数说明
参数 是否必须 类型 说明

示例

  1. {
  2. }
  1. 响应参数

示例

  1. {
  2. "code": 200,
  3. "data": [
  4. {
  5. "algoName": "personVehicleDetect",
  6. "aliasName": "人车检测",
  7. "params": [
  8. {
  9. "Annotation": false
  10. }
  11. ],
  12. "platform": "INTEL"
  13. },
  14. {
  15. "algoName": "regionalInvasion",
  16. "aliasName": "区域入侵",
  17. "params": [
  18. {
  19. "max": "86400",
  20. "min": "60",
  21. "name": "alertDuration",
  22. "type": "int"
  23. },
  24. {
  25. "max": "86400",
  26. "min": "60",
  27. "name": "firstDuration",
  28. "type": "int"
  29. },
  30. {
  31. "Annotation": true
  32. }
  33. ],
  34. "platform": "INTEL"
  35. }
  36. ],
  37. "message": "success"
  38. }

获取网络配置

  1. 接口描述:获取网络配置接口
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/system/getNetwork

返回示例

  1. {
  2. "code": 200,
  3. "data": {
  4. "ipAddr": "192.168.31.12",
  5. "netMask": "255.255.255.0",
  6. "getwayIp": "192.168.31.1"
  7. },
  8. "message": "success"
  9. }

配置网络

  1. 接口描述:获取配置网络的信息
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/system/setNetwork
  4. 参数说明
参数 是否必须 类型 说明

示例

  1. {
  2. "ipAddr":xxxx,
  3. "netmask":xxxx,
  4. "gateway":xxxx,
  5. "dns1":xxxx,
  6. "dns2":xxxx,
  7. "mainCard": true or false
  8. }
  1. 响应参数

示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

配置ntp

  1. 接口描述:配置ntp的信息参数
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/system/setNTP

返回示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

获取ntp配置

  1. 接口描述:获取ntp配置的网络信息
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/system/getNTP

返回示例

  1. {
  2. "code": 200,
  3. "data":{
  4. "ntpEnable":True or False,
  5. "ntpServer":"ntp1.aliyun.com",
  6. "ntpPort":123,
  7. "synInterval":20
  8. },
  9. "message": "success"
  10. }

获取系统时间

  1. 接口描述:获取系统的时间
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/system/getTime

返回示例

  1. {
  2. "code": 200,
  3. "data":{
  4. "time":"2019-09-09 11:12:11"
  5. },
  6. "message": "success"
  7. }

获取系统时间

  1. 接口描述:获取系统的时间
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/system/setTime
  4. 参数说明
参数 是否必须 类型 说明

示例

  1. {
  2. "time":"2019-09-09 11:12:11"
  3. }
  1. 响应参数

示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

批量删除任务

  1. 接口描述:批量删除任务
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/algorithm/batchDelete
  4. 参数说明
参数 是否必须 类型 说明

示例

  1. {
  2. "jobList":[1,2,3]
  3. }
  1. 响应参数

示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

更新算法任务

  1. 接口描述:对算法任务进行更新
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/algorithm/updateAlgoJob
  4. 参数说明
参数 是否必须 类型 说明

示例

  1. {
  2. "jobId":1,
  3. "jobName":"测试",
  4. "deviceId":1,
  5. "name":"ipc",
  6. "algoName":"算法名",
  7. "jobDesc":"描述",
  8. "algoParam":"算法参数"
  9. }
  1. 响应参数

示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

系统信息

  1. 接口描述:获取系统信息
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/system/info

返回示例

  1. {
  2. "code": 200,
  3. "data": {
  4. "cpu": 4,
  5. "diskPercent": 72.8,
  6. "diskUsed":10.1,
  7. "diskTotal":50.1,
  8. "getway": "192.168.31.1",
  9. "ipAddr": "192.168.31.102",
  10. "mainCard": true,
  11. "memory": 11.2,
  12. "netmask": "255.255.255.0",
  13. "mac":"ec:d6:8a:36:f7:2c",
  14. "ntpEnable": false,
  15. "ntpPort": 123,
  16. "ntpServer": "ntp1.aliyun.com",
  17. "ntpSynInterval": 60,
  18. "os": "Linux",
  19. "processor": "x86_64",
  20. "softVersion":1.2,
  21. "versionInfo": ["aibox-1.2.2-20191108-bb4425de↵", "access-1.1-20191108-598d315↵",…],
  22. "time": "2019-09-11 14:22:13"
  23. },
  24. "message": "success"
  25. }

设备更新

  1. 接口描述:设备更新
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/device/update
  4. 参数说明
参数 是否必须 类型 说明

示例

  1. {
  2. "deviceId":1
  3. "name":"deviceName",
  4. "protocol":"ONVIF",//GB,HK,DH
  5. "type":"IPC",//IPC, NVR
  6. "params":xxx
  7. }
  1. 响应参数

示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

ntp服务测试

  1. 接口描述:ntp服务测试
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/system/ntpServerTest
  4. 参数说明
参数 是否必须 类型 说明

示例

  1. {
  2. "ntpServer":"ntp1.aliyun.com",
  3. "ntpPort":123,
  4. }
  1. 响应参数

示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }


三元组绑定

  1. 接口描述:设备3元组绑定
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/licence/bind
  4. 参数说明
参数 是否必须 类型 说明

示例

  1. {
  2. "productKey":xxxx,
  3. "deviceName":"三元组中的设备名",
  4. "localDeviceName":"本地ipc设备名"
  5. }
  1. 响应参数

示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

三元组解绑

  1. 接口描述:设备三元组解绑
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/licence/unbind
  4. 参数说明
参数 是否必须 类型 说明

示例

  1. {
  2. "productKey":xxxx,
  3. "deviceName":"三元组中的设备名",
  4. "localDeviceName":"本地ipc设备名"
  5. }
  1. 响应参数

示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

查询算法任务

  1. 接口描述:查询算法任务
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/algorithm/queryJob
  4. 参数说明
参数 是否必须 类型 说明

示例

  1. {
  2. "jobId":123
  3. }
  1. 响应参数

示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. "data": {
  5. "algoName": "personVehicleDetect",
  6. "createTime": 1564477661000,
  7. "deviceId": 318,
  8. "jobDesc": "",
  9. "jobId": 123,
  10. "jobName": "人车检测",
  11. "name": "hik",
  12. "status": 0,
  13. "updateTime": 1564477661000
  14. },
  15. }

系统重启

  1. 接口描述:系统重启
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/system/reboot

返回示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

重置网关

  1. 接口描述:重置网关信息
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/licence/resetgateway

返回示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

查询支持的协议

  1. 接口描述:查询支持的协议
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/device/querySupportProtocol

返回示例

  1. {
  2. "code": 200,
  3. "message": "success",
  4. "data":['HIK','DH','ONVIF','GB']
  5. }

获取stream url

  1. 接口描述:获取视频返回流
  2. 请求方式:POST
  3. 请求地址http://30.42.82.42:8080/vision/edge/console/streaming/geturl
  4. 参数说明
参数 是否必须 类型 说明

示例

  1. {
  2. "deviceId":347,
  3. "streamType":0,
  4. "scheme":"RTMP"
  5. }
  1. 响应参数

示例

  1. {
  2. "code":200,
  3. "data":{"url":"rtmp://192.168.31.222:1935/live/1_0"},
  4. "message":"success"
  5. }