网关应用管理

Topic列表

TOPIC	说明	QOS	方向
<gateway_sn>/apps	上送已安装应用列表	0/1	网关发布
<gateway_sn>/apps_gz	设备已安装应用列表(ZIP压缩)	0/1	网关发布
<gateway_sn>/app/install	安装新应用	0/1	网关订阅
<gateway_sn>/app/uninstall	卸载应用	0/1	网关订阅
<gateway_sn>/app/upgrade	升级应用版本	0/1	网关订阅
<gateway_sn>/app/list	请求网关上送应用列表	0/1	网关订阅
<gateway_sn>/app/conf	更改应用配置	0/1	网关订阅
<gateway_sn>/app/start	启动应用	0/1	网关订阅
<gateway_sn>/app/stop	停止应用	0/1	网关订阅
<gateway_sn>/app/restart	重启应用	0/1	网关订阅
<gateway_sn>/app/option	应用属性（如开机自启）	0/1	网关订阅
<gateway_sn>/app/rename	应用示例名修改	0/1	网关订阅
<gateway_sn>/result/app	请求执行结果反馈	0/1	网关发布

上送已安装应用列表

网关连接到平台后、需要上送本网关已安装的应用信息。

示例:

{
    "Net_info": {
        "running": 1562432520.16,
        "sn": "363bda00c1",
        "conf": {},
        "islocal": 1,
        "name": "APP00000115",
        "version": "7"
    },
    "multi_route_manager": {
        "running": 1562432520.16,
        "sn": "14b8318e56",
        "conf": {
            "live_check_ip": "114.114.114.114",
            "lan": "lan",
            "lan_live_ip": "114.114.115.115",
            "primary_wan": "newwan",
            "secondary_wan": "wan",
            "check_cycle": 20
        },
        "version": "23",
        "name": "APP00000096"
    },
    "freeioe_Vnet": {
        "running": 1562432520.16,
        "sn": "7e58191cb2",
        "conf": {},
        "version": 7,
        "name": "APP00000135"
    }
}

其中Net_info为JSON字典中的key，也是应用本地示例名（本地唯一，不同于应用名称)

数据说明：

数据项	说明	备注
running	应用开始运行的时间戳	null或者此项不存在代表应用未运行，
sn	应用示例序号	暂未使用
conf	应用配置信息	对象格式
version	版本号（整数）
name	应用ID，平台唯一名称	冬笋云应用中心的应用ID，格式为: APPXXXXXXXXXX 或 <app_owner>/<app_code_name>

应用安装

用户从平台触发网关安装新应用的请求，示例：

{
    "id":"<id_from_platform_uniqueue>",
    "data": {
        "inst": "multi_route_manager",
        "conf": {
            "live_check_ip": "114.114.114.114",
            "lan": "lan",
            "lan_live_ip": "114.114.115.115",
            "primary_wan": "newwan",
            "secondary_wan": "wan",
            "check_cycle": 20
        },
        "version": "23",
        "name": "APP00000096",
        "sn": "14b8318e56"
    }
}

数据项	说明	备注
id	请求唯一ID，用作反馈执行结果	建议使用UUID字符串
data.inst	应用本地实例名	本地唯一
data.conf	应用配置信息	对象格式
data.version	版本号（整数）
data.name	应用ID，平台唯一名称	冬笋云应用中心的应用ID，格式为: APPXXXXXXXXXX 或 <app_owner>/<app_code_name>

应用卸载

用户从平台触发网关应用卸载的请求，示例：

{
    "id":"<id_from_platform_uniqueue>",
    "data": {
        "inst": "multi_route_manager"
    }
}

数据项	说明	备注
id	请求唯一ID，用作反馈执行结果	建议使用UUID字符串
data.inst	应用本地实例名（本地唯一)

应用版本升级

用户从平台触发网关应用版本升级的请求，示例：

{
    "id":"<id_from_platform_uniqueue>",
    "data": {
        "inst": "multi_route_manager",
        "conf": {
            "live_check_ip": "114.114.114.114",
            "lan": "lan",
            "lan_live_ip": "114.114.115.115",
            "primary_wan": "newwan",
            "secondary_wan": "wan",
            "check_cycle": 20
        },
        "version": "23",
        "name": "APP00000096",
    }
}

数据项	说明	备注
id	请求唯一ID，用作反馈执行结果	建议使用UUID字符串
data.inst	应用本地实例名	本地唯一
data.conf	应用配置信息	对象格式(节点不存在则不改动现有应用配置信息)
data.version	升级版本号（整数）
data.name	应用ID，平台唯一名称	冬笋云应用中心的应用ID，格式为: APPXXXXXXXXXX 或 <app_owner>/<app_code_name>

应用列表刷新

用户从平台触发网关安装新应用的请求，示例：

{
    "id":"<id_from_platform_uniqueue>",
    "data": {}
}

数据项	说明	备注
id	请求唯一ID，用作反馈执行结果	建议使用UUID字符串
data	不使用

更改应用配置

用户从平台触发更改应用配置的请求，示例：

{
    "id":"<id_from_platform_uniqueue>",
    "data": {
        "inst": "multi_route_manager",
        "conf": {
            "live_check_ip": "114.114.114.114",
            "lan": "lan",
            "lan_live_ip": "114.114.115.115",
            "primary_wan": "newwan",
            "secondary_wan": "wan",
            "check_cycle": 20
        }
    }
}

数据项	说明	备注
id	请求唯一ID，用作反馈执行结果	建议使用UUID字符串
data.inst	应用本地实例名	本地唯一
data.conf	应用配置信息	对象格式(节点不存在则不改动现有应用配置信息)

启动/停止/重启应用

用户从平台触发启动/停止/重启应用的请求，示例：

{
    "id":"<id_from_platform_uniqueue>",
    "data": {
        "inst": "multi_route_manager",
        "reason": "reason of this action"
    }
}

数据项	说明	备注
id	请求唯一ID，用作反馈执行结果	建议使用UUID字符串
data.inst	应用本地实例名	本地唯一
data.reason	动作原因	可选

应用属性修改

应用属性修改，示例：

{
    "id":"<id_from_platform_uniqueue>",
    "data": {
        "inst": "multi_route_manager",
        "option": "auto",
        "value": 1
    }
}

数据项	说明	备注
id	请求唯一ID，用作反馈执行结果	建议使用UUID字符串
data.inst	应用本地实例名	本地唯一
data.option	选项名称	auto 为开机自启，暂无其他属性
data.value	选项值

应用示例名修改

用户从平台修改应用示例名，网关执行成功后，需要重新上送应用列表数据，示例：

{
    "id":"<id_from_platform_uniqueue>",
    "data": {
        "inst": "multi_route_manager",
        "new_name": "multi_route_manager222"
    }
}

数据项	说明	备注
id	请求唯一ID，用作反馈执行结果	建议使用UUID字符串
data.inst	应用本地实例名	本地唯一
data.new_name	新示例名	本地唯一

请求执行结果反馈

示例:

{
    "id":"XXXXXX",
    "result":true,
    "message":"Install Application xxxx successfully",
    "timestamp":1562474541.01,
    "timestamp_str":"Sun Jul  7 13:04:13 2019"
}

数据项	说明	备注
id	指令执行请求的唯一ID	来自指令执行请求时平台下发的id属性
result	结果(boolean)
message	执行结果信息（字符串)
timestamp	执行反馈时间戳
timestamp_str	执行反馈时间戳字符串（不包含毫秒值)

平台请求、网关结果反馈流程

平台请求交互