1. 网关安装及子网关安装API

API列表

编号 API名称 路径 版本
1.1 保存网关 /v1/edge/gateway/save 1.0
1.2 获取网关信息 /v1/edge/gateway/getGateway 1.0
1.3 启动网关 /v1/edge/gateway/startGateway 1.0
1.4 启动Agent /v1/edge/gateway/startAgent 1.0
1.5 获取Agent信息 /v1/edge/agent/getAgentList 1.0
1.6 登录认证 /v1/edge/gatewayuser/login 1.0
1.7 联网接口 /v1/edge/gateway/startConnect 1.0
1.8 检测是否已安装 /v1/edge/gateway/checkGateway 1.0
1.9 重置网关 /v1/edge/gateway/reSet 1.0
2.0 应用授权列表 /v1/edge/gateway/getGertInfo 1.0
2.1 获取网关实例信息 /v1/edge/gateway/instance/list 1.0
2.2 校验网关是否激活成功 /v1/edge/gateway/checkStatus 1.0
2.3 重启网关 /v1/edge/gateway/restartGateway 1.0
2.4 重启Agent /v1/edge/gateway/restartAgent 1.0
2.5 获取应用实例详细信息 /v1/edge/gateway/instance/info 1.0
2.6 保存agent的ip信息 /v1/edge/gateway/saveAgentext 1.0

API调用

1.1: 保存网关

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/edge/gateway/save

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述
gatewayIp body string n box本地网络地址
gateVerson body string y 网关版本
appKey body string y app Key
appSecretkey body string y appSecretkey
projectName body string y 项目名
projectId body string y 项目id

请求Body描述(非Form表单数据)

{
    "gatewayIp": "192.168.0.1",
    "gateVersion": "v1.0",
    "appKey": "appKey",
    "appSecretkey": "appSecretkey",
    "projectName": "项目名",
    "projectId": "项目id"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
success 顶层 boolean 是 是否成功
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": "0",
    "success": true,
    "msg": null,
    "data": {
        "id": 1,
        "createId": 1,
        "createName": "admin",
        "createTime": "2020-08-10T12:30:48.000+00:00",
        "updateTime": "2020-08-10T12:30:48.000+00:00",
        "version": null,
        "updateId": 1,
        "updateName": "admin",
        "deleteFlag": null,
        "host": "192.168",
        "gateVersion": null,
        "appKey": "123",
        "appSecretkey": "234",
        "projectName": "项目",
        "projectId": 1
    }
}

1.2: 获取网关信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/edge/gateway/getGateway

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
success 顶层 boolean y 是否成功
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
返回结果示例
{
    "code": "0",
    "success": true,
    "message": null,
    "data": {
        "id": 1,
        "createId": 1,
        "createName": "admin",
        "createTime": "2020-08-10T12:30:48.000+00:00",
        "updateTime": "2020-08-10T12:30:48.000+00:00",
        "version": null,
        "updateId": 1,
        "updateName": "admin",
        "deleteFlag": null,
        "host": "192.168",
        "gateVersion": "192",
        "appKey": "123",
        "appSecretkey": "234",
        "projectName": "项目",
        "projectId": 1
    }
}

1.3: 启动网关

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/edge/gateway/startGateway

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 boolean 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": true/false
}

1.4: 启动Agent

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/edge/gateway/startAgent

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述
doorAgent body string n 门禁agent执行指令
elevatorAgent body string n 梯控agent执行指令
videoAgent body string n 视频执行指令

请求Body描述(非Form表单数据)

{
    "doorAgent": "/usr/local/start.sh",
    "elevatorAgent": "/usr/local/start.sh",
    "videoAgent": "/usr/local/start.sh"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 boolean 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": true/false
}

1.5: 获取Agent信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/edge/agent/getAgentList

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 Array 是 响应数据对象
返回结果示例
{
    "code": "0",
    "success": true,
    "message": null,
    "data": [
        {
            "id": 1,
            "createId": 1,
            "createName": "admin",
            "createTime": "2020-08-11T16:49:25.000+00:00",
            "updateTime": "2020-08-11T16:49:39.000+00:00",
            "version": 1,
            "updateId": 1,
            "updateName": "admin",
            "deleteFlag": null,
            "agentType": "door",(door 门禁类；elevator 梯控；video 视频)
            "agentName": "大华门禁",
            "agentDir": "/app/usr",
            "agentCommand": "/usr/local/agent/v01/startup.sh",
            "agentImageurl": "",
            "productId": "123123213",
            "agentVersion": "1.0.0",
            "manufactVersion": ""
        }
    ]
}

1.6: 登录

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/edge/gatewayuser/login

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述
account 顶层 STRING y 账号
password 顶层 STRING y 密码

请求Body描述(非Form表单数据)

{
   "account": "admin",
   "password": "1"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
success 顶层 BOOLEAN 是 成功
data 顶层 BOOLEAN 是 是否成功
返回结果示例
{
    "code": "0",
    "success": true,
    "message": null,
    "data": true
}

1.7: 连网

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/edge/gateway/startConnect

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述
gatewayIp 顶层 STRING y 连网IP
host 顶层 STRING y box本地ip

请求Body描述(非Form表单数据)

{
   "gatewayIp": "192.168.0.0",
   "host": "192.168.0.0"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
success 顶层 BOOLEAN 是 成功
data 顶层 BOOLEAN 是 是否成功
返回结果示例
{
    "code": "0",
    "success": true,
    "message": null,
    "data": true
}

1.8: 检测是否已安装Gateway

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/edge/gateway/checkGateway

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
success 顶层 BOOLEAN 是 成功
data 顶层 BOOLEAN 是 是否成功
返回结果示例
{
    "code": "0",
    "success": true,
    "message": null,
    "data": true
}

错误码

"000011": 已配置网关信息!

1.9: 重置网关

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/edge/gateway/reSet

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
success 顶层 BOOLEAN 是 成功
data 顶层 BOOLEAN 是 是否成功
返回结果示例
{
    "code": "0",
    "success": true,
    "message": null,
    "data": true
}

2.0: 应用授权列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/edge/gateway/getGertInfo

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
success 顶层 BOOLEAN 是 成功
data 顶层 BOOLEAN 是 是否成功
返回结果示例
{
    "code": 200,
    "data": {getAuthCommunityList
        "gatewayName": "评红测试网关1",
        "instanceName": "佛山美的广场-评红测试网关1",
        "firstOnlineTime": "2020-09-16 11:40:01",
        "boxIdentifier": "AAAABBBCCCDD",
        "packageVersion": "1.0.0",
        "isActive": 1,
        "instanceStatus": 1,
        "expiredTime": "2020-09-23 11:40:01",
        "instanceId": 49,
        "appKey": "LIwIaljr",
        "appSecret": "KWL4Bgg9Va3lgtZn",
        "projectName": "佛山美的广场",
        "authType": 1,
        "projectId": "21291194"
    },
    "message": "success"
}

2.1: 获取网关实例信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/edge/gateway/instance/list

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
success 顶层 boolean y 是否成功
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "message": null,
    "data": {
        "gatewayName": "领贤网关1至4栋改名了",
        "instanceName": "邯郸罗兰春天-领贤网关1至4栋改名",
        "firstOnlineTime": "2020-09-29 13:39:30",
        "boxIdentifier": "AAAABBBCCCDD",
        "packageVersion": "1.0.0",
        "isActive": 1,
        "instanceStatus": 0,
        "expiredTime": "2020-12-30 14:50:34",
        "instanceId": 3,
        "appKey": "yuTseW2J",
        "appSecret": "Amp4LhNJW1UlpjLb",
        "projectName": "邯郸罗兰春天",
        "authType": -1,
        "projectId": "21321157"
    }
}

2.2: 校验网关是否激活成功

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/edge/gateway/checkStatus

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述
appKey body string y app Key

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
success 顶层 boolean y 是否成功
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "message": null,
    "requestId": null,
    "data": true
}

2.3: 重启网关

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/edge/gateway/restartGateway

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
success 顶层 boolean y 是否成功
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "message": null,
    "requestId": null,
    "data": true
}

2.4: 重启agent

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/edge/gateway/restartAgent

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述
id body int y agent数据的id

请求Body描述(非Form表单数据)

{
 "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
success 顶层 boolean y 是否成功
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "message": null,
    "requestId": null,
    "data": true
}

2.5: 获取应用实例详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/edge/gateway/instance/info

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
success 顶层 boolean y 是否成功
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "message": null,
    "requestId": null,
    "data": {
        "instanceInfo": {
            "gatewayName": "新增网关929888",
            "instanceName": "美的时代花园-新增网关929",
            "firstOnlineTime": "2020-10-14 14:41:00",
            "boxIdentifier": "BOX20500002",
            "packageVersion": "1.0.1",
            "isActive": 1,
            "instanceStatus": 1,
            "expiredTime": "2022-01-14 23:59:59",
            "instanceId": 4,
            "appKey": "AXnqME4h",
            "appSecret": "kCDeW7G4tRfJbt1h",
            "projectName": "美的时代花园",
            "authType": 1,
            "projectId": "21322153"
        },
        "agentInfo": [
            {
                "manufactVersion": "1",
                "agentType": "door",
                "productId": "161",
                "agentName": "萍红测试Agent1",
                "updateTime": 1597146579000,
                "updateName": "admin",
                "version": 1,
                "agentExt": [],
                "deleteFlag": 1,
                "agentImageurl": "1",
                "updateId": 1,
                "createTime": 1597146565000,
                "createId": 1,
                "agentDir": "/app/usr",
                "agentVersion": "1",
                "id": 1,
                "agentCommand": "/app/iot-agent/door/dahua/v1/bin/docker-restart.sh",
                "createName": "admin"
            },
            {
                "manufactVersion": "1",
                "agentType": "elevator",
                "productId": "160",
                "agentName": "捷顺车场agnet02",
                "updateTime": 1597146579000,
                "updateName": "admin",
                "version": 1,
                "agentExt": [],
                "deleteFlag": 1,
                "agentImageurl": "1",
                "updateId": 1,
                "createTime": 1597146565000,
                "createId": 1,
                "agentDir": "/app/usr",
                "agentVersion": "1.2.1",
                "id": 2,
                "agentCommand": "/app/iot-agent/door/dahua/v2/bin/docker-restart.sh",
                "createName": "admin"
            }
        ],
        "gatewayInfo": {
            "gatewayIp": "192.168.12.205",
            "updateTime": 1597044648000,
            "updateName": "admin",
            "effective": "2022-01-14 23:59:59",
            "updateId": 1,
            "appSecretkey": "kCDeW7G4tRfJbt1h",
            "gateVersion": "美的时代花园-新增网关929版本：1.0.5",
            "createTime": 1597044648000,
            "createId": 1,
            "host": "192.168",
            "name": "美的时代花园-新增网关929",
            "appKey": "AXnqME4h",
            "id": 1,
            "sn": "BOX20500002",
            "projectName": "美的时代花园",
            "projectId": 21322153,
            "createName": "admin"
        }
    }
}

2.6: 保存agent的ip扩展信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/edge/gateway/saveAgentext

方法：POST

名称 位置 类型 必填 描述
account header string y 账号

请求参数

名称 位置 类型 必填 描述
agentId body string y angent的实例id
ip body string n ip信息
port body string n port端口
username body string n 用户名
password body string n 密码

请求Body描述(非Form表单数据)

{
   "agentExtList": [
        {
            "agentId": "1",
            "ip": "192.168.10.1",
            "port": "8080",
            "username": "1",
            "password": "2"
        }
    ]
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
success 顶层 boolean y 是否成功
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "message": null,
    "requestId": null,
    "data": true
}

results matching ""

    No results matching ""