emqx通过http API创建规则

素颜马尾好姑娘i 2022-09-17 03:02 291阅读 0赞

# emqx通过http API创建规则 #

--------------------

如需转载请标明出处：[http://blog.csdn.net/itas109 ][http_blog.csdn.net_itas109]  
QQ技术交流群：[129518033][]

### 文章目录 ###

*  emqx通过http API创建规则
 *   *  emqx HTTP API基础
     *   *  HTTP API
         *  接口安全
         *  响应码
         *   *  HTTP 状态码 (status codes)
             *  返回码 (result codes)
     *  获取Broker基本信息
     *   *  GET /api/v4/brokers/\{node\}
         *  代码
     *  设置规则引擎
     *   *  POST /api/v4/rules
         *  代码
     *  获取规则引擎信息
     *   *  GET /api/v4/rules/\{rule\_id\}
         *  代码

环境： emqx： v4.3.8

相关阅读：  
[emq获取所有发布内容][emq]

## emqx HTTP API基础 ##

### HTTP API ###

EMQ X 提供了 HTTP API 以实现与外部系统的集成，例如查询客户端信息、发布消息和创建规则等。

EMQ X 的 HTTP API 服务默认监听 8081 端口，可通过 `etc/plugins/emqx_management.conf` 配置文件修改监听端口，或启用 HTTPS 监听。[EMQ X 4.0.0][]以后的所有 API 调用均以 `api/v4` 开头。

### 接口安全 ###

EMQ X 的 HTTP API 使用`Basic 认证`方式，`id` 和 `password` 须分别填写 AppID 和 AppSecret。 默认的 AppID 和 AppSecret 是：`admin/public`。你可以在 Dashboard 的左侧菜单栏里，选择 “管理” -> “应用” 来修改和添加 AppID/AppSecret。

### 响应码 ###

#### HTTP 状态码 (status codes) ####

EMQ X 接口在调用成功时总是返回 200 OK，响应内容则以 JSON 格式返回。

可能的状态码如下：

<table> 
 <thead> 
  <tr> 
   <th>Status Code</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>200</td> 
   <td>成功，返回的 JSON 数据将提供更多信息</td> 
  </tr> 
  <tr> 
   <td>400</td> 
   <td>客户端请求无效，例如请求体或参数错误</td> 
  </tr> 
  <tr> 
   <td>401</td> 
   <td>客户端未通过服务端认证，使用无效的身份验证凭据可能会发生</td> 
  </tr> 
  <tr> 
   <td>404</td> 
   <td>找不到请求的路径或者请求的对象不存在</td> 
  </tr> 
  <tr> 
   <td>500</td> 
   <td>服务端处理请求时发生内部错误</td> 
  </tr> 
 </tbody> 
</table>

#### 返回码 (result codes) ####

EMQ X 接口的响应消息体为 JSON 格式，其中总是包含返回码 `code`。

可能的返回码如下：

<table> 
 <thead> 
  <tr> 
   <th>Return Code</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>0</td> 
   <td>成功</td> 
  </tr> 
  <tr> 
   <td>101</td> 
   <td>RPC 错误</td> 
  </tr> 
  <tr> 
   <td>102</td> 
   <td>未知错误</td> 
  </tr> 
  <tr> 
   <td>103</td> 
   <td>用户名或密码错误</td> 
  </tr> 
  <tr> 
   <td>104</td> 
   <td>空用户名或密码</td> 
  </tr> 
  <tr> 
   <td>105</td> 
   <td>用户不存在</td> 
  </tr> 
  <tr> 
   <td>106</td> 
   <td>管理员账户不可删除</td> 
  </tr> 
  <tr> 
   <td>107</td> 
   <td>关键请求参数缺失</td> 
  </tr> 
  <tr> 
   <td>108</td> 
   <td>请求参数错误</td> 
  </tr> 
  <tr> 
   <td>109</td> 
   <td>请求参数不是合法 JSON 格式</td> 
  </tr> 
  <tr> 
   <td>110</td> 
   <td>插件已开启</td> 
  </tr> 
  <tr> 
   <td>111</td> 
   <td>插件已关闭</td> 
  </tr> 
  <tr> 
   <td>112</td> 
   <td>客户端不在线</td> 
  </tr> 
  <tr> 
   <td>113</td> 
   <td>用户已存在</td> 
  </tr> 
  <tr> 
   <td>114</td> 
   <td>旧密码错误</td> 
  </tr> 
  <tr> 
   <td>115</td> 
   <td>不合法的主题</td> 
  </tr> 
 </tbody> 
</table>

## 获取Broker基本信息 ##

### GET /api/v4/brokers/\{node\} ###

返回集群下所有节点的基本信息。

**Path Parameters:**

<table> 
 <thead> 
  <tr> 
   <th>Name</th> 
   <th>Type</th> 
   <th>Required</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>node</td> 
   <td>String</td> 
   <td>False</td> 
   <td>节点名字，如 "emqx@127.0.0.1。 不指定时返回所有节点的信息</td> 
  </tr> 
 </tbody> 
</table>

### 代码 ###

{
        "data": [
            {
                "version": "4.3.8",
                "uptime": "19 hours, 34 minutes, 51 seconds",
                "sysdescr": "EMQ X",
                "otp_release": "23.0/11.0",
                "node_status": "Running",
                "node": "emqx@127.0.0.1",
                "datetime": "2021-10-19 10:29:03"
            }
        ],
        "code": 0
    }

## 设置规则引擎 ##

### POST /api/v4/rules ###

创建规则，返回规则 ID。

**Parameters (json):**

<table> 
 <thead> 
  <tr> 
   <th>Name</th> 
   <th>Type</th> 
   <th>Required</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>rawsql</td> 
   <td>String</td> 
   <td>True</td> 
   <td>规则的 SQL 语句</td> 
  </tr> 
  <tr> 
   <td>actions</td> 
   <td>Array</td> 
   <td>True</td> 
   <td>动作列表</td> 
  </tr> 
  <tr> 
   <td>- actions[0].name</td> 
   <td>String</td> 
   <td>True</td> 
   <td>动作名称</td> 
  </tr> 
  <tr> 
   <td>- actions[0].params</td> 
   <td>Object</td> 
   <td>True</td> 
   <td>动作参数。参数以 key-value 形式表示。 详情可参看添加规则的示例</td> 
  </tr> 
  <tr> 
   <td>description</td> 
   <td>String</td> 
   <td>False</td> 
   <td>可选，规则描述</td> 
  </tr> 
 </tbody> 
</table>

### 代码 ###

## 获取规则引擎信息 ##

### GET /api/v4/rules/\{rule\_id\} ###

获取某个规则的详情，包括规则的 SQL、Topics 列表、动作列表等。还会返回当前规则和动作的统计指标的值。

**Path Parameters:**

<table> 
 <thead> 
  <tr> 
   <th>Name</th> 
   <th>Type</th> 
   <th>Required</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>rule_id</td> 
   <td>String</td> 
   <td>False</td> 
   <td>可选，Rule ID。如不指定 rule_id 则 以数组形式返回所有已创建的规则</td> 
  </tr> 
 </tbody> 
</table>

### 代码 ###

--------------------

**License**

[*License under CC BY-NC-ND 4.0: 署名-非商业使用-禁止演绎*][License under CC BY-NC-ND 4.0_ _-_-]

--------------------

Reference:

1.  https://docs.emqx.cn/enterprise/v4.3/advanced/http-api.html

[http_blog.csdn.net_itas109]: http://blog.csdn.net/itas109
[129518033]: http://shang.qq.com/wpa/qunwpa?idkey=2888fa15c4513e6bfb9347052f36e437d919b2377161862948b2a49576679fc6
[emq]: https://blog.csdn.net/itas109/article/details/120660400
[EMQ X 4.0.0]: https://github.com/emqx/emqx/releases/tag/v4.0.0
[License under CC BY-NC-ND 4.0_ _-_-]: https://creativecommons.org/licenses/by-nc-nd/4.0/deed.zh