EMQ2.0 管理监控API (REST API)

最新推荐文章于 2022-03-09 17:06:40 发布
最新推荐文章于 2022-03-09 17:06:40 发布
阅读量913 收藏 1
点赞数
分类专栏： mqtt emq 文章标签： centos
原文链接：https://docs.emqx.io/broker/v2/cn/rest.html
版权
mqtt 同时被 2 个专栏收录
4 篇文章 0 订阅
订阅专栏
emq
4 篇文章 0 订阅
订阅专栏

用户可以通过 REST API 查询 MQTT 客户端连接(Clients)、会话(Sessions)、订阅(Subscriptions)和路由(Routes)信息，还可以检索和监控服务器的性能指标和统计数据。

URL 地址
REST API 访问 URL 地址:

http(s)😕/host:8080/api/v2/
Basic 认证
REST API 采用 HTTP Basic 认证(Authentication):

curl -v --basic -u : -k http://localhost:8080/api/v2/nodes/emq@127.0.0.1/clients
集群与节点
获取全部节点的基本信息
API 定义:

GET api/v2/management/nodes
请求示例:

GET api/v2/management/nodes
返回数据:

{
“code”: 0,
“result”: [
{
“name”: “emq@127.0.0.1”,
“version”: “2.3.10”,
“sysdescr”: “Erlang MQTT Broker”,
“uptime”: “3 minutes, 32 seconds”,
“datetime”: “2018-06-29 09:03:52”,
“otp_release”: “R20/9.3.3”,
“node_status”: “Running”
}
]
}
获取指定节点的基本信息
API 定义:

GET api/v2/management/nodes/{node_name}
请求示例:

GET api/v2/management/nodes/emq@127.0.0.1
返回数据:

{
“code”: 0,
“result”: {
“version”: “2.3.10”,
“sysdescr”: “Erlang MQTT Broker”,
“uptime”: “5 minutes, 12 seconds”,
“datetime”: “2018-06-29 09:05:32”,
“otp_release”: “R20/9.3.3”,
“node_status”: “Running”
}
}
获取全部节点的监控数据
API 定义:

GET api/v2/monitoring/nodes
请求示例:

GET api/v2/monitoring/nodes
返回数据:

{
“code”: 0,
“result”: [
{
“name”: “emq@127.0.0.1”,
“otp_release”: “R20/9.3.3”,
“memory_total”: “72.94M”,
“memory_used”: “50.55M”,
“process_available”: 262144,
“process_used”: 324,
“max_fds”: 7168,
“clients”: 0,
“node_status”: “Running”,
“load1”: “1.65”,
“load5”: “1.93”,
“load15”: “2.01”
}
]
}
获取指定节点的监控数据
API 定义:

GET api/v2/monitoring/nodes/{node_name}
请求示例:

GET api/v2/monitoring/nodes/emq@127.0.0.1
返回数据:

{
“code”: 0,
“result”: {
“name”: “emq@127.0.0.1”,
“otp_release”: “R20/9.3.3”,
“memory_total”: “73.69M”,
“memory_used”: “50.12M”,
“process_available”: 262144,
“process_used”: 324,
“max_fds”: 7168,
“clients”: 0,
“node_status”: “Running”,
“load1”: “1.88”,
“load5”: “1.99”,
“load15”: “2.02”
}
}
客户端连接(Clients)
获取指定节点的客户端连接列表
API 定义:

GET api/v2/nodes/{node_name}/clients
请求参数:

curr_page={page_no}&page_size={page_size}
请求示例:

api/v2/nodes/emq@127.0.0.1/clients?curr_page=1&page_size=20
返回数据:

{
“code”: 0,
“result”: {
“current_page”: 1,
“page_size”: 20,
“total_num”: 1,
“total_page”: 1,
“objects”: [
{
“client_id”: “mqttjs_722b4d845f”,
“username”: “undefined”,
“ipaddress”: “127.0.0.1”,
“port”: 58459,
“clean_sess”: true,
“proto_ver”: 4,
“keepalive”: 60,
“connected_at”: “2018-06-29 09:15:25”
}
]
}
}
获取节点指定客户端连接的信息
API 定义:

GET api/v2/nodes/{node_name}/clients/{clientid}
请求示例:

GET api/v2/nodes/emq@127.0.0.1/clients/mqttjs_722b4d845f
返回数据:

{
“code”: 0,
“result”: {
“objects”: [
{
“client_id”: “mqttjs_722b4d845f”,
“username”: “undefined”,
“ipaddress”: “127.0.0.1”,
“port”: 58459,
“clean_sess”: true,
“proto_ver”: 4,
“keepalive”: 60,
“connected_at”: “2018-06-29 09:15:25”
}
]
}
}
获取集群内指定客户端的信息
API 定义:

GET api/v2/clients/{clientid}
请求示例:

GET api/v2/clients/mqttjs_722b4d845f
返回数据:

{
“code”: 0,
“result”: {
“objects”: [
{
“client_id”: “mqttjs_722b4d845f”,
“username”: “undefined”,
“ipaddress”: “127.0.0.1”,
“port”: 58459,
“clean_sess”: true,
“proto_ver”: 4,
“keepalive”: 60,
“connected_at”: “2018-06-29 09:15:25”
}
]
}
}
断开集群内指定客户端连接
API定义:

DELETE api/v2/clients/{clientid}
请求示例:

DELETE api/v2/clients/mqttjs_722b4d845f
返回数据:

{
“code”: 0,
“result”: []
}
清除集群内指定客户端的ACL缓存
API定义:

PUT api/v2/clients/{clientid}/clean_acl_cache
请求参数:

{
“topic”: “test”
}
请求示例:

PUT api/v2/clients/mqttjs_722b4d845f/clean_acl_cache

请求的 json 参数:
{
“topic”: “test”
}
返回数据:

{
“code”: 0,
“result”: []
}
会话(Sessions)
获取指定节点的会话列表
API 定义:

GET api/v2/nodes/{node_name}/sessions
请求参数:

curr_page={page_no}&page_size={page_size}
请求示例:

GET api/v2/nodes/emq@127.0.0.1/sessions?curr_page=1&page_size=20
返回数据:

{
“code”: 0,
“result”: {
“current_page”: 1,
“page_size”: 20,
“total_num”: 1,
“total_page”: 1,
“objects”: [
{
“client_id”: “mqttjs_722b4d845f”,
“clean_sess”: true,
“subscriptions”: 0,
“max_inflight”: 32,
“inflight_len”: 0,
“mqueue_len”: 0,
“mqueue_dropped”: 0,
“awaiting_rel_len”: 0,
“deliver_msg”: 0,
“enqueue_msg”: 0,
“created_at”: “2018-06-29 10:05:13”
}
]
}
}
获取节点上指定客户端的会话信息
API 定义:

GET api/v2/nodes/{node_name}/sessions/{clientid}
请求示例:

GET api/v2/nodes/emq@127.0.0.1/sessions/mqttjs_722b4d845f
返回数据:

{
“code”: 0,
“result”: {
“objects”: [
{
“client_id”: “mqttjs_722b4d845f”,
“clean_sess”: true,
“subscriptions”: 0,
“max_inflight”: 32,
“inflight_len”: 0,
“mqueue_len”: 0,
“mqueue_dropped”: 0,
“awaiting_rel_len”: 0,
“deliver_msg”: 0,
“enqueue_msg”: 0,
“created_at”: “2018-06-29 10:05:13”
}
]
}
}
获取集群内指定客户端的会话信息
API 定义:

GET api/v2/sessions/{clientid}
请求示例:

GET api/v2/sessions/mqttjs_722b4d845f
返回数据:

订阅(Subscriptions)
获取某个节点上的订阅列表
API 定义:

GET api/v2/nodes/{node_name}/subscriptions
请求参数:

curr_page={page_no}&page_size={page_size}
请求示例:

GET api/v2/nodes/emq@127.0.0.1/subscriptions?curr_page=1&page_size=20
返回数据:

{
“code”: 0,
“result”: {
“current_page”: 1,
“page_size”: 20,
“total_num”: 1,
“total_page”: 1,
“objects”: [
{
“client_id”: “mqttjs_722b4d845f”,
“topic”: “/World”,
“qos”: 0
}
]
}
}
获取节点上指定客户端的订阅信息
API 定义:

GET api/v2/nodes/{node_name}/subscriptions/{clientid}
请求示例:

GET api/v2/nodes/emq@127.0.0.1/subscriptions/mqttjs_722b4d845f
返回数据:

{
“code”: 0,
“result”: {
“objects”: [
{
“client_id”: “mqttjs_722b4d845f”,
“topic”: “/World”,
“qos”: 0
}
]
}
}
获取集群内指定客户端的订阅信息
API 定义:

GET api/v2/subscriptions/{clientid}
请求示例:

GET api/v2/subscriptions/mqttjs_722b4d845f
返回数据:

{
“code”: 0,
“result”: {
“objects”: [
{
“client_id”: “mqttjs_722b4d845f”,
“topic”: “/World”,
“qos”: 0
}
]
}
}
路由(Routes)
获取集群路由表
API 定义:

GET api/v2/routes
请求参数:

curr_page={page_no}&page_size={page_size}
请求示例:

GET api/v2/routes?curr_page=1&page_size=20
返回数据:

{
“code”: 0,
“result”: {
“current_page”: 1,
“page_size”: 20,
“total_num”: 1,
“total_page”: 1,
“objects”: [
{
“topic”: “/World”,
“node”: “emq@127.0.0.1”
}
]
}
}
获取集群内指定主题的路由信息
API 定义:

GET api/v2/routes/{topic}
请求示例:

GET api/v2/routes//World
返回数据:

{
“code”: 0,
“result”: {
“objects”: [
{
“topic”: “/World”,
“node”: “emq@127.0.0.1”
}
]
}
}
发布/订阅
发布消息
API 定义:

POST api/v2/mqtt/publish
请求参数:

{
“topic” : “/World”,
“payload”: “hello”,
“qos”: 0,
“retain” : false,
“client_id”: “mqttjs_722b4d845f”
}
注解

topic 参数必填，其他参数可选。payload 默认值空字符串，qos 默认为 0，retain 默认为 false，client_id 默认为 ‘http’。
请求示例:

POST api/v2/mqtt/publish

请求参数 json:
{
“topic” : “/World”,
“payload”: “hello”,
“qos”: 0,
“retain” : false,
“client_id”: “mqttjs_722b4d845f”
}
返回数据:

{
“code”: 0,
“result”: []
}
创建订阅
API 定义:

POST api/v2/mqtt/subscribe
请求参数:

{
“topic” : “/World”,
“qos” : 0,
“client_id”: “mqttjs_722b4d845f”
}
请求示例:

POST api/v2/mqtt/subscribe
请求参数 json:
{
“topic” : “/World”,
“qos”: 0,
“client_id”: “mqttjs_722b4d845f”
}
返回数据:

{
“code”: 0,
“result”: []
}
取消订阅
API 定义:

POST api/v2/mqtt/unsubscribe
请求参数:

{
“topic” : “/World”,
“client_id”: “mqttjs_722b4d845f”
}
请求示例:

POST api/v2/mqtt/unsubscribe
请求参数 json:
{
“topic” : “/World”,
“client_id”: “mqttjs_722b4d845f”
}
返回数据:

{
“code”: 0,
“result”: []
}
插件(Plugins)
获取节点的插件列表
API 定义:

GET api/v2/nodes/{node_name}/plugins
请求示例:

GET api/v2/nodes/emq@127.0.0.1/plugins
返回数据:

{
“code”: 0,
“result”: [
{
“name”: “emq_auth_clientid”,
“version”: “2.3.10”,
“description”: “Authentication with ClientId/Password”,
“active”: false
},
{
“name”: “emq_auth_http”,
“version”: “2.3.10”,
“description”: “Authentication/ACL with HTTP API”,
“active”: false
},
{
“name”: “emq_auth_jwt”,
“version”: “2.3.10”,
“description”: “Authentication with JWT”,
“active”: false
},
{
“name”: “emq_auth_ldap”,
“version”: “2.3.10”,
“description”: “Authentication/ACL with LDAP”,
“active”: false
},
{
“name”: “emq_auth_mongo”,
“version”: “2.3.10”,
“description”: “Authentication/ACL with MongoDB”,
“active”: false
},
{
“name”: “emq_auth_mysql”,
“version”: “2.3.10”,
“description”: “Authentication/ACL with MySQL”,
“active”: false
},
{
“name”: “emq_auth_pgsql”,
“version”: “2.3.10”,
“description”: “Authentication/ACL with PostgreSQL”,
“active”: false
},
{
“name”: “emq_auth_redis”,
“version”: “2.3.10”,
“description”: “Authentication/ACL with Redis”,
“active”: false
},
{
“name”: “emq_auth_username”,
“version”: “2.3.10”,
“description”: “Authentication with Username/Password”,
“active”: false
},
{
“name”: “emq_coap”,
“version”: “2.3.10”,
“description”: “CoAP Gateway”,
“active”: false
},
{
“name”: “emq_dashboard”,
“version”: “2.3.10”,
“description”: “EMQ Web Dashboard”,
“active”: true
},
{
“name”: “emq_lua_hook”,
“version”: “2.3.10”,
“description”: “EMQ Hooks in lua”,
“active”: false
},
{
“name”: “emq_modules”,
“version”: “2.3.10”,
“description”: “EMQ Modules”,
“active”: true
},
{
“name”: “emq_plugin_template”,
“version”: “2.3.10”,
“description”: “EMQ Plugin Template”,
“active”: false
},
{
“name”: “emq_recon”,
“version”: “2.3.10”,
“description”: “Recon Plugin”,
“active”: true
},
{
“name”: “emq_reloader”,
“version”: “2.3.10”,
“description”: “Reloader Plugin”,
“active”: false
},
{
“name”: “emq_retainer”,
“version”: “2.3.10”,
“description”: “EMQ Retainer”,
“active”: true
},
{
“name”: “emq_sn”,
“version”: “2.3.10”,
“description”: “MQTT-SN Gateway”,
“active”: false
},
{
“name”: “emq_stomp”,
“version”: “2.3.10”,
“description”: “Stomp Protocol Plugin”,
“active”: false
},
{
“name”: “emq_web_hook”,
“version”: “2.3.10”,
“description”: “EMQ Webhook Plugin”,
“active”: false
}
]
}
开启/关闭节点的指定插件
API 定义:

PUT /api/v2/nodes/{node_name}/plugins/{name}
请求参数:

{“active”: true | false}
请求示例:

PUT api/v2/nodes/emq@127.0.0.1/plugins/emq_recon
json请求参数:
{
“active”: true
}
返回数据:

{
“code”: 0,
“result”: []
}
监听器(Listeners)
获取集群节点的监听器列表
API 定义:

GET api/v2/monitoring/listeners
返回数据:

{
“code”: 0,
“result”: {
“emq@127.0.0.1”: [
{
“protocol”: “dashboard:http”,
“listen”: “18083”,
“acceptors”: 2,
“max_clients”: 512,
“current_clients”: 0,
“shutdown_count”: []
},
{
“protocol”: “mqtt:tcp”,
“listen”: “127.0.0.1:11883”,
“acceptors”: 16,
“max_clients”: 102400,
“current_clients”: 0,
“shutdown_count”: []
},
{
“protocol”: “mqtt:tcp”,
“listen”: “0.0.0.0:1883”,
“acceptors”: 16,
“max_clients”: 102400,
“current_clients”: 0,
“shutdown_count”: []
},
{
“protocol”: “mqtt:ws”,
“listen”: “8083”,
“acceptors”: 4,
“max_clients”: 64,
“current_clients”: 0,
“shutdown_count”: []
},
{
“protocol”: “mqtt:ssl”,
“listen”: “8883”,
“acceptors”: 16,
“max_clients”: 1024,
“current_clients”: 0,
“shutdown_count”: []
},
{
“protocol”: “mqtt:wss”,
“listen”: “8084”,
“acceptors”: 4,
“max_clients”: 64,
“current_clients”: 0,
“shutdown_count”: []
},
{
“protocol”: “mqtt:api”,
“listen”: “127.0.0.1:8080”,
“acceptors”: 4,
“max_clients”: 64,
“current_clients”: 1,
“shutdown_count”: []
}
]
}
}
获取指定节点的监听器列表
API 定义:

GET api/v2/monitoring/listeners/{node_name}
请求示例:

GET api/v2/monitoring/listeners/emq@127.0.0.1
返回数据:

{
“code”: 0,
“result”: [
{
“protocol”: “mqtt:api”,
“listen”: “127.0.0.1:8080”,
“acceptors”: 4,
“max_clients”: 64,
“current_clients”: 1,
“shutdown_count”: []
},
{
“protocol”: “mqtt:wss”,
“listen”: “8084”,
“acceptors”: 4,
“max_clients”: 64,
“current_clients”: 0,
“shutdown_count”: []
},
{
“protocol”: “mqtt:ssl”,
“listen”: “8883”,
“acceptors”: 16,
“max_clients”: 1024,
“current_clients”: 0,
“shutdown_count”: []
},
{
“protocol”: “mqtt:ws”,
“listen”: “8083”,
“acceptors”: 4,
“max_clients”: 64,
“current_clients”: 0,
“shutdown_count”: []
},
{
“protocol”: “mqtt:tcp”,
“listen”: “0.0.0.0:1883”,
“acceptors”: 16,
“max_clients”: 102400,
“current_clients”: 0,
“shutdown_count”: []
},
{
“protocol”: “mqtt:tcp”,
“listen”: “127.0.0.1:11883”,
“acceptors”: 16,
“max_clients”: 102400,
“current_clients”: 0,
“shutdown_count”: []
},
{
“protocol”: “dashboard:http”,
“listen”: “18083”,
“acceptors”: 2,
“max_clients”: 512,
“current_clients”: 0,
“shutdown_count”: []
}
]
}
收发报文统计
获取全部节点的收发报文统计
API 定义:

GET api/v2/monitoring/metrics/
返回数据:

{
“code”: 0,
“result”: {
“packets/disconnect”:0,
“messages/dropped”:0,
“messages/qos2/received”:0,
“packets/suback”:0,
“packets/pubcomp/received”:0,
“packets/unsuback”:0,
“packets/pingresp”:0,
“packets/puback/missed”:0,
“packets/pingreq”:0,
“messages/retained”:3,
“packets/sent”:0,
“messages/qos2/dropped”:0,
“packets/unsubscribe”:0,
“packets/pubrec/missed”:0,
“packets/connack”:0,
“packets/pubrec/sent”:0,
“packets/publish/received”:0,
“packets/pubcomp/sent”:0,
“bytes/received”:0,
“packets/connect”:0,
“packets/puback/received”:0,
“messages/sent”:0,
“packets/publish/sent”:0,
“bytes/sent”:0,
“packets/pubrel/missed”:0,
“packets/puback/sent”:0,
“messages/qos0/received”:0,
“packets/subscribe”:0,
“packets/pubrel/sent”:0,
“messages/qos2/sent”:0,
“packets/received”:0,
“packets/pubrel/received”:0,
“messages/qos1/received”:0,
“messages/qos1/sent”:0,
“packets/pubrec/received”:0,
“packets/pubcomp/missed”:0,
“messages/qos0/sent”:0
}
}
获取指定节点的收发报文统计
API 定义:

GET api/v2/monitoring/metrics/{node_name}
请求示例:

GET api/v2/monitoring/metrics/emq@127.0.0.1
返回数据:

{
“code”: 0,
“result”: {
“packets/disconnect”:0,
“messages/dropped”:0,
“messages/qos2/received”:0,
“packets/suback”:0,
“packets/pubcomp/received”:0,
“packets/unsuback”:0,
“packets/pingresp”:0,
“packets/puback/missed”:0,
“packets/pingreq”:0,
“messages/retained”:3,
“packets/sent”:0,
“messages/qos2/dropped”:0,
“packets/unsubscribe”:0,
“packets/pubrec/missed”:0,
“packets/connack”:0,
“messages/received”:0,
“packets/pubrec/sent”:0,
“packets/publish/received”:0,
“packets/pubcomp/sent”:0,
“bytes/received”:0,
“packets/connect”:0,
“packets/puback/received”:0,
“messages/sent”:0,
“packets/publish/sent”:0,
“bytes/sent”:0,
“packets/pubrel/missed”:0,
“packets/puback/sent”:0,
“messages/qos0/received”:0,
“packets/subscribe”:0,
“packets/pubrel/sent”:0,
“messages/qos2/sent”:0,
“packets/received”:0,
“packets/pubrel/received”:0,
“messages/qos1/received”:0,
“messages/qos1/sent”:0,
“packets/pubrec/received”:0,
“packets/pubcomp/missed”:0,
“messages/qos0/sent”:0
}
}
连接会话统计
获取全部节点的连接会话统计
API 定义:

GET api/v2/monitoring/stats
请求示例:

GET api/v2/monitoring/stats
返回数据:

{
“code”: 0,
“result”: [
{
“emq@127.0.0.1”: {
“clients/count”: 0,
“clients/max”: 0,
“retained/count”: 3,
“retained/max”: 3,
“routes/count”: 0,
“routes/max”: 0,
“sessions/count”: 0,
“sessions/max”: 0,
“subscribers/count”: 0,
“subscribers/max”: 0,
“subscriptions/count”: 0,
“subscriptions/max”: 0,
“topics/count”: 0,
“topics/max”: 0
}
}
]
}
获取指定节点的连接会话统计
API 定义:

GET api/v2/monitoring/stats/{node_name}
请求示例:

GET api/v2/monitoring/stats/emq@127.0.0.1
返回数据:

{
“code”: 0,
“result”: {
“clients/count”: 0,
“clients/max”: 0,
“retained/count”: 3,
“retained/max”: 3,
“routes/count”: 0,
“routes/max”: 0,
“sessions/count”: 0,
“sessions/max”: 0,
“subscribers/count”: 0,
“subscribers/max”: 0,
“subscriptions/count”: 0,
“subscriptions/max”: 0,
“topics/count”: 0,
“topics/max”: 0
}
}
热配置
获取全部节点的可修改配置项
API定义:

GET api/v2/configs
请求示例:

GET api/v2/configs
返回数据:

{
“code”: 0,
“result”: {
“emq@127.0.0.1”: [
{
“key”: “log.console.level”,
“value”: “error”,
“datatpye”: “enum”,
“app”: “emqttd”
},
{
“key”: “mqtt.acl_file”,
“value”: “etc/acl.conf”,
“datatpye”: “string”,
“app”: “emqttd”
},
{
“key”: “mqtt.acl_nomatch”,
“value”: “allow”,
“datatpye”: “enum”,
“app”: “emqttd”
},
{
“key”: “mqtt.allow_anonymous”,
“value”: “true”,
“datatpye”: “enum”,
“app”: “emqttd”
},
{
“key”: “mqtt.broker.sys_interval”,
“value”: “60”,
“datatpye”: “integer”,
“app”: “emqttd”
},
{
“key”: “mqtt.cache_acl”,
“value”: “true”,
“datatpye”: “enum”,
“app”: “emqttd”
}
]
}
}
获取指定节点的可修改配置项
API定义:

GET api/v2/nodes/{node_name}/configs
请求示例:

GET api/v2/nodes/emq@127.0.0.1/configs
返回数据:

{
“code”: 0,
“result”: [
{
“key”: “log.console.level”,
“value”: “error”,
“datatpye”: “enum”,
“app”: “emqttd”
},
{
“key”: “mqtt.acl_file”,
“value”: “etc/acl.conf”,
“datatpye”: “string”,
“app”: “emqttd”
},
{
“key”: “mqtt.acl_nomatch”,
“value”: “allow”,
“datatpye”: “enum”,
“app”: “emqttd”
},
{
“key”: “mqtt.allow_anonymous”,
“value”: “true”,
“datatpye”: “enum”,
“app”: “emqttd”
},
{
“key”: “mqtt.broker.sys_interval”,
“value”: “60”,
“datatpye”: “integer”,
“app”: “emqttd”
},
{
“key”: “mqtt.cache_acl”,
“value”: “true”,
“datatpye”: “enum”,
“app”: “emqttd”
}
]
}
修改全部节点的配置项
API定义:

PUT /api/v2/configs/{app_name}
请求参数:

{
“key” : “mqtt.allow_anonymous”,
“value” : “false”
}
请求示例:

PUT /api/v2/configs/emqttd
返回数据:

{
“code”: 0,
“result”: []
}
修改指定节点的配置项
API定义:

PUT /api/v2/nodes/{node_name}/configs/{app_name}
请求参数:

{
“key” : “mqtt.allow_anonymous”,
“value” : “false”
}
请求示例:

PUT /api/v2/nodes/emq@127.0.0.1/configs/emqttd
返回数据:

{
“code”: 0,
“result”: []
}
获取指定节点的指定插件的配置项
API定义:

GET api/v2/nodes/{node_name}/plugin_configs/{plugin_name}
请求示例:

GET api/v2/nodes/emq@127.0.0.1/plugin_configs/emq_auth_http
返回数据:

{
“code”: 0,
“result”: [
{
“key”: “auth.http.auth_req”,
“value”: “http://127.0.0.1:8080/mqtt/auth”,
“desc”: “”,
“required”: true
},
{
“key”: “auth.http.auth_req.method”,
“value”: “post”,
“desc”: “”,
“required”: true
},
{
“key”: “auth.http.auth_req.params”,
“value”: “clientid=%c,username=%u,password=%P”,
“desc”: “”,
“required”: true
},
{
“key”: “auth.http.super_req”,
“value”: “http://127.0.0.1:8080/mqtt/superuser”,
“desc”: “”,
“required”: true
},
{
“key”: “auth.http.super_req.method”,
“value”: “post”,
“desc”: “”,
“required”: true
},
{
“key”: “auth.http.super_req.params”,
“value”: “clientid=%c,username=%u”,
“desc”: “”,
“required”: true
},
{
“key”: “auth.http.acl_req”,
“value”: “http://127.0.0.1:8080/mqtt/acl”,
“desc”: “”,
“required”: true
},
{
“key”: “auth.http.acl_req.method”,
“value”: “get”,
“desc”: “”,
“required”: true
},
{
“key”: “auth.http.acl_req.params”,
“value”: “access=%A,username=%u,clientid=%c,ipaddr=%a,topic=%t”,
“desc”: “”,
“required”: true
}
]
}
修改指定节点的指定插件的配置项
API定义:

PUT api/v2/nodes/{node_name}/plugin_configs/{plugin_name}
请求参数:

{
“auth.http.auth_req.method”: “get”,
“auth.http.auth_req”: “http://127.0.0.1:8080/mqtt/auth”,
“auth.http.auth_req.params”: “clientid=%c,username=%u,password=%P”,
“auth.http.acl_req.method”: “get”,
“auth.http.acl_req”: “http://127.0.0.1:8080/mqtt/acl”,
“auth.http.acl_req.params”: “access=%A,username=%u,clientid=%c,ipaddr=%a,topic=%t”,
“auth.http.super_req.method”: “post”,
“auth.http.super_req.params”: “clientid=%c,username=%u”,
“auth.http.super_req”: “http://127.0.0.1:8080/mqtt/superuser”
}
请求示例:

PUT api/v2/nodes/emq@127.0.0.1/plugin_configs/emq_auth_http
返回数据:

{
“code”: 0,
“result”: []
}
用户管理
获取管理用户列表
API定义:

GET api/v2/users
请求示例:

GET api/v2/users
返回数据:

{
“code”: 0,
“result”: [
{
“username”: “admin”,
“tags”: “administrator”
}
]
}
添加管理用户
API定义:

POST api/v2/users
请求参数:

{
“username”: “test_user”,
“password”: “password”,
“tags”: “user”
}
请求示例:

POST api/v2/users
返回数据:

{
“code”: 0,
“result”: []
}
修改管理用户信息
API定义:

PUT api/v2/users/{username}
请求参数:

{
“tags”: “admin”
}
请求示例:

PUT api/v2/users/test_user
返回数据:

{
“code”: 0,
“result”: []
}
删除管理用户
API定义:

DELETE api/v2/users/{username}
请求参数:

请求示例:

DELETE api/v2/users/test_user
返回数据:

{
“code”: 0,
“result”: []
}
认证管理用户
API定义:

POST api/v2/auth
请求参数:

{
“username”: “test_user”,
“password”: “password”
}
请求示例:

POST api/v2/auth
返回数据:

{
“code”: 0,
“result”: []
}
修改管理用户密码
API定义:

PUT api/v2/change_pwd/{username}
请求参数:

{
“new_pwd”: “newpassword”,
“old_pwd”: “password”
}
请求示例:

PUT api/v2/change_pwd/test_user
返回数据:

{
“code”: 0,
“result”: []
}
返回错误码
错误码 备注
0 成功
101 badrpc
102 未知错误
103 用户名密码错误
104 用户名密码不能为空
105 删除的用户不存在
106 admin用户不能删除
107 请求参数缺失
108 请求参数类型错误
109 请求参数不是json类型
110 插件已经加载，不能重复加载
111 插件已经卸载，不能重复卸载
112 用户不在线
113 用户已经存在
114 旧密码错误

龙无心001
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
EMQX服务器的API接口使用介绍_完成上位机开发
11-10 2341
这篇文章介绍如何利用EMQX提供的API接口，开发用户使用的上位机(我这里分别采用python 和 Qt 进行开发测试)，完成对应的功能开发。凭证获取，主题发布、消息获取、数据查询等等。
EMQ2.0性能测试报告Release2.0.5
01-09
EMQPLUS企业版是基于Erlang/OTP开发的MQTT消息服务器，具备百万级高并发、毫秒级低时延、分布式集群和高可靠性等特性，适用物联网、车联网、智能硬件和移动消息等场景。 目前已广泛应用在全球市场，包括中国、北美、...
EMQ--HTTP请求api使用笔记(python请求调试)、EMQ使用HTTP请求401问题（需要身份验证）
dengjiade的博客
01-07 7596
MQTT服务器EMQv2.0--HTTP接口api(python3 调试笔记) EMQ使用HTTP请求出现401--需要进行身份验证问题 管理监控API (REST API) EMQ服务器功能真是够强大的，还可以支持各种插件的扩展，而且本身还自带有HTTP管理监控API（REST API） 用户可以通过 REST API 查询 MQTT 客户端连接(Clients)、会话(Sessions...
Prometheus+Grafana监控EMQ
skh2015java的博客
10-15 1671
Prometheus和Grafana部署可以参考：https://blog.csdn.net/skh2015java/article/details/102572363，本文不再累述Prometheus的安装部署。 简述 emq3.0以上版本和emq3.0以下版本使用的监控方法不同。emq3.0以下版本broker，需要使用emq_exporter，而3.0以上版本的插件中已经支持P...
EMQ Java客户端 发送消息/接收消息 的使用
小哇
03-03 2157
1添加maven依赖 <dependency> <groupId>org.eclipse.paho</groupId> <artifactId>org.eclipse.paho.client.mqttv3</artifactId> <version>1.2.2</version> </dependency> 常见类功能说明 基类 介绍 MqttClient .
emqx通过http API创建规则
itas109的专栏
10-24 8679
emqx通过http API创建规则 如需转载请标明出处：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
EMQX安装部署方法及步骤
06-05
EMQX安装部署方法及步骤
docker dockerFile 一键部署 emqx
02-25
部署MQTT Server（EMQX） 包括emqx的dockerFile和配置文件，只需要按步骤执行两条命令就可迅速部署emqx。 步骤： 1.解压 ，配置emqx_auth_redis.conf中redis连接地址 2.进入解压目录，执行docker build . 得到镜像 3...
EMQX物联网MQTT消息服务器
02-01
个人备注：可作为mqtt消息服务器使用，只想模拟客户端的 不建议使用该工具，可用mqttfx模拟终端发送消息； 大规模分布式物联网 MQTT 消息服务器 高效可靠连接海量物联网设备，实时处理分发消息与事件流数据，助力...
emqx-windows-4.3.8.zip
06-24
emqx-windows-4.3.8.zip mqtt 客户端软件 windows版本 mqtt 客户端软件 windows版本 emqx-windows-4.3.8.zip emqx-windows-4.3.8.zip emqx-windows-4.3.8.zip emqx-windows-4.3.8.zip emqx-windows-4.3.8.zip emqx-...
EMQ X 生产环境鉴权配置详解(连接认证与访问控制)
热门推荐
中年闰土的博客
08-21 26万+
EMQ的应用场景、下载、运行，官方文档都说的很细，本篇主要总结一下生产环境下，暴露于外网下的EMQ的访问鉴权配置。 警告：建议版本是3.2.2,请不要使用3.1版本(bug:任何人可以直接通过DashBoard的18083端口调用rest api创建用户) EMQ X 消息服务器的鉴权主要有连接认证和访问控制俩部分组成，提供了的一系列相关的认证插件(Plugins)。 连接认证: EMQ...
emqtt 试用（五）emq 的用户密码认证
weixin_33734785的博客
02-01 2500
MQTT 认证设置 EMQ 消息服务器认证由一系列认证插件(Plugin)提供，系统支持按用户名密码、ClientID 或匿名认证。 系统默认开启匿名认证(anonymous)，通过加载认证插件可开启的多个认证模块组成认证链: ---------------- ---------------- ------------ Clie...
EMQ基础功能
yemuxiaweiliang的博客
03-09 1571
EMQ基础功能
【EMQ】Linux（CentOS７虚拟机）上搭建MQTT Broker-EMQ
xiaobanv1的专栏
03-18 1931
一、搭建背景： 因工作需要，需要在公司服务器上搭建一套EMQ服务，于是在Windows７上搭建了一个Linux虚拟机模拟公司服务器 相当于Window系统作为远程客户端连接服务端（Linux虚拟机） 二、搭建环境： Linux（CentOS７虚拟机） EMQ版本（如图：emqttd-centos7-v2.3.11.zip）， 根据Linux情况选择对应的版本。zip格式的程序包为Lin...
EMQ进行HttpApi登录问题
weixin_30719711的博客
12-20 1331
今天进行EMQ http api调用的时候遇到一个问题,一直弹出登录验证框 在官网资料中也找不到相关的接口,如下图: 以前也经常看到这种登录,不过我这里没有用程序去调用过这样类似的接口. 后来我想到经常在用迅雷下载一些电影的时候,在迅雷地址中看到过一种ftp的写法,如: ftp:账号:密码@xxx.com/xyz.mp4如此如此. 我就尝试了一下账号密码登录,居然成功了. ...
EMQ百万级MQTT消息服务(介绍和搭建)
文振熙 -- 云计算技术博客站
04-08 8181
先上节了解完MQTT之后我们需要选择一个MQTT服务端,在MQTT官方推荐下找了找最后选择了使用EMQ来进行服务端实现,EMQ有什么优势可以在官方推荐的那么多的服务器实现中脱颖而出,本章就来和大家一起慢慢了解EMQ相关的特性 附上: 喵了个咪的博客:w-blog.cn EMQ官方地址:http://emqtt.com/ EMQ中文文档:http://emqtt.com/docs/v2/...
ubuntu 查找历史命令
shaowei的博客
09-15 1万+
Linux命令行包含一个功能强大的历史特性，使用它可以方便的查看和重用之前使用后的命令。 若想查看最近使用的命令，只需在终端中输入 history 命令。该命令会把刚刚使用的命令把储存在用户的 home 目录下的 .bash_history 文件中的命令调出来，该文件存储用户最近使用过的命令，最多可保留1000个命令的历史记录。由于历史命令比较多，可以使用管道把 history 的内容分屏展示出...
我的mqtt协议和emqttd开源项目个人理解（11） - EMQ 一个客户链接的资源消耗
$firecat利白的代码足迹$
01-22 6150
本文参考了https://www.ttalk.im/topics/63?from=singlemessage Erlang进程消耗 EMQ对客户端链接使用链接进程(emqtt_client)和session进程(emqtt_session)分开的策略。 当一个mqtt的客户端连接到EMQ的服务器上的时候，首先会建立一个负责管理连接的进程(emqtt_client)，当验证客户端有效后会建立另一个...
java使用RestTemplate发送请求,调用EMQ X的api
hmmmmm2929的博客
03-19 1284
EMQ X是是基于 Erlang/OTP 平台开发的开源物联网 MQTT 消息服务器 默认情况下本地http监听端口为1883 控制台(可视化界面)端口号为18083，默认用户: admin，密码：public 找到官方文档,找到需要使用的接口 https://docs.emqx.cn/broker/latest/advanced/http-api.html 在发送请求的时候需要进行鉴权,采用的鉴权方式是Basic Auth postman在请求中发送鉴权的方式如下 代码如..
emqx 开源版本 api 能否读取订阅内容
最新发布
07-13
2. 管理 API：EMQX 提供了一组管理 API，可以用于管理和监控 MQTT 代理服务器。其中包括获取订阅消息的 API。你可以使用 `GET /api/v4/subscriptions` 接口来获取当前订阅的消息列表。此 API 将返回每个订阅主题的...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值