附录B：API 接口规范 - Powered by MinDoc

API 接口规范
创建终端配置
请求参数：
响应参数：
result:
请求示例：
响应示例：
更新终端配置
请求参数：
响应参数：
请求示例：
响应示例：
删除终端配置
请求参数：
响应参数：
请求示例：
响应示例：
终端配置详情
请求参数：
响应参数：
object:
请求示例：
响应示例：
终端配置列表
请求参数：
响应参数：
object:
请求示例：
响应示例：
终端接口
创建终端
请求参数：
响应参数：
result:
请求示例：
响应示例：
更新终端
请求参数：
响应参数：
请求示例：
响应示例：
删除终端
响应参数：
请求示例：
响应示例：
终端详情
请求参数：
响应参数：
object:
请求示例：
响应示例：
终端列表
请求参数：
响应参数：
object:
请求示例：
响应示例：

API 接口规范

创建终端配置

请求参数：

参数名称	是否必选	数据类型	描述
action	是	string	指令
actionid	否	string	指令编号
organization_id	否	string	组织ID
uid	否	string	唯一编号
name	是	string	终端配置名称
description	否	string	终端配置描述信息
hardware	否	string	终端硬件信息
mcu_file	否	string	mcu文件
mcu_version	否	string	mcu版本
remosu_file	否	string	remosu文件
remosu_version	否	string	remosu版本
lua_file	否	string	lua文件
lua_version	否	string	lua版本
terminal_script	否	string	终端脚本
config_script	否	string	配置脚本
reference	否	string	参考号
created_by	是	int	创建人
last_modified_by	是	int	更改人
is_available	是	int	是否生效

响应参数：

参数名称	数据类型	描述
resp	string	返回指令
actionid	string	返回指令编号
code	int	返回码
msg	string	提示消息
info	string	详细信息
result	object	返回结果

result:

参数名称	数据类型	描述
uid	string	返回终端配置唯一编号

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "create_terminal_config",
    "actionid": "1233445",
    "name": "config1",
    "description": "config number 1",
    "hardware": "arm",
    "mcu_file": "/var/image/default",
    "mcu_version": "v1.0.0",
    "remosu_file": "var/image/default",
    "remosu_version": "v1.0.0",
    "lua_file": "var/image/default",
    "lua_version": "v1.0.0",
    "terminal_script": "{\"alt\": 1}",
    "config_script": "{\"alt\": 1}",
    "reference": "参考号123",
    "created": "2020/9/28 14:44:1",
    "created_by": 1,
    "last_modified": "2020/9/28 14:44:1",
    "last_modified_by": 1,
    "is_available": 1
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "create_terminal_config",
    "actionid": "1233445",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "TCF1324495600002",
        "name": "config1"
    }
}

更新终端配置

请求参数：

参数名称	是否必选	数据类型	描述
action	是	string	指令
actionid	否	string	指令编号
organization_id	否	string	组织ID
uid	是	string	终端配置唯一编号
name	是	string	终端配置名称
description	否	string	终端配置描述信息
hardware	否	string	终端硬件信息
mcu_file	否	string	mcu文件
mcu_version	否	string	mcu版本
remosu_file	否	string	remosu文件
remosu_version	否	string	remosu版本
lua_file	否	string	lua文件
lua_version	否	string	lua版本
terminal_script	否	string	终端脚本
config_script	否	string	配置脚本
reference	否	string	参考号
created_by	是	int	创建人
last_modified_by	是	int	更改人
is_available	是	int	是否生效

响应参数：

参数名称	数据类型	描述
resp	string	返回指令
actionid	string	返回指令编号
code	int	返回码
msg	string	提示消息
info	string	详细信息
result	object	返回结果

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "update_terminal_config",
    "actionid": "1233445",
    "uid": "TCF1324495600002",
    "name": "config2",
    "description": "config number 2",
    "hardware": "arm",
    "mcu_file": "/var/image/default",
    "mcu_version": "v1.0.0",
    "remosu_file": "var/image/default",
    "remosu_version": "v1.0.0",
    "lua_file": "var/image/default",
    "lua_version": "v1.0.0",
    "terminal_script": "{\"alt\": 1}",
    "config_script": "{\"alt\": 1}",
    "reference": "参考号123",
    "created": "2020/9/28 14:44:1",
    "created_by": 1,
    "last_modified": "2020/9/28 14:44:1",
    "last_modified_by": 1,
    "is_available": 1
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "update_terminal_config",
    "actionid": "1233445",
    "code": 200,
    "msg": "成功"
}

删除终端配置

请求参数：

参数名称	是否必选	数据类型	描述
action	是	string	指令
actionid	否	string	指令编号
uid	是	string	终端配置唯一编号

响应参数：

参数名称	数据类型	描述
resp	string	返回指令
actionid	string	返回指令编号
code	int	返回码
msg	string	提示消息
info	string	详细信息
result	object	返回结果

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "delete_terminal_config",
    "actionid": "1234",
    "uid": "TCF1324495600002"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "delete_terminal_config",
    "actionid": "1234",
    "code": 200,
    "msg": "成功"
}

终端配置详情

请求参数：

参数名称	是否必选	数据类型	描述
action	是	string	指令
actionid	否	string	指令编号
uid	是	string	终端配置唯一编号

响应参数：

参数名称	数据类型	描述
resp	string	返回指令
actionid	string	返回指令编号
code	int	返回码
msg	string	提示消息
info	string	详细信息
result	object	返回结果

object:

参数名称	数据类型	描述
id	int	表自增编号
organization_id	int	组织ID
uid	string	终端配置唯一编号
name	string	终端配置名称
description	string	终端配置描述信息
hardware	string	终端硬件信息
mcu_file	string	mcu文件
mcu_version	string	mcu版本
remosu_file	string	remosu文件
remosu_version	string	remosu版本
lua_file	string	lua文件
lua_version	string	lua版本
terminal_script	object	终端脚本
config_script	object	配置脚本
reference	string	参考号
created	string	创建时间
created_by	int	创建人
last_modified	string	更新时间
last_modified_by	int	更改人
is_available	int	是否生效

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "get_terminal_config_item",
    "actionid": "12345",
    "uid": "TCF1245422100001"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "get_terminal_config_item",
    "actionid": "12345",
    "code": 200,
    "msg": "成功",
    "result": {
        "id": 1008,
        "uid": "TCF1245422100001",
        "name": "config1",
        "description": "config number 1",
        "hardware": "arm",
        "mcu_file": "/var/image/default",
        "mcu_version": "v1.0.0",
        "remosu_file": "var/image/default",
        "remosu_version": "v1.0.0",
        "lua_file": "var/image/default",
        "lua_version": "v1.0.0",
        "terminal_script": {
            "alt": 1
        },
        "config_script": {
            "alt": 1
        },
        "reference": "参考号123",
        "created": "2021-02-24 16:07:54",
        "created_by": 1,
        "last_modified": "2021-02-24 16:07:54",
        "last_modified_by": 1,
        "is_available": 1
    }
}

终端配置列表

请求参数：

参数名称	是否必选	数据类型	描述
action	是	string	指令
actionid	否	string	指令编号

响应参数：

参数名称	数据类型	描述
resp	string	返回指令
actionid	string	返回指令编号
code	int	返回码
msg	string	提示消息
info	string	详细信息
result	[]object	返回结果

object:

参数名称	数据类型	描述
id	int	表自增编号
uid	string	终端配置唯一编号
organization_id	int	组织ID
name	string	终端配置名称
description	string	终端配置描述信息
hardware	string	终端硬件信息
mcu_file	string	mcu文件
mcu_version	string	mcu版本
remosu_file	string	remosu文件
remosu_version	string	remosu版本
lua_file	string	lua文件
lua_version	string	lua版本
terminal_script	object	终端脚本
config_script	object	配置脚本
reference	string	参考号
created	string	创建时间
created_by	int	创建人
last_modified	string	更新时间
last_modified_by	int	更改人
is_available	int	是否生效

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
   "action": "get_terminal_config_list",
    "actionid": "123454"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "get_terminal_config_list",
    "actionid": "123454",
    "code": 200,
    "msg": "成功",
    "result": [
        {
            "id": 1007,
            "uid": "TCF1233360400001",
            "name": "config1",
            "description": "config number 1",
            "hardware": "arm",
            "mcu_file": "/var/image/default",
            "mcu_version": "v1.0.0",
            "remosu_file": "var/image/default",
            "remosu_version": "v1.0.0",
            "lua_file": "var/image/default",
            "lua_version": "v1.0.0",
            "terminal_script": {
                "alt": 1
            },
            "config_script": {
                "alt": 1
            },
            "reference": "参考号123",
            "created": "2021-02-23 15:22:34",
            "created_by": 1,
            "last_modified": "2021-02-23 15:22:34",
            "last_modified_by": 1,
            "is_available": 1
        },
        {
            "id": 1008,
            "uid": "TCF1245422100001",
            "name": "config1",
            "description": "config number 1",
            "hardware": "arm",
            "mcu_file": "/var/image/default",
            "mcu_version": "v1.0.0",
            "remosu_file": "var/image/default",
            "remosu_version": "v1.0.0",
            "lua_file": "var/image/default",
            "lua_version": "v1.0.0",
            "terminal_script": {
                "alt": 1
            },
            "config_script": {
                "alt": 1
            },
            "reference": "参考号123",
            "created": "2021-02-24 16:07:54",
            "created_by": 1,
            "last_modified": "2021-02-24 16:07:54",
            "last_modified_by": 1,
            "is_available": 1
        }
    ]
}

终端接口

创建终端

请求参数：

参数名称	是否必选	数据类型	描述
action	是	string	指令
actionid	否	string	指令编号
organization_id	否	string	组织ID
uid	是	string	终端唯一编号
name	是	string	终端名称
description	否	string	终端描述
type	是	string	终端类型
maker	否	string	终端制造商
config_id	是	string	终端配置编号
mode	是	string	检验模式
username	是	string	用户名
pin	是	string	密码
access	是	string	访问权限
topic	否	string	主题
server	否	string	gards服务器
session_expiry	否	int	会话过期时间
keep_alive	否	int	保活时间
encryption	否	int	是否加密
dixie	否	int	是否启用scram-sha-1高级鉴权
rsa_privatekey	否	string	rsa私钥
reference	否	string	参考号
created_by	是	int	创建人
last_modified_by	是	int	更新人
is_available	是	int	是否生效

响应参数：

参数名称	数据类型	描述
resp	string	返回指令
actionid	string	返回指令编号
code	int	返回码
msg	string	提示消息
info	string	详细信息
result	object	返回结果

result:

参数名称	数据类型	描述
uid	string	返回终端唯一编号

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "create_terminal",
    "actionid": "12345",
    "uid": "fidiser12",
    "name": "terminal1",
    "description": "terminal1",
    "type": "Aprus-X",
    "maker": "智物联",
    "config_id": "CFG1212994600001",
    "mode": "pwd",
    "username": "test",
    "pin": "test",
    "access": "all",
    "topic": "all",
    "server": "192.168.0.132",
    "session_expiry": 120,
    "keep_alive": 30,
    "encryption": 0,
    "dixie": 1,
    "rsa_privatekey": "12345678",
    "reference": "参考号123",
    "created_by": 1,
    "last_modified_by": 1,
    "is_available": 1
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "create_terminal",
    "actionid": "12345",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "fidiser12",
        "name": "terminal1"
    }
}

更新终端

请求参数：

参数名称	是否必选	数据类型	描述
action	是	string	指令
actionid	否	string	指令编号
organization_id	否	string	组织ID
uid	是	string	终端唯一编号
name	是	string	终端名称
description	否	string	终端描述
type	是	string	终端类型
maker	否	string	终端制造商
config_id	是	string	终端配置编号
mode	是	string	检验模式
username	是	string	用户名
pin	是	string	密码
access	是	string	访问权限
topic	否	string	主题
server	否	string	gards服务器
session_expiry	否	int	会话过期时间
keep_alive	否	int	保活时间
encryption	否	int	是否加密
dixie	否	int	是否启用scram-sha-1高级鉴权
rsa_privatekey	否	string	rsa私钥
reference	否	string	参考号
created_by	是	int	创建人
last_modified_by	是	int	更新人
is_available	是	int	是否生效

响应参数：

参数名称	数据类型	描述
resp	string	返回指令
actionid	string	返回指令编号
code	int	返回码
msg	string	提示消息
info	string	详细信息
result	object	返回结果

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "update_terminal",
    "actionid": "12345",
    "id": 1012,
    "uid": "fidiser12",
    "name": "terminal7",
    "description": "terminal7",
    "type": "Aprus-X",
    "maker": "智物联",
    "config_id": "CFG1212994600001",
    "is_route": 1,
    "mode": "auto",
    "username": "test",
    "pin": "test",
    "access": "all",
    "topic": "all",
    "server": "192.168.0.132",
    "session_expiry": 120,
    "keep_alive": 30,
    "encryption": 0,
    "dixie": 1,
    "rsa_privatekey": "12345678",
    "reference": "参考号123",
    "created_by": 1,
    "last_modified_by": 1,
    "is_available": 1
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "update_terminal",
    "actionid": "12345",
    "code": 200,
    "msg": "成功"
}

删除终端

请求参数：

参数名称	是否必选	数据类型	描述
action	是	string	指令
actionid	否	string	指令编号
uid	是	string	终端唯一编号

响应参数：

参数名称	数据类型	描述
resp	string	返回指令
actionid	string	返回指令编号
code	int	返回码
msg	string	提示消息
info	string	详细信息
result	object	返回结果

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "delete_terminal",
    "actionid": "12345",
    "uid": "fidiser12"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "delete_terminal",
    "actionid": "12345",
    "code": 200,
    "msg": "成功"
}

终端详情

请求参数：

参数名称	是否必选	数据类型	描述
action	是	string	指令
actionid	否	string	指令编号
uid	是	string	终端唯一编号

响应参数：

参数名称	数据类型	描述
resp	string	返回指令
actionid	string	返回指令编号
code	int	返回码
msg	string	提示消息
info	string	详细信息
result	object	返回结果

object:

参数名称	数据类型	描述
id	int	表自增编号
organization_id	int	组织ID
uid	string	终端唯一编号
name	string	终端名称
description	string	终端描述
type	string	终端类型
maker	string	终端制造商
config_id	string	终端配置编号
mode	string	检验模式
username	string	用户名
pin	string	密码
access	string	访问权限
topic	string	主题
server	string	gards服务器
session_expiry	int	会话过期时间
keep_alive	int	保活时间
encryption	int	是否加密
dixie	int	是否启用scram-sha-1高级鉴权
rsa_privatekey	string	rsa私钥
reference	string	参考号
created	string	创建时间
created_by	int	创建人
last_modified	string	更新时间
last_modified_by	int	更新人
is_available	int	是否生效

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "get_terminal_item",
    "actionid": "13454",
    "uid": "fidiser1"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "get_terminal_item",
    "actionid": "13454",
    "code": 200,
    "msg": "成功",
    "result": {
        "id": 1026,
        "uid": "fidiser1",
        "name": "terminal1",
        "description": "terminal1",
        "type": "Aprus-X",
        "maker": "智物联",
        "config_id": "TCF1233360400001",
        "mode": "pwd",
        "username": "test",
        "pin": "test",
        "access": "all",
        "topic": "all",
        "server": "192.168.0.132",
        "session_expiry": 120,
        "keep_alive": 30,
        "encryption": 1,
        "dixie": 1,
        "rsa_privatekey": "12345678",
        "reference": "参考号123",
        "created": "2021-02-24 16:07:50",
        "created_by": 1,
        "last_modified": "2021-02-24 16:07:50",
        "last_modified_by": 1,
        "is_available": 1
    }
}

终端列表

请求参数：

参数名称	是否必选	数据类型	描述
action	是	string	指令
actionid	否	string	指令编号
uids	否	[]string	终端唯一编号列表，若存在，返回指定终端列表

响应参数：

参数名称	数据类型	描述
resp	string	返回指令
actionid	string	返回指令编号
code	int	返回码
msg	string	提示消息
info	string	详细信息
result	[]object	返回结果

object:

参数名称	数据类型	描述
id	int	表自增编号
organization_id	int	组织ID
uid	string	终端唯一编号
name	string	终端名称
description	string	终端描述
type	string	终端类型
maker	string	终端制造商
config_id	string	终端配置编号
mode	string	检验模式
username	string	用户名
pin	string	密码
access	string	访问权限
topic	string	主题
server	string	gards服务器
session_expiry	int	会话过期时间
keep_alive	int	保活时间
encryption	int	是否加密
dixie	int	是否启用scram-sha-1高级鉴权
rsa_privatekey	string	rsa私钥
reference	string	参考号
created	string	创建时间
created_by	int	创建人
last_modified	string	更新时间
last_modified_by	int	更新人
is_available	int	是否生效

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "get_terminal_list",
    "actionid": "123",
    "uids": ["test", "test1"]
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "get_terminal_list",
    "actionid": "123",
    "code": 200,
    "msg": "成功",
    "result": [
        {
            "id": 1022,
            "uid": "test",
            "name": "terminal1",
            "description": "terminal1",
            "type": "Aprus-X",
            "maker": "智物联",
            "config_id": "TCF1233360400001",
            "mode": "pwd",
            "username": "test",
            "pin": "test",
            "access": "all",
            "topic": "all",
            "server": "192.168.0.132",
            "session_expiry": 120,
            "keep_alive": 30,
            "encryption": 1,
            "dixie": 1,
            "rsa_privatekey": "12345678",
            "terminal_object_map": null,
            "reference": "参考号123",
            "created": "2021-02-23 17:55:54",
            "created_by": 1,
            "last_modified": "2021-02-23 17:55:54",
            "last_modified_by": 1,
            "is_available": 1
        },
        {
            "id": 1020,
            "uid": "test1",
            "name": "terminal1",
            "description": "terminal1",
            "type": "Aprus-X",
            "maker": "智物联",
            "config_id": "TCF1233360400001",
            "mode": "pwd",
            "username": "test",
            "pin": "test",
            "access": "all",
            "topic": "all",
            "server": "192.168.0.132",
            "session_expiry": 120,
            "keep_alive": 30,
            "encryption": 1,
            "dixie": 1,
            "rsa_privatekey": "12345678",
            "terminal_object_map": null,
            "reference": "参考号123",
            "created": "2021-02-23 17:52:20",
            "created_by": 1,
            "last_modified": "2021-02-23 17:52:20",
            "last_modified_by": 1,
            "is_available": 1
        }
    ]
}

文档更新时间: 2024-07-12 15:47 作者：Mixiot