跳至主要內容

规则引擎

大约 8 分钟

规则引擎

新建规则引擎

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

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

请求参数

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

响应状态

状态码说明
200OK

响应参数

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

响应示例

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

更新规则引擎

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

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

请求参数

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

响应状态

状态码说明
200OK

响应参数

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

响应示例

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

获取规则引擎列表

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

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

请求参数

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

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data成功返回产品属性列表array
---id规则引擎idlong
---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)querytrueint32
pageSize每页条数，最大值为 100,示例值(10)querytrueint32
ruleName规则名称jsonfalsestring
ruleDescription规则描述jsonfalsestring
ruleContent规则内容，内容为JSON字符串格式jsonfalsestring
startup启动状态;1:启动,0:停止jsonfalseint
createTime创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）queryfalsearray[datatime]
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data成功产品属性分页数据object
---total返回结果条数int
---list返回数据列表array
------id规则引擎idlong
------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规则引擎idjsontruelong
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
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规则引擎idpathtruelong
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
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规则引擎idpathtruelong
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
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规则引擎idpathtruelong
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
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)querytrueint32
pageSize每页条数，最大值为 100,示例值(10)querytrueint32
ruleId规则引擎idqueryfalselong
exts拓展字段，模糊查询规则引擎内容queryfalsestring
createTime创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）queryfalsearray[datatime]
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data成功产品属性分页数据object
---total返回结果条数int
---list返回数据列表array
------id日志idlong
------ruleId规则引擎idlong
------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": ""
}
小李子科技