网关

网关API

1 获取网关列表

功能：获取用户权限内的所有网关列表。
请求方式：GET
url：/agentList
请求参数：

参数	取值	必需	说明
token	String	是	用户通行证
agentId	String	否	网关序列号
condition	Integer	否	网关在线状态：0---离线，1---在线

返回参数格式： json 参数说明：

参数	取值	说明
status	String	请求状态。成功：100；失败：其它
msg	String	错误信息（status!=100时）
data	JSON	结果集

返回结果示例

{
    "status":"100",
    "data":[
        {
            "serialNumber": /* 网关序列号 */
            "agentCondition": 1, /* 网关在线状态：0 or null--离线，1--在线 */,
            "protocol": "http", /* 网关通信协议，http,mqtt等 */,
            "versionDetail": "3.6.6", /*agent 的版本号*/,
            "vpnVersion": "1.0.0", /*agent支持的vpn版本号*/,
            "deviceList":[
                {
                    "condition": 1, /* device的数据采集状态，0 or null—没有数据上传，1—有数据上传 */,
                    "deviceId": 1229811922, /* 设备id */,
                    "deviceName":"DA500测试", /* 设备名称 */,
                    "serialNumber":"1200988" /* 网关序列号 */,
                }
            ]
        }
    ]
}

2 获取网关的在线状态

功能：根据网关序列号，获取在线状态
请求方式： POST
url： /agentList/condition
请求参数：

参数	取值	必需	说明
token	String	是	用户通行证
hash	String	是	哈希值
agentIds J	SONArray	是	网关序列号列表

请求参数示例：

{
    "agentIds":[
        1500001,
        1500002
    ],
    "token":"8534f960-8471-4dec-b470-cda3d348ecbc",
"hash":"test"
}

返回参数格式： json 返回参数说明：

参数	取值	说明
status	String	请求状态。成功：100；失败：其它
msg	String	错误信息（status为其它时）
data	String	JSONArray
agentid	String	网关序列号
condition	String	网关的在线状态。1---在线，0—--离线

请求示例：

<%=BaseUrl%>/agentList/condition

返回示例：

{
    "status":"100",
    "data":[
        {
            "agentid":1500001,
            "condition":0
        },
        {
            "agentid":1500002,
            "condition":0
        }
    ]
}

3 下发配置文件

3.1 向DA/SE下发配置文件

功能：给IOT网关下发配置文件

下发的配置文件为XML格式。有几种情况下不会下发：

1. 如果网关没有向云平台注册过，不能下发；  
2. 如果网关当前离线，不能下发；

配置文件下发之后，循环调用查询下发配置文件结果接口API接口（/agent/register）获取下发配置文件的结果。
请求方式： POST
url： /config/send
请求参数： JSON 格式：

参数	取值	必需	说明
token	String	是	用户通行证
serialNumber	Integer	是	要下发配置文件的网关序列号
config	String	是	要下发的配置文件。该配置文件必须为XML格式。

返回数据格式： JSON
返回参数说明：

参数	取值	说明
status	String	请求状态：成功：100；失败：其它
data	Long	此次下发操作的标记registerID，获取注册结果时使用该参数
msg	String	错误信息（status!=100时）

返回示例：

{
    "status":100,
    "data":1510031082602
}

3.2 查询下发配置文件结果接口

功能：给IOT网关下发配置文件之后，网关会重新向云平台注册，此接口用于获取注册结果。需要多次循环调用，直到获取到注册成功/失败/超时的结果。
请求方式： GET
url： /agent/register
请求参数格式： JSON

参数	取值	必需	说明
token	String	是	用户通行证
serialNumber	Integer	是	盒子序列号
registerID	Long	是	取值自下发配置文件时获取的结果中的data值。

返回数据格式： JSON
参数说明：

参数	取值	说明
status	String	请求状态：成功：100；失败：其它。103：参数错误，104：无效的token，125：网关离线，无法获取注册结果.，102：获取注册结果超时，122：网关等待注册，126：正在注册，123：注册失败，111：未知错误
msg	String	错误信息（status!=100时）

返回示例：

{
    "status":"122",
    "msg":"网关等待注册"
}

{
    "status":"100",
    "msg":"注册成功"
}