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

最新推荐文章于 2024-07-14 03:58:12 发布
最新推荐文章于 2024-07-14 03:58:12 发布
阅读量955 收藏 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
关注
专栏目录
EMQX服务器的API接口使用介绍_完成上位机开发
11-10 2773
这篇文章介绍如何利用EMQX提供的API接口，开发用户使用的上位机(我这里分别采用python 和 Qt 进行开发测试)，完成对应的功能开发。凭证获取，主题发布、消息获取、数据查询等等。
EMQX 入门教程④——快速开始 | MQTT连接订阅发布、Dashboard使用和API密钥
小康师兄
09-05 2357
EMQX 入门教程④——快速开始 | MQTT连接订阅发布和Dashboard使用和API密钥
EMQ--HTTP请求api使用笔记(python请求调试)、EMQ使用HTTP请求401问题（需要身份验证）
dengjiade的博客
01-07 7772
MQTT服务器EMQv2.0--HTTP接口api(python3 调试笔记) EMQ使用HTTP请求出现401--需要进行身份验证问题 管理监控API (REST API) EMQ服务器功能真是够强大的，还可以支持各种插件的扩展，而且本身还自带有HTTP管理监控API（REST API） 用户可以通过 REST API 查询 MQTT 客户端连接(Clients)、会话(Sessions...
Prometheus+EMQ监控
最新发布
weixin_30667487的博客
07-14 26
EMQ 3.0之后的版本EMQ X 提供 emqx_statsd (opens new window)插件，用于将系统的监控数据输出到第三方的监控系统中。emqx_statsd 支持将数据推送至 Pushgateway 中，然后再由 Promethues Server 拉取进行存储。进入Emq Web端，网页默认开启端口 ...
物联网协议 MQTT 常用服务端软件 EMQ X 的常用 API 功能介绍 及supervisor配置文件中配置项意义大全
本博客记录了从2014年以来在工作学习中遇到的技术问题、解决方法以及部分个人人生经历、经验等内容。
03-22 992
之前有文章提到过MQTT服务器emq,可以认为它是一个轻量级的消息队列，因此需要提供给服务端比如查询客户端信息、发布消息和创建规则等功能。对此EMQ X 提供了HTTP API以实现与外部系统的集成，HTTP API服务默认监听8081端口，可通过etc/plugins/emqx_management.conf 配置文件修改相关参数属性，或启用 HTTPS 监听。
Prometheus+Grafana监控EMQ
skh2015java的博客
10-15 1754
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 2446
1添加maven依赖 <dependency> <groupId>org.eclipse.paho</groupId> <artifactId>org.eclipse.paho.client.mqttv3</artifactId> <version>1.2.2</version> </dependency> 常见类功能说明 基类 介绍 MqttClient .
EMQ2.0性能测试报告Release2.0.5
01-09
EMQPLUS企业版是基于Erlang/OTP开发的MQTT消息服务器，具备百万级高并发、毫秒级低时延、分布式集群和高可靠性等特性，适用物联网、车联网、智能硬件和移动消息等场景。 目前已广泛应用在全球市场，包括中国、北美、...
EMQX中的管理用户认证数据的API
weixin_45137887的博客
06-18 986
前提:①禁用EMQX中配置文件的匿名认证配置项allow_anonymous = false ②启用用户认证的插件,例如emqx_auth_username插件 @hostname =192.168.1.102 @port =8081 @contentType=application/json @userName=admin @password=public #############查看用户认证数据列表################# GET http://192.168.1.102:8081/api
使用 EMQX 5.0 提供的 HTTP API 方式创建内置数据库认证数据
热衷于分享自己的思考、经验和见解，希望通过文字与大家共同探讨，一起成长。
12-12 811
其中 path 路径部分变量值不用变，借鉴的是 EMQX 5.0 提供的 Swagger API 里的信息，下面会说到。但在发送之前需要提供 Basic 认证信息，也就是上面的用户名和 API 密钥，需要在 EMQX 控制台上面申请，下面也会说到。打开之后，我们可以查看到 EMQX 对外提供的所有 API 接口，并且还可以在上面进行调试。，打开之后，选择系统设置 -> API 密钥，点击创建按钮来申请 API 密钥。创建之后，API 密钥会显示出来（注意：只会显示1次），复制它并保存好。
emqx通过http API创建规则
itas109的专栏
10-24 8890
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
【EMQ】Linux（CentOS７虚拟机）上搭建MQTT Broker-EMQ
xiaobanv1的专栏
03-18 1960
一、搭建背景： 因工作需要，需要在公司服务器上搭建一套EMQ服务，于是在Windows７上搭建了一个Linux虚拟机模拟公司服务器 相当于Window系统作为远程客户端连接服务端（Linux虚拟机） 二、搭建环境： Linux（CentOS７虚拟机） EMQ版本（如图：emqttd-centos7-v2.3.11.zip）， 根据Linux情况选择对应的版本。zip格式的程序包为Lin...
ActiveMQ入门到精通3-ActibeMQ API详解
底层码农老陈的博客
10-23 1712
三、ActiveMQ API讲解 我们写一个简单的Hello World实例，让大家感受下ActiveMQ，需要完成发送者和接受者两部分代码的编写。 （1）建立ConnectionFactory工厂对象，需要填入用户名、密码以及要连接的地址，均使用默认即可，默认端口为：tcp://10.0.31.144:61616 （2）通过ConnectionFactory工厂对象创建一个Connecti
ubuntu 查找历史命令
shaowei的博客
09-15 1万+
Linux命令行包含一个功能强大的历史特性，使用它可以方便的查看和重用之前使用后的命令。 若想查看最近使用的命令，只需在终端中输入 history 命令。该命令会把刚刚使用的命令把储存在用户的 home 目录下的 .bash_history 文件中的命令调出来，该文件存储用户最近使用过的命令，最多可保留1000个命令的历史记录。由于历史命令比较多，可以使用管道把 history 的内容分屏展示出...
解决ubuntu系统history不能保存历史命令的问题
Viadimir的博客
03-24 2633
最近在学习python，有时候需要用到历史命令(history)中的某些命令（因为有些命令很长，这样比较方便，还有就是看着命令数一点一点的成长，感觉很自豪），但是今天输入history命令后，发现只有2000出头个了历史命令，当时就觉得非常奇怪，这个数字是不对的，因为我昨天查看history时历史命令数已经达到2100多了，但是今天只有2000出头，查了一些资料，现在给出解决方法如下: 1.打开...
java使用RestTemplate发送请求,调用EMQ X的api
hmmmmm2929的博客
03-19 1399
EMQ X是是基于 Erlang/OTP 平台开发的开源物联网 MQTT 消息服务器 默认情况下本地http监听端口为1883 控制台(可视化界面)端口号为18083，默认用户: admin，密码：public 找到官方文档,找到需要使用的接口 https://docs.emqx.cn/broker/latest/advanced/http-api.html 在发送请求的时候需要进行鉴权,采用的鉴权方式是Basic Auth postman在请求中发送鉴权的方式如下 代码如..
推荐个restful小工具
hqmln的博客
07-27 241
https://github.com/ijson/in-rest-client
Rest API 的那些事儿
热门推荐
Wangguizer的博客
01-07 1万+
一、前言　　在软件行业快速发展的今天，传统的软件授权已经不能足以满足一个IT类的公司的发展。虽然在大部分公司里，它还是现金池的直接源头。但是在可遇见的未来，受摩尔根理论的失效、物联网的发展等影响，应用的架构会越来越趋于简单化，架构越来越倾向于分布式水平扩展，对外的服务提供也会越来越SaaS化。在这种大背景下，很多公司都开始提供所谓的开放平台。　　查阅各个大公司的开放平台，我们不难发现，都是Rest
Rest API是什么？
weixin_45502048的博客
01-16 1162
Rest是 representational state trasfer，代表一种standardized software architecture style RestAPI是一类用于client-server通信的API Restful Service是使用RestAPI进行通信的web service RestAPI优势: 1.Simple/Standard 通信方式的简易标准化（不需要手动格式化request和data） 2.scalable/stateless 可以进行se
EMQ 2.0 Docker镜像安装与Windows服务管理指南
此外，EMQ提供了Web管理控制台，用户可以通过Web界面进行实时监控和管理。 【扩展与测试】 EMQ支持多种扩展插件，以满足不同场景的需求。例如，它提供了一项100万线连接的测试，证明了其强大的并发处理能力。EMQ还...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值