规则引擎

2025/10/12大约 8 分钟

规则引擎

新建规则引擎

POST	/admin-api/iot/rule-engine/create

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
ruleName	规则名称	json	true	string
ruleDescription	规则描述	json	true	string
ruleContent	规则内容，内容为JSON字符串格式	json	false	string
startup	启动状态;1:启动,0:停止	json	false	int
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	创建成功返回产品属性Id	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": 1419193028976220,
  "msg": ""
}

更新规则引擎

PUT	/admin-api/iot/rule-engine/update

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	规则id	json	true	long
ruleName	规则名称	json	false	string
ruleDescription	规则描述	json	false	string
ruleContent	规则内容，内容为JSON字符串格式	json	false	string
startup	启动状态;1:启动,0:停止	json	false	int
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	更新成功返回true	boolean
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": true,
  "msg": ""
}

获取规则引擎列表

GET	/admin-api/iot/rule-engine/list

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
ruleName	规则名称	json	false	string
ruleDescription	规则描述	json	false	string
ruleContent	规则内容，内容为JSON字符串格式	json	false	string
startup	启动状态;1:启动,0:停止	json	false	int
createTime	创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）	query	false	array[datatime]
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	成功返回产品属性列表	array
---id	规则引擎id	long
---ruleName	规则引擎名称	string
---ruleContent	规则引擎内容	string
---ruleDescription	规则引擎描述	long
---startup	启动状态;1:启动,0:停止	string
---createTime	创建时间，时间戳	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": [
        {
          "ruleName": "53未3w",
          "ruleContent": "{\"condition\":{\"items\":[],\"uri\":\"logical/and\"},\"action\":[{\"params\":{\"notifyType\":3,\"userType\":1,\"to\":\"1366122724089856\"},\"uri\":\"action/message/notifyRobot\"}],\"trigger\":{\"items\":[],\"uri\":\"logical/or\"}}",
          "ruleDescription": "dwadwadwa",
          "startup": 1,
          "id": 1419620148445184,
          "createTime": 1732934752000
        }
    ],
  "msg": ""
}

获取规则引擎分页

GET	/admin-api/iot/rule-engine/page

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
pageNo	页码，从 1 开始,示例值(1)	query	true	int32
pageSize	每页条数，最大值为 100,示例值(10)	query	true	int32
ruleName	规则名称	json	false	string
ruleDescription	规则描述	json	false	string
ruleContent	规则内容，内容为JSON字符串格式	json	false	string
startup	启动状态;1:启动,0:停止	json	false	int
createTime	创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）	query	false	array[datatime]
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	成功产品属性分页数据	object
---total	返回结果条数	int
---list	返回数据列表	array
------id	规则引擎id	long
------ruleName	规则引擎名称	string
------ruleContent	规则引擎内容	string
------ruleDescription	规则引擎描述	long
------startup	启动状态;1:启动,0:停止	string
------createTime	创建时间，时间戳	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": {
    "list": [
      {
        "ruleName": "53未3w",
        "ruleContent": "{\"condition\":{\"items\":[],\"uri\":\"logical/and\"},\"action\":[{\"params\":{\"notifyType\":3,\"userType\":1,\"to\":\"1366122724089856\"},\"uri\":\"action/message/notifyRobot\"}],\"trigger\":{\"items\":[],\"uri\":\"logical/or\"}}",
        "ruleDescription": "dwadwadwa",
        "startup": 1,
        "id": 1419620148445184,
        "createTime": 1732934752000
      }
    ],
    "total": 1
  },
  "msg": ""
}

删除规则引擎

DELETE	/admin-api/iot/rule-engine/delete

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	规则引擎id	json	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	删除成功返回布尔状态	boolean
msg	状态消息	string

响应示例

{
	"status": 0,
	"code": 0,
	"data": true,
	"msg": ""
}

启动规则引擎

POST	/admin-api/iot/rule-engine/enable/

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	规则引擎id	path	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	成功返回状态	boolean
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": true,
  "msg": ""
}

停止规则引擎

POST	/admin-api/iot/rule-engine/disable/

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	规则引擎id	path	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	成功返回状态	boolean
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": true,
  "msg": ""
}

手动触发规则引擎

POST	/admin-api/iot/rule-engine/trigger/

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	规则引擎id	path	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	成功返回状态	boolean
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": true,
  "msg": ""
}

规则引擎日志

GET	/admin-api/iot/rule-engine-log/page

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
pageNo	页码，从 1 开始,示例值(1)	query	true	int32
pageSize	每页条数，最大值为 100,示例值(10)	query	true	int32
ruleId	规则引擎id	query	false	long
exts	拓展字段，模糊查询规则引擎内容	query	false	string
createTime	创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）	query	false	array[datatime]
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	成功产品属性分页数据	object
---total	返回结果条数	int
---list	返回数据列表	array
------id	日志id	long
------ruleId	规则引擎id	long
------exts	拓展字段	string
------actions	行为记录	string
------createTime	创建时间，时间戳	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": {
    "list": [
      {
        "ruleId": 1417652996128768,
        "actions": "[]",
        "exts": "场景联动触发，事件触发：{\"eventCode\":\"power_off_event\",\"productKey\":\"kza2ib\",\"deviceName\":\"cc50e34bf075\"}",
        "createTime": 1734705923000,
        "id": 1421071092490240
      },
      {
        "ruleId": 1417652996128768,
        "actions": "[]",
        "exts": "场景联动触发，事件触发：{\"eventCode\":\"power_off_event\",\"productKey\":\"kza2ib\",\"deviceName\":\"cc50e34bf075\"}",
        "createTime": 1734528594000,
        "id": 1420925824557056
      },
      {
        "ruleId": 1417652996128768,
        "actions": "[]",
        "exts": "场景联动触发，事件触发：{\"eventCode\":\"power_off_event\",\"productKey\":\"kza2ib\",\"deviceName\":\"cc50e34bf075\"}",
        "createTime": 1734272337000,
        "id": 1420715898486784
      },
      {
        "ruleId": 1417652996128768,
        "actions": "[]",
        "exts": "场景联动触发，事件触发：{\"eventCode\":\"power_off_event\",\"productKey\":\"kza2ib\",\"deviceName\":\"cc50e34bf075\"}",
        "createTime": 1734190711000,
        "id": 1420649030819840
      },
      {
        "ruleId": 1417652996128768,
        "actions": "[]",
        "exts": "场景联动触发，事件触发：{\"eventCode\":\"power_off_event\",\"productKey\":\"kza2ib\",\"deviceName\":\"cc50e34bf075\"}",
        "createTime": 1734105727000,
        "id": 1420579411886080
      },
      {
        "ruleId": 1417652996128768,
        "actions": "[]",
        "exts": "场景联动触发，事件触发：{\"eventCode\":\"power_off_event\",\"productKey\":\"kza2ib\",\"deviceName\":\"cc50e34bf075\"}",
        "createTime": 1734094831000,
        "id": 1420570485211136
      },
      {
        "ruleId": 1417652996128768,
        "actions": "[]",
        "exts": "场景联动触发，事件触发：{\"eventCode\":\"power_off_event\",\"productKey\":\"kza2ib\",\"deviceName\":\"cc50e34bf075\"}",
        "createTime": 1733754881000,
        "id": 1420291998875648
      },
      {
        "ruleId": 1417652996128768,
        "actions": "[]",
        "exts": "场景联动触发，事件触发：{\"eventCode\":\"power_off_event\",\"productKey\":\"kza2ib\",\"deviceName\":\"cc50e34bf075\"}",
        "createTime": 1733749813000,
        "id": 1420287846858753
      },
      {
        "ruleId": 1417652996128768,
        "actions": "[]",
        "exts": "场景联动触发，事件触发：{\"eventCode\":\"power_off_event\",\"productKey\":\"kza2ib\",\"deviceName\":\"cc50e34bf075\"}",
        "createTime": 1733749730000,
        "id": 1420287778856960
      },
      {
        "ruleId": 1417652996128768,
        "actions": "[]",
        "exts": "场景联动触发，事件触发：{\"eventCode\":\"power_off_event\",\"productKey\":\"kza2ib\",\"deviceName\":\"cc50e34bf075\"}",
        "createTime": 1733749689000,
        "id": 1420287745351680
      }
    ],
    "total": 38
  },
  "msg": ""
}