mirror of
https://gitee.com/iresty/apisix.git
synced 2024-12-15 17:31:45 +08:00
8bf8cc1916
Signed-off-by: spacewander <spacewanderlzx@gmail.com>
3.3 KiB
3.3 KiB
title |
---|
mqtt-proxy |
目录
名字
mqtt-proxy
只工作在流模式,它可以帮助你根据 MQTT 的 client_id
实现动态负载均衡。
属性
名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
---|---|---|---|---|---|
protocol_name | string | 必须 | 协议名称,正常情况下应为“ MQTT” | ||
protocol_level | integer | 必须 | 协议级别,MQTT 3.1.* 应为 4 ,MQTT 5.0 应是5 。 |
||
upstream.host | string | 必须 | 将当前请求转发到的上游的 IP 地址或域名 | ||
upstream.ip | string | 废弃 | 推荐使用“host”代替。将当前请求转发到的上游的 IP 地址 | ||
upstream.port | number | 必须 | 将当前请求转发到的上游的端口 |
如何启用
为了启用该插件,需要先在 conf/config.yaml
中首先开启 stream_proxy 配置,比如下面配置代表监听 9100 TCP 端口:
...
router:
http: 'radixtree_uri'
ssl: 'radixtree_sni'
stream_proxy: # TCP/UDP proxy
tcp: # TCP proxy port list
- 9100
dns_resolver:
...
然后把 MQTT 请求发送到 9100 端口即可。
下面是一个示例,在指定的 route 上开启了 mqtt-proxy 插件:
curl http://127.0.0.1:9080/apisix/admin/stream_routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"remote_addr": "127.0.0.1",
"plugins": {
"mqtt-proxy": {
"protocol_name": "MQTT",
"protocol_level": 4,
"upstream": {
"host": "127.0.0.1",
"port": 1980
}
}
}
}'
禁用插件
当你想去掉插件的时候,很简单,在插件的配置中把对应的 json 配置删除即可,无须重启服务,即刻生效:
$ curl http://127.0.0.1:2379/v2/keys/apisix/stream_routes/1 -X DELETE
现在就已经移除了 mqtt-proxy 插件了。