1. MIX.IOT.2018.F.18.01-APIA API

1.1. 请求地址

HOST：http://xxx.com/（具体以系统部署地址为准）请求地址：HOST +下文接口中的url

1.2. 请求说明

固定传参

在 http header 中传入参数，该参数来源于用户登录后获得到的验证信息，用于鉴权

参考

Authorization: Bearer d6nAGWraBuRY4wkEo7KLK4d3N53A4i5gMnj1iiCZQujZS783WE1SfHNkBFjkns85

1.3. 响应说明

所有响应都提供了遵循如下响应规则，在后面的响应说明中不再做出说明

状态码说明：

code含义
500错误
200执行成功

1.4. 接口列表

1.4.1. 添加授权

1.4.1.1. 功能描述

属性值
urlauth/register
http方法post
Content-Typex-www-form-urlencode

1.4.1.2. 请求参数

参数名称数据类型长度/字节描述是否必选
appid授权应用名称string非空
secret授权码string非空

1.4.1.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": "恭喜您注册成功!"
  5. }

1.4.2. 获取token

1.4.2.1. 功能描述

属性值
urlauth/getToken
http方法post
Content-Typex-www-form-urlencode

1.4.2.2. 请求参数

参数名称数据类型长度/字节描述是否必选
appid授权应用名称string非空
secret授权码string非空

1.4.2.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBpZCI6ImZpZGlzIiwiZXhwIjoxNTM3NDM2MDM2LCJpYXQiOjE1Mzc0Mjg4MzYsInNlY3JldCI6Im1peEAxMjMifQ._B3RjGIztMkhWHRzi3IYYlkfkiGst63mTm042_Oet4w"
  5. }

1.4.3. 用户中心授权

1.4.3.1. 功能描述

属性值
urlauth
http方法post
Content-Typex-www-form-urlencode

1.4.3.2. 请求参数

参数名称数据类型长度/字节描述是否必选
source来源string非空
ticket票据string非空

1.4.3.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBpZCI6ImZpZGlzIiwiZXhwIjoxNTM3NDM2MDM2LCJpYXQiOjE1Mzc0Mjg4MzYsInNlY3JldCI6Im1peEAxMjMifQ._B3RjGIztMkhWHRzi3IYYlkfkiGst63mTm042_Oet4w"
  5. }

1.4.4. 用户列表

1.4.4.1. 功能描述

属性值
urlagent/user/show
http方法post
Content-Typex-www-form-urlencode

1.4.4.2. 请求参数

参数名称数据类型长度/字节描述是否必选
items每页显示的条数int非空
page当前页int非空
start_time开始时间，记录创建的时间string
end_time结束时间string
appid用户string

1.4.4.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": {
  5.         "data": [
  6.             {
  7.                 "appid": "admin",
  8.                 "created": "2018-10-11T09:45:49Z",
  9.                 "description": null,
  10.                 "isAvailable": "1"
  11.             }
  12.         ],
  13.         "pagination": {
  14.             "page": "1",
  15.             "page_size": 1,
  16.             "total": 3
  17.         }
  18.     }
  19. }

1.4.5. 用户编辑

1.4.5.1. 功能描述

属性值
urlagent/user/edit
http方法post
Content-Typex-www-form-urlencode

1.4.5.2. 请求参数

参数名称数据类型长度/字节描述是否必选
id唯一标识Integer非空
appidAppid即clientString非空
secret密钥string
decription描述string

1.4.5.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": "用户修改成功！"
  5. }

1.4.6. 用户删除

1.4.6.1. 功能描述

属性值
urlagent/user/delete
http方法post
Content-Typex-www-form-urlencode

1.4.6.2. 请求参数

参数名称数据类型长度/字节描述是否必选
id唯一标识Integer非空
appidAppid即clientString非空

1.4.6.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": "用户删除成功！"
  5. }

1.4.7. client获取

1.4.7.1. 功能描述

属性值
urlagent/clients
http方法post
Content-Typex-www-form-urlencode

1.4.7.2. 请求参数

参数名称数据类型长度/字节描述是否必选
id唯一标识Integer非空

1.4.7.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": {
  5.         "data": [
  6.             "admin1",
  7.             "fidis",
  8.             "mixwork",
  9.             "mixmessenger",
  10.             "admin",
  11.             "test6",
  12.             "test7",
  13.             "etet",
  14.             "gtegeg",
  15.             "mixworks",
  16.             "tt"
  17.         ]
  18.     }
  19. }

1.4.8. 规则添加

1.4.8.1. 功能描述

属性值
urlagent/rule/add
http方法post
Content-Typex-www-form-urlencode

1.4.8.2. 请求参数

参数名称数据类型长度/字节描述是否必选
type规则类型String唯一标识非空
name规则名称String非空
Data_source数据源Stringmysql/redis/influxdb/file非空
host主机String非空
port端口号int非空
db数据库string非空
pwd密码string非空
command执行指令string非空
description描述string非空

1.4.8.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": "代理规则添加成功！"
  5. }

1.4.9. 规则编辑

1.4.9.1. 功能描述

属性值
urlagent/rule/edit
http方法post
Content-Typex-www-form-urlencode

1.4.9.2. 请求参数

参数名称数据类型长度/字节描述**是否必选
type规则类型String唯一标识非空
name规则名称String非空
Data_source数据源Stringmysql/redis/influxdb/file非空
host主机String非空
port端口号int非空
db数据库string非空
pwd密码string非空
command执行指令string非空
description描述string非空
id唯一标识int非空

1.4.9.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": "规则编辑成功！"
  5. }

1.4.10. 规则编辑

1.4.10.1. 功能描述

说明：如果 有代理在使用此规则， 则规则将无法删除， 必须删除相应代理，方能删除！

属性值
urlagent/rule/delete
http方法post
Content-Typex-www-form-urlencode

1.4.10.2. 请求参数

参数名称数据类型长度/字节描述是否必选
id唯一标识int非空
type规则类型string用于确认有哪些代理在使用非空

1.4.10.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": "规则删除成功！"
  5. }

1.4.11. 规则列表

1.4.11.1. 功能描述

说明：如果 有代理在使用此规则， 则规则将无法删除， 必须删除相应代理，方能删除！

属性值
urlagent/rule/show
http方法post
Content-Typex-www-form-urlencode

1.4.11.2. 请求参数

参数名称数据类型长度/字节描述是否必选
items每页显示的条数int非空
page当前页int非空
Start_time开始时间，记录创建的时间string
end_time结束时间string
type代理类型string
name代理名称string
data_source数据源string
description描述string

1.4.11.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": {
  5.         "data": [
  6.             {
  7.                 "command": "select %v from %v where code= %v and is_available = 1 %v order by created desc limit %v",
  8.                 "created": "2018-09-09T09:33:42Z",
  9.                 "dataSource": "mysql",
  10.                 "db": "fidis",
  11.                 "description": "根据单表获取获取维保数据",
  12.                 "host": "192.168.1.208",
  13.                 "name": "Maintenance single table",
  14.                 "port": 3306,
  15.                 "pwd": "root123",
  16.                 "ruleType": "MT",
  17.                 "username": "root"
  18.             },
  19.             {
  20.                 "command": "select %v from %v where equipment_id in (select equipment_id from admin_equipment where customer_id %v ) and code %v and is_available = 1 order by created desc limit %v",
  21.                 "created": "2018-09-07T10:24:49Z",
  22.                 "dataSource": "mysql",
  23.                 "db": "fidis",
  24.                 "description": "根据customer_id获取维保数据",
  25.                 "host": "192.168.1.208",
  26.                 "name": "Maintenance",
  27.                 "port": 3306,
  28.                 "pwd": "root123",
  29.                 "ruleType": "MT2",
  30.                 "username": "root"
  31.             }
  32.         ],
  33.         "pagination": {
  34.             "page": "1",
  35.             "page_size": 2,
  36.             "total": 9
  37.         }
  38.     }
  39. }

1.4.12. type获取

1.4.12.1. 功能描述

属性值
urlagent/rule/types
http方法post
Content-Typex-www-form-urlencode

1.4.12.2. 请求参数

参数名称数据类型长度/字节描述是否必选

1.4.12.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": {
  5.         "data": [
  6.             "MO",
  7.             "MT",
  8.             "MT2",
  9.             "MT3"
  10.         ]
  11.     }
  12. }

1.4.13. 代理添加

1.4.13.1. 功能描述

属性值
urlagent/add
http方法post
Content-Typex-www-form-urlencode

1.4.13.2. 请求参数

参数名称数据类型长度/字节描述是否必选
rule_type代理规则string非空
name代理名称String可空
schedule运行条件string非空
wherecommand条件参数json非空
callback回调地址Json [字符串]Url（必须包含http/https）可空
callwhere回调条件Json [字符串]
at_once是否立即启动代理int1：立即启动 0：否，默认为 0可空

1.4.13.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
Agent_id代理idint非空

响应示例：

  1. {
  2.     "code": 200,
  3.     "msg": "成功",
  4.     "result": [
  5.         {
  6.             "agent_id": 90
  7.         }
  8.     ]
  9. }

1.4.14. 代理编辑

1.4.14.1. 功能描述

属性值
urlagent/edit
http方法post
Content-Typex-www-form-urlencode

1.4.14.2. 请求参数

参数名称数据类型长度/字节描述是否必选
agent_id代理标识int非空
rule_type代理规则string非空
name代理名称String可空
schedule运行条件string非空
wherecommand条件参数json非空
callback回调地址Json [字符串]Url（必须包含http/https）可空
callwhere回调条件Json [字符串]
at_once是否立即启动代理int1：立即启动 0：否，默认为 0可空

1.4.14.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
Agent_id代理idint非空

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": "代理编辑成功！"
  5. }

1.4.15. 代理删除

1.4.15.1. 功能描述

属性值
urlagent/delete
http方法post
Content-Typex-www-form-urlencode

1.4.15.2. 请求参数

参数名称数据类型长度/字节描述是否必选
agent_id代理标识int非空
client来源、客户端string非空

1.4.15.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": "代理删除成功！"
  5. }

1.4.16. 代理启动

1.4.16.1. 功能描述

属性值
urlagent/start
http方法post
Content-Typex-www-form-urlencode

1.4.16.2. 请求参数

参数名称数据类型长度/字节描述是否必选
agent_id代理标识int非空
client来源、客户端string非空

1.4.16.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": "代理服务启动成功！"
  5. }

1.4.17. 代理停止

1.4.17.1. 功能描述

属性值
urlagent/stop
http方法post
Content-Typex-www-form-urlencode

1.4.17.2. 请求参数

参数名称数据类型长度/字节描述是否必选
agent_id代理标识int非空
client来源、客户端string非空

1.4.17.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": "代理服务停止成功！"
  5. }

1.4.18. 代理列表

1.4.18.1. 功能描述

属性值
urlagent/stop
http方法post
Content-Typex-www-form-urlencode

1.4.18.2. 请求参数

参数名称数据类型长度/字节描述是否必选
items每页显示的条数int非空
page当前页int非空
Start_time开始时间，记录创建的时间string
end_time结束时间string
rule代理规则string
name代理名称string
client来源、客户端string
status状态int0：未启动、1：正在进行2：执行失败3：执行成功，4：已停止 -1：所有

1.4.18.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": {
  5.         "data": [
  6.             {
  7.                 "callback": "http://192.168.1.125:8098/api/calldispose",
  8.                 "callwhere": [
  9.                     "* ",
  10.                     "admin_fault ",
  11.                     "1003 ",
  12.                     "",
  13.                     "1"
  14.                 ],
  15.                 "client": "admin",
  16.                 "created": "2018-09-26T11:38:17Z",
  17.                 "description": "小测一下 ",
  18.                 "id": 71,
  19.                 "name": "test",
  20.                 "retry": 3,
  21.                 "rule": "MO",
  22.                 "schedule": "00 11,12,77  * * ?",
  23.                 "status": 0,
  24.                 "where": [
  25.                     "* ",
  26.                     "admin_fault ",
  27.                     "1003 ",
  28.                     "",
  29.                     "1"
  30.                 ]
  31.             }
  32.         ],
  33.         "pagination": {
  34.             "page": "1",
  35.             "page_size": 1,
  36.             "total": 2
  37.         }
  38.     }
  39. }

1.4.19. 最新结果获取

1.4.19.1. 功能描述

属性值
urlagent/result/get
http方法post
Content-Typex-www-form-urlencode

1.4.19.2. 请求参数

参数名称数据类型长度/字节描述是否必选
agent_id代理唯一标识int非空
item条数string默认为1

1.4.19.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": {
  5.         "agent_id": 8,
  6.         "name": "",
  7.         "client": "Mixreport",
  8.         "rule_type": "MT2",
  9.         "callback": "http://192.168.1.175/api/age/calldispose?w_rule_id=2&agent_rule=MT2",
  10.         "status": 4,
  11.         "schedule": "*/5 * * * * *",
  12.         "retry": 3,
  13.         "result": "",
  14.         "description": "定制维保任务测试",
  15.         "where": [
  16.             "* ",
  17.             "admin_fault ",
  18.             " = 1003 ",
  19.             " = 2826 ",
  20.             "1"
  21.         ],
  22.         "callwhere": [],
  23.         "Created": "2018-09-11T15:52:42Z",
  24.         "at_once": 0,
  25.         "IsAvailable": "1",
  26.         "params": ""
  27.     }
  28. }

1.4.20. 结果列表

1.4.20.1. 功能描述

属性值
urlagent/result/show
http方法post
Content-Typex-www-form-urlencode

1.4.20.2. 请求参数

参数名称**数据类型长度/字节描述是否必选
items每页显示的条数int非空
page当前页int非空
status执行状态int0:执行失败，1：执行成功 -1：为所有状态非空
return_status回调状态int0:未回调1：已回调，2：成功 3：失败，4：接收失败' -1：为所有状态非空

1.4.20.3. 响应参数

参数名称数据类型长度/字节描述是否必选
code返回码Integer200：成功 500：失败非空
message提示信息String可空
result结果string

响应示例：

  1. {
  2.     "code": 200,
  3.     "message": "成功",
  4.     "result": {
  5.         "data": [
  6.             {
  7.                 "callResult": "",
  8.                 "created": "2018-09-11T15:52:45Z",
  9.                 "id": 112,
  10.                 "record_id": 8,
  11.                 "result": {
  12.                     "aprus_id ": "A22018061400001 ",
  13.                     "code ": "2826 ",
  14.                     "created ": "2018 - 07 - 14 T12: 51: 54 Z ",
  15.                     "description ": "Label_En: The Power Switch Is Closed;Label_Cn: 发电开关合闸 ",
  16.                     "equipment_id ": "100006 ",
  17.                     "fault_id ": "100122 ",
  18.                     "fault_name ": "发电开关合闸 ",
  19.                     "is_available ": "1 ",
  20.                     "reference ": "",
  21.                     "script ": "",
  22.                     "template ": ""
  23.                 },
  24.                 "returnStatus": 1,
  25.                 "status": 2
  26.             },
  27.             {
  28.                 "callResult": "",
  29.                 "created": "2018-09-11T15:52:50Z",
  30.                 "id": 113,
  31.                 "record_id": 8,
  32.                 "result": {
  33.                     "aprus_id ": "A22018061400001 ",
  34.                     "code ": "2826 ",
  35.                     "created ": "2018 - 07 - 14 T12: 51: 54 Z ",
  36.                     "description ": "Label_En: The Power Switch Is Closed;Label_Cn: 发电开关合闸 ",
  37.                     "equipment_id ": "100006 ",
  38.                     "fault_id ": "100122 ",
  39.                     "fault_name ": "发电开关合闸 ",
  40.                     "is_available ": "1 ",
  41.                     "reference ": "",
  42.                     "script ": "",
  43.                     "template ": ""
  44.                 },
  45.                 "returnStatus ": 1,
  46.                 "status": 2
  47.             }
  48.         ],
  49.         "pagination": {
  50.             "page": "1",
  51.             "page_size": 2,
  52.             "total": 29150
  53.         }
  54.     }
  55. }