管理监控API¶
用户可以通过 REST API 查询 MQTT 客户端连接(Connections)、会话(Sessions)、订阅(Subscriptions)和路由(Routes)信息，还可以检索和监控服务器的性能指标和统计数据。
Basic 认证¶
使用 REST API 必须携带 HTTP Basic 格式的认证(Authentication)信息。因此，需要使用 Dashboard 中来创建的 AppID 和 AppSecret 进行认证:
# 例如：获取当前集群状态
curl -v --basic -u <appid>:<appsecret> -k http://localhost:8080/api/v3/brokers
API 信息¶
获取当前 REST API 列表¶
API 定义:
GET api/v3/
请求示例:
GET api/v3/
返回数据:
{
"code": 0,
"data": [
{
"name": "list_clientid",
"method": "GET",
"path": "/auth_clientid",
"descr": "List available clientid in the cluster"
},
{
"name": "lookup_clientid",
"method": "GET",
"path": "/auth_clientid/:clientid",
"descr": "Lookup clientid in the cluster"
},
{
"name": "add_clientid",
"method": "POST",
"path": "/auth_clientid",
"descr": "Add clientid in the cluster"
},
{
"name": "update_clientid",
"method": "PUT",
"path": "/auth_clientid/:clientid",
"descr": "Update clientid in the cluster"
},
{
"name": "delete_clientid",
"method": "DELETE",
"path": "/auth_clientid/:clientid",
"descr": "Delete clientid in the cluster"
},
{
"name": "list_username",
"method": "GET",
"path": "/auth_username",
"descr": "List available username in the cluster"
},
{
"name": "lookup_username",
"method": "GET",
"path": "/auth_username/:username",
"descr": "Lookup username in the cluster"
},
{
"name": "add_username",
"method": "POST",
"path": "/auth_username",
"descr": "Add username in the cluster"
},
{
"name": "update_username",
"method": "PUT",
"path": "/auth_username/:username",
"descr": "Update username in the cluster"
},
{
"name": "delete_username",
"method": "DELETE",
"path": "/auth_username/:username",
"descr": "Delete username in the cluster"
},
{
"name": "list_all_alarms",
"method": "GET",
"path": "/alarms/",
"descr": "List all alarms"
},
{
"name": "list_node_alarms",
"method": "GET",
"path": "/alarms/:node",
"descr": "List alarms of a node"
},
{
"name": "list_banned",
"method": "GET",
"path": "/banned/",
"descr": "List banned"
},
{
"name": "create_banned",
"method": "POST",
"path": "/banned/",
"descr": "Create banned"
},
{
"name": "delete_banned",
"method": "DELETE",
"path": "/banned/:who",
"descr": "Delete banned"
},
{
"name": "list_brokers",
"method": "GET",
"path": "/brokers/",
"descr": "A list of brokers in the cluster"
},
{
"name": "get_broker",
"method": "GET",
"path": "/brokers/:node",
"descr": "Get broker info of a node"
},
{
"name": "get_all_configs",
"method": "GET",
"path": "/configs/",
"descr": "Get all configs"
},
{
"name": "get_all_configs",
"method": "GET",
"path": "/nodes/:node/configs/",
"descr": "Get all configs of a node"
},
{
"name": "update_config",
"method": "PUT",
"path": "/configs/:app",
"descr": "Update config of an application in the cluster"
},
{
"name": "update_node_config",
"method": "PUT",
"path": "/nodes/:node/configs/:app",
"descr": "Update config of an application on a node"
},
{
"name": "get_plugin_configs",
"method": "GET",
"path": "/nodes/:node/plugin_configs/:plugin",
"descr": "Get configurations of a plugin on the node"
},
{
"name": "update_plugin_configs",
"method": "PUT",
"path": "/nodes/:node/plugin_configs/:plugin",
"descr": "Update configurations of a plugin on the node"
},
{
"name": "list_connections",
"method": "GET",
"path": "/connections/",
"descr": "A list of connections in the cluster"
},
{
"name": "list_node_connections",
"method": "GET",
"path": "nodes/:node/connections/",
"descr": "A list of connections on a node"
},
{
"name": "lookup_node_connections",
"method": "GET",
"path": "nodes/:node/connections/:clientid",
"descr": "Lookup a connection on node"
},
{
"name": "lookup_connections",
"method": "GET",
"path": "/connections/:clientid",
"descr": "Lookup a connection in the cluster"
},
{
"name": "lookup_node_connection_via_username",
"method": "GET",
"path": "/nodes/:node/connection/username/:username",
"descr": "Lookup a connection via username in the cluster "
},
{
"name": "lookup_connection_via_username",
"method": "GET",
"path": "/connection/username/:username",
"descr": "Lookup a connection via username on a node "
},
{
"name": "kickout_connection",
"method": "DELETE",
"path": "/connections/:clientid",
"descr": "Kick out a connection"
},
{
"name": "list_listeners",
"method": "GET",
"path": "/listeners/",
"descr": "A list of listeners in the cluster"
},
{
"name": "list_node_listeners",
"method": "GET",
"path": "/nodes/:node/listeners",
"descr": "A list of listeners on the node"
},
{
"name": "list_all_metrics",
"method": "GET",
"path": "/metrics/",
"descr": "A list of metrics of all nodes in the cluster"
},
{
"name": "list_node_metrics",
"method": "GET",
"path": "/nodes/:node/metrics/",
"descr": "A list of metrics of a node"
},
{
"name": "list_nodes",
"method": "GET",
"path": "/nodes/",
"descr": "A list of nodes in the cluster"
},
{
"name": "get_node",
"method": "GET",
"path": "/nodes/:node",
"descr": "Lookup a node in the cluster"
},
{
"name": "list_all_plugins",
"method": "GET",
"path": "/plugins/",
"descr": "List all plugins in the cluster"
},
{
"name": "list_node_plugins",
"method": "GET",
"path": "/nodes/:node/plugins/",
"descr": "List all plugins on a node"
},
{
"name": "load_plugin",
"method": "PUT",
"path": "/nodes/:node/plugins/:plugin/load",
"descr": "Load a plugin"
},
{
"name": "unload_plugin",
"method": "PUT",
"path": "/nodes/:node/plugins/:plugin/unload",
"descr": "Unload a plugin"
},
{
"name": "mqtt_subscribe",
"method": "POST",
"path": "/mqtt/subscribe",
"descr": "Subscribe a topic"
},
{
"name": "mqtt_publish",
"method": "POST",
"path": "/mqtt/publish",
"descr": "Publish a MQTT message"
},
{
"name": "mqtt_unsubscribe",
"method": "POST",
"path": "/mqtt/unsubscribe",
"descr": "Unsubscribe a topic"
},
{
"name": "list_routes",
"method": "GET",
"path": "/routes/",
"descr": "List routes"
},
{
"name": "lookup_routes",
"method": "GET",
"path": "/routes/:topic",
"descr": "Lookup routes to a topic"
},
{
"name": "list_sessions",
"method": "GET",
"path": "/sessions/",
"descr": "A list of sessions in the cluster"
},
{
"name": "list_node_sessions",
"method": "GET",
"path": "nodes/:node/sessions/",
"descr": "A list of sessions on a node"
},
{
"name": "lookup_session",
"method": "GET",
"path": "/sessions/:clientid",
"descr": "Lookup a session in the cluster"
},
{
"name": "lookup_node_session",
"method": "GET",
"path": "nodes/:node/sessions/:clientid",
"descr": "Lookup a session on the node"
},
{
"name": "list_stats",
"method": "GET",
"path": "/stats/",
"descr": "A list of stats of all nodes in the cluster"
},
{
"name": "lookup_node_stats",
"method": "GET",
"path": "/nodes/:node/stats/",
"descr": "A list of stats of a node"
},
{
"name": "list_subscriptions",
"method": "GET",
"path": "/subscriptions/",
"descr": "A list of subscriptions in the cluster"
},
{
"name": "list_node_subscriptions",
"method": "GET",
"path": "/nodes/:node/subscriptions/",
"descr": "A list of subscriptions on a node"
},
{
"name": "lookup_client_subscriptions",
"method": "GET",
"path": "/subscriptions/:clientid",
"descr": "A list of subscriptions of a client"
},
{
"name": "lookup_client_subscriptions_with_node",
"method": "GET",
"path": "/nodes/:node/subscriptions/:clientid",
"descr": "A list of subscriptions of a client on the node"
},
{
"name": "create_rule",
"method": "POST",
"path": "/rules/",
"descr": "Create a rule"
},
{
"name": "list_rules",
"method": "GET",
"path": "/rules/",
"descr": "A list of all rules"
},
{
"name": "show_rule",
"method": "GET",
"path": "/rules/:id",
"descr": "Show a rule"
},
{
"name": "delete_rule",
"method": "DELETE",
"path": "/rules/:id",
"descr": "Delete a rule"
},
{
"name": "list_actions",
"method": "GET",
"path": "/actions/",
"descr": "A list of all actions"
},
{
"name": "show_action",
"method": "GET",
"path": "/actions/:name",
"descr": "Show an action"
},
{
"name": "list_resources",
"method": "GET",
"path": "/resources/",
"descr": "A list of all resources"
},
{
"name": "create_resource",
"method": "POST",
"path": "/resources/",
"descr": "Create a resource"
},
{
"name": "show_resource",
"method": "GET",
"path": "/resources/:id",
"descr": "Show a resource"
},
{
"name": "delete_resource",
"method": "DELETE",
"path": "/resources/:id",
"descr": "Delete a resource"
},
{
"name": "list_resource_types",
"method": "GET",
"path": "/resource_types/",
"descr": "List all resource types"
},
{
"name": "show_resource_type",
"method": "GET",
"path": "/resource_types/:name",
"descr": "Show a resource type"
},
{
"name": "list_resources_by_type",
"method": "GET",
"path": "/resource_types/:type/resources",
"descr": "List all resources of a resource type"
},
{
"name": "list_actions_by_type",
"method": "GET",
"path": "/resource_types/:type/actions",
"descr": "List all actions of a resource type"
}]
}
集群与节点¶
获取集群基本信息¶
API 定义:
GET api/v3/brokers/
请求示例:
GET api/v3/brokers/
返回数据:
{
"code": 0,
"data": [
{
"datetime": "2019-04-29 10:56:41",
"node": "emqx@127.0.0.1",
"node_status": "Running",
"otp_release": "R21/10.3.2",
"sysdescr": "EMQ X Broker",
"uptime": "3 minutes, 59 seconds",
"version": "v3.1.0"
}
]
}
获取节点基本信息¶
API 定义:
GET api/v3/brokers/${node}
请求示例:
GET api/v3/brokers/emqx@127.0.0.1
返回数据:
{
"code": 0,
"data": {
"datetime": "2019-04-29 10:59:59",
"node_status": "Running",
"otp_release": "R21/10.3.2",
"sysdescr": "EMQ X Broker",
"uptime": "7 minutes, 16 seconds",
"version": "v3.1.0"
}
}
获取集群监控数据¶
API 定义:
GET api/v3/nodes/
请求示例:
GET api/v3/nodes/
返回数据:
{
"code": 0,
"data": [
{
"connections": 2,
"load1": "2.75",
"load15": "2.87",
"load5": "2.57",
"max_fds": 7168,
"memory_total": "76.45M",
"memory_used": "59.48M",
"name": "emqx@127.0.0.1",
"node": "emqx@127.0.0.1",
"node_status": "Running",
"otp_release": "R21/10.3.2",
"process_available": 262144,
"process_used": 331,
"uptime": "1 days,18 hours, 45 minutes, 1 seconds",
"version": "v3.1.0"
}
]
}
获取节点监控数据¶
API 定义:
GET api/v3/nodes/${node}
请求示例:
GET api/v3/nodes/emqx@127.0.0.1
返回数据:
{
"code": 0,
"data": {
"connections": 1,
"load1": "2.75",
"load15": "2.87",
"load5": "2.57",
"max_fds": 7168,
"memory_total": 80162816,
"memory_used": 62254160,
"name": "emqx@127.0.0.1",
"node_status": "Running",
"otp_release": "R21/10.3.2",
"process_available": 262144,
"process_used": 331,
"uptime": "1 days,18 hours, 45 minutes, 1 seconds",
"version": "v3.1.0"
}
}
连接信息(Connections)¶
获取集群连接信息¶
API 定义:
GET api/v3/connections/
请求示例:
GET api/v3/connections/?_page=1&_limit=10000
返回数据:
{
"code": 0,
"data": [
{
"clean_start": true,
"client_id": "mosquitto_mqtt",
"conn_mod": "emqx_connection",
"connected_at": "2019-04-29 11:05:01",
"heap_size": 2586,
"ipaddress": "127.0.0.1",
"is_bridge": false,
"keepalive": 60,
"mailbox_len": 0,
"node": "emqx@127.0.0.1",
"peercert": "nossl",
"port": 64899,
"proto_name": "MQIsdp",
"proto_ver": 3,
"recv_cnt": 2,
"recv_msg": 0,
"recv_oct": 47,
"recv_pkt": 2,
"reductions": 3588,
"send_cnt": 2,
"send_msg": 0,
"send_oct": 9,
"send_pend": 0,
"send_pkt": 2,
"username": "undefined",
"zone": "external"
}
],
"meta": {
"page": 1,
"limit": 10000,
"count": 1
}
}
获取节点连接信息¶
API 定义:
GET api/v3/nodes/${node}/connections/
请求示例:
GET api/v3/nodes/emqx@127.0.0.1/connections/?_page=1&_limit=10000
返回数据:
{
"code": 0,
"data": [
{
"clean_start": true,
"client_id": "mosquitto_mqtt",
"conn_mod": "emqx_connection",
"connected_at": "2019-04-29 11:05:01",
"heap_size": 610,
"ipaddress": "127.0.0.1",
"is_bridge": false,
"keepalive": 60,
"mailbox_len": 0,
"node": "emqx@127.0.0.1",
"peercert": "nossl",
"port": 64899,
"proto_name": "MQIsdp",
"proto_ver": 3,
"recv_cnt": 5,
"recv_msg": 0,
"recv_oct": 53,
"recv_pkt": 5,
"reductions": 6081,
"send_cnt": 5,
"send_msg": 0,
"send_oct": 15,
"send_pend": 0,
"send_pkt": 5,
"username": "undefined",
"zone": "external"
}
],
"meta": {
"page": 1,
"limit": 10000,
"count": 1
}
}
获取集群指定连接信息¶
API 定义:
GET api/v3/connections/${clientid}
请求示例:
GET api/v3/connections/mosquitto_mqtt
返回数据:
{
"code": 0,
"data": [
{
"clean_start": true,
"client_id": "mosquitto_mqtt",
"conn_mod": "emqx_connection",
"connected_at": "2019-04-29 11:05:01",
"heap_size": 610,
"ipaddress": "127.0.0.1",
"is_bridge": false,
"keepalive": 60,
"mailbox_len": 0,
"node": "emqx@127.0.0.1",
"peercert": "nossl",
"port": 64899,
"proto_name": "MQIsdp",
"proto_ver": 3,
"recv_cnt": 8,
"recv_msg": 0,
"recv_oct": 59,
"recv_pkt": 8,
"reductions": 8560,
"send_cnt": 8,
"send_msg": 0,
"send_oct": 21,
"send_pend": 0,
"send_pkt": 8,
"username": "undefined",
"zone": "external"
}
]
}
获取节点指定连接信息¶
API 定义:
GET api/v3/nodes/${node}/connections/${clientid}
请求示例:
GET api/v3/nodes/emqx@127.0.0.1/connections/mosquitto_mqtt
返回数据:
{
"code": 0,
"data": [
{
"clean_start": true,
"client_id": "mosquitto_mqtt",
"conn_mod": "emqx_connection",
"connected_at": "2019-04-29 11:05:01",
"heap_size": 610,
"ipaddress": "127.0.0.1",
"is_bridge": false,
"keepalive": 60,
"mailbox_len": 0,
"node": "emqx@127.0.0.1",
"peercert": "nossl",
"port": 64899,
"proto_name": "MQIsdp",
"proto_ver": 3,
"recv_cnt": 14,
"recv_msg": 0,
"recv_oct": 71,
"recv_pkt": 14,
"reductions": 13534,
"send_cnt": 14,
"send_msg": 0,
"send_oct": 33,
"send_pend": 0,
"send_pkt": 14,
"username": "undefined",
"zone": "external"
}
]
}
断开指定连接¶
API 定义:
DELETE api/v3/connections/${clientid}
请求示例:
DELETE api/v3/connections/mosquitto_mqtt
返回数据:
{
"code": 0
}
会话(Sessions)¶
获取集群会话信息¶
API 定义:
GET api/v3/sessions/
请求示例:
GET api/v3/sessions/?_page=1&_limit=10000
返回数据:
{
"code": 0,
"data": [
{
"awaiting_rel_len": 0,
"binding": "local",
"clean_start": true,
"client_id": "mqttjs_f79fbc5a4b",
"created_at": "2019-04-29 11:28:04",
"deliver_msg": 0,
"enqueue_msg": 0,
"expiry_interval": 0,
"heap_size": 233,
"inflight_len": 0,
"mailbox_len": 0,
"max_awaiting_rel": 100,
"max_inflight": 32,
"max_mqueue": 1000,
"max_subscriptions": 0,
"mqueue_dropped": 0,
"mqueue_len": 0,
"node": "emqx@127.0.0.1",
"reductions": 211,
"subscriptions_count": 0,
"username": ""
},
{
"awaiting_rel_len": 0,
"binding": "local",
"clean_start": true,
"client_id": "mosquitto_mqtt",
"created_at": "2019-04-29 11:28:28",
"deliver_msg": 0,
"enqueue_msg": 0,
"expiry_interval": 0,
"heap_size": 376,
"inflight_len": 0,
"mailbox_len": 0,
"max_awaiting_rel": 100,
"max_inflight": 32,
"max_mqueue": 1000,
"max_subscriptions": 0,
"mqueue_dropped": 0,
"mqueue_len": 0,
"node": "emqx@127.0.0.1",
"reductions": 202,
"subscriptions_count": 0,
"username": "undefined"
}
],
"meta": {
"page": 1,
"limit": 10000,
"count": 2
}
}
获取集群指定会话信息¶
API 定义:
GET api/v3/sessions/${clientid}
请求示例:
GET api/v3/sessions/mosquitto_mqtt
返回数据:
{
"code": 0,
"data": [
{
"awaiting_rel_len": 0,
"binding": "local",
"clean_start": true,
"client_id": "mosquitto_mqtt",
"created_at": "2019-04-29 11:28:28",
"deliver_msg": 0,
"enqueue_msg": 0,
"expiry_interval": 0,
"heap_size": 376,
"inflight_len": 0,
"mailbox_len": 0,
"max_awaiting_rel": 100,
"max_inflight": 32,
"max_mqueue": 1000,
"max_subscriptions": 0,
"mqueue_dropped": 0,
"mqueue_len": 0,
"node": "emqx@127.0.0.1",
"reductions": 453,
"subscriptions_count": 1,
"username": "undefined"
}
]
}
获取节点会话信息¶
API 定义:
GET api/v3/nodes/${node}/sessions/
请求示例:
GET api/v3/nodes/emqx@127.0.0.1/sessions/?_page=1&_limit=10000
返回数据:
{
"code": 0,
"data": [
{
"awaiting_rel_len": 0,
"binding": "local",
"clean_start": true,
"client_id": "mqttjs_f79fbc5a4b",
"created_at": "2019-04-29 11:28:04",
"deliver_msg": 0,
"enqueue_msg": 0,
"expiry_interval": 0,
"heap_size": 233,
"inflight_len": 0,
"mailbox_len": 0,
"max_awaiting_rel": 100,
"max_inflight": 32,
"max_mqueue": 1000,
"max_subscriptions": 0,
"mqueue_dropped": 0,
"mqueue_len": 0,
"node": "emqx@127.0.0.1",
"reductions": 211,
"subscriptions_count": 0,
"username": ""
},
{
"awaiting_rel_len": 0,
"binding": "local",
"clean_start": true,
"client_id": "mosquitto_mqtt",
"created_at": "2019-04-29 11:28:28",
"deliver_msg": 0,
"enqueue_msg": 0,
"expiry_interval": 0,
"heap_size": 376,
"inflight_len": 0,
"mailbox_len": 0,
"max_awaiting_rel": 100,
"max_inflight": 32,
"max_mqueue": 1000,
"max_subscriptions": 0,
"mqueue_dropped": 0,
"mqueue_len": 0,
"node": "emqx@127.0.0.1",
"reductions": 453,
"subscriptions_count": 1,
"username": "undefined"
}
],
"meta": {
"page": 1,
"limit": 10000,
"count": 2
}
}
获取节点指定会话信息¶
API 定义:
GET api/v3/nodes/${node}/sessions/${clientid}
请求示例:
GET api/v3/nodes/emqx@127.0.0.1/sessions/mosquitto_mqtt
请求参数:
{
"topic": "test_topic",
"payload": "hello",
"qos": 1,
"retain": false,
"client_id": "mqttjs_ab9069449e"
}
返回数据:
{
"code": 0,
"data": [
{
"awaiting_rel_len": 0,
"binding": "local",
"clean_start": true,
"client_id": "mosquitto_mqtt",
"created_at": "2018-09-12 10:42:57",
"deliver_msg": 0,
"enqueue_msg": 0,
"expiry_interval": 7200,
"heap_size": 376,
"inflight_len": 0,
"mailbox_len": 0,
"max_awaiting_rel": 100,
"max_inflight": 32,
"max_mqueue": 1000,
"max_subscriptions": 0,
"mqueue_dropped": 0,
"mqueue_len": 0,
"node": "emqx@127.0.0.1",
"reductions": 203,
"subscriptions_count": 0,
"username": "mosquitto_mqtt"
}
]
}
订阅(Subscriptions)¶
获取集群订阅信息¶
API 定义:
GET api/v3/subscriptions/
请求示例:
GET api/v3/subscriptions/?_page=1&_limit=10000
返回数据:
{
"code": 0,
"data": [
{
"client_id": "mqttjs_f79fbc5a4b",
"node": "emqx@127.0.0.1",
"qos": 0,
"topic": "testtopic/#"
},
{
"client_id": "mosquitto_mqtt",
"node": "emqx@127.0.0.1",
"qos": 0,
"topic": "t"
}
],
"meta": {
"page": 1,
"limit": 10000,
"count": 2
}
}
获取集群指定连接订阅信息¶
API 定义:
GET api/v3/subscriptions/${clientid}
请求示例:
GET api/v3/subscriptions/mosquitto_mqtt
返回数据:
{
"code": 0,
"data": [
{
"client_id": "mosquitto_mqtt",
"node": "emqx@127.0.0.1",
"qos": 0,
"topic": "t"
}
]
}
获取节点订阅信息¶
API 定义:
GET api/v3/nodes/${node}/subscriptions/
请求示例:
GET api/v3/nodes/emqx@127.0.0.1/subscriptions/?_page=1&_limit=10000
返回数据:
{
"code": 0,
"data": [
{
"client_id": "mqttjs_f79fbc5a4b",
"node": "emqx@127.0.0.1",
"qos": 0,
"topic": "testtopic/#"
},
{
"client_id": "mosquitto_mqtt",
"node": "emqx@127.0.0.1",
"qos": 0,
"topic": "t"
}
],
"meta": {
"page": 1,
"limit": 10000,
"count": 2
}
}
获取节点指定连接订阅信息¶
API 定义:
GET api/v3/nodes/${node}/subscriptions/${clientid}
请求示例:
GET api/v3/nodes/emqx@127.0.0.1/subscriptions/mosquitto_mqtt
返回数据:
{
"code": 0,
"data": [
{
"client_id": "mosquitto_mqtt",
"node": "emqx@127.0.0.1",
"qos": 0,
"topic": "t"
}
]
}
路由(Routes)¶
获取集群路由表¶
API 定义:
GET api/v3/routes/
请求示例:
GET api/v3/routes/
返回数据:
{
"code": 0,
"data": [
{
"node": "emqx@127.0.0.1",
"topic": "testtopic/#"
},
{
"node": "emqx@127.0.0.1",
"topic": "t"
}
],
"meta": {
"page": 1,
"limit": 10000,
"count": 2
}
}
获取集群指定主题的路由信息¶
API 定义:
GET api/v3/routes/${topic}
请求示例:
GET api/v3/routes/t
返回数据:
{
"code": 0,
"data": [
{
"node": "emqx@127.0.0.1",
"topic": "t"
}
]
}
发布/订阅/取消订阅¶
发布消息¶
API 定义:
POST api/v3/mqtt/publish
请求参数:
{
"topic": "test_topic",
"payload": "hello",
"qos": 1,
"retain": false,
"client_id": "mqttjs_ab9069449e"
}
请求示例:
POST api/v3/mqtt/publish
返回数据:
{
"code": 0
}
创建订阅¶
API 定义:
POST api/v3/mqtt/subscribe
请求参数:
{
"topic": "test_topic",
"qos": 1,
"client_id": "mqttjs_ab9069449e"
}
请求示例:
POST api/v3/mqtt/subscribe
返回数据:
{
"code": 0
}
取消订阅¶
API 定义:
POST api/v3/mqtt/unsubscribe
请求参数:
{
"topic": "test_topic",
"client_id": "mqttjs_ab9069449e"
}
请求示例:
POST api/v3/mqtt/unsubscribe
返回数据:
{
"code": 0
}
批量发布消息¶
API 定义:
POST api/v3/mqtt/publish_batch
请求参数:
[{
"topic": "test_topic1",
"payload": "hello1",
"qos": 1,
"retain": false,
"client_id": "mqttjs_1"
},{
"topic": "test_topic2",
"payload": "hello2",
"qos": 1,
"retain": false,
"client_id": "mqttjs_2"
}]
请求示例:
POST api/v3/mqtt/publish_batch
返回数据:
{
"code": 0,
"data": [
{
"topic": "test_topic1",
"code": 0
},
{
"topic": "test_topic2",
"code": 0
}
]
}
批量创建订阅¶
API 定义:
POST api/v3/mqtt/subscribe_batch
请求参数:
[{
"topic": "test_topic1",
"qos": 1,
"client_id": "mqttjs_1"
},{
"topic": "test_topic2",
"qos": 1,
"client_id": "mqttjs_2"
}]
请求示例:
POST api/v3/mqtt/subscribe_batch
返回数据:
{
"code": 0,
"data": [
{
"client_id": "mqttjs_1",
"topic": "test_topic1",
"code": 0
},
{
"client_id": "mqttjs_2",
"topic": "test_topic2",
"code": 0
}
]
}
批量取消订阅¶
API 定义:
POST api/v3/mqtt/unsubscribe_batch
请求参数:
[{
"topic": "test_topic1",
"client_id": "mqttjs_1"
},{
"topic": "test_topic2",
"client_id": "mqttjs_2"
}]
请求示例:
POST api/v3/mqtt/unsubscribe_batch
返回数据:
{
"code": 0,
"data": [
{
"client_id": "mqttjs_1",
"topic": "test_topic1",
"code": 0
},
{
"client_id": "mqttjs_2",
"topic": "test_topic2",
"code": 0
}
]
}
插件(Plugins)¶
获取所有节点插件列表¶
API 定义:
GET api/v3/plugins/
请求示例:
GET api/v3/plugins/
返回数据:
{
"code": 0,
"data": [
{
"node": "emqx@127.0.0.1",
"plugins": [
{
"name": "emqx_auth_clientid",
"version": "v3.1.0",
"description": "EMQ X Authentication with ClientId/Password",
"active": false
},
{
"name": "emqx_auth_http",
"version": "v3.1.0",
"description": "EMQ X Authentication/ACL with HTTP API",
"active": false
},
{
"name": "emqx_auth_jwt",
"version": "v3.1.0",
"description": "EMQ X Authentication with JWT",
"active": false
},
{
"name": "emqx_auth_ldap",
"version": "v3.1.0",
"description": "EMQ X Authentication/ACL with LDAP",
"active": false
},
{
"name": "emqx_auth_mongo",
"version": "v3.1.0",
"description": "EMQ X Authentication/ACL with MongoDB",
"active": false
},
{
"name": "emqx_auth_mysql",
"version": "v3.1.0",
"description": "EMQ X Authentication/ACL with MySQL",
"active": false
},
{
"name": "emqx_auth_pgsql",
"version": "v3.1.0",
"description": "EMQ X Authentication/ACL with PostgreSQL",
"active": false
},
{
"name": "emqx_auth_redis",
"version": "v3.1.0",
"description": "EMQ X Authentication/ACL with Redis",
"active": false
},
{
"name": "emqx_auth_username",
"version": "v3.1.0",
"description": "EMQ X Authentication with Username and Password",
"active": false
},
{
"name": "emqx_coap",
"version": "v3.1.0",
"description": "EMQ X CoAP Gateway",
"active": false
},
{
"name": "emqx_dashboard",
"version": "v3.1.0",
"description": "EMQ X Web Dashboard",
"active": true
},
{
"name": "emqx_delayed_publish",
"version": "v3.1.0",
"description": "EMQ X Delayed Publish",
"active": false
},
{
"name": "emqx_lua_hook",
"version": "v3.1.0",
"description": "EMQ X Lua Hooks",
"active": false
},
{
"name": "emqx_lwm2m",
"version": "v3.1.0",
"description": "EMQ X LwM2M Gateway",
"active": false
},
{
"name": "emqx_management",
"version": "v3.1.0",
"description": "EMQ X Management API and CLI",
"active": true
},
{
"name": "emqx_plugin_template",
"version": "v3.1.0",
"description": "EMQ X Plugin Template",
"active": false
},
{
"name": "emqx_psk_file",
"version": "v3.1.0",
"description": "EMQX PSK Plugin from File",
"active": false
},
{
"name": "emqx_recon",
"version": "v3.1.0",
"description": "EMQ X Recon Plugin",
"active": true
},
{
"name": "emqx_reloader",
"version": "v3.1.0",
"description": "EMQ X Reloader Plugin",
"active": false
},
{
"name": "emqx_retainer",
"version": "v3.1.0",
"description": "EMQ X Retainer",
"active": true
},
{
"name": "emqx_rule_engine",
"version": "v3.1.0",
"description": "EMQ X Rule Engine",
"active": true
},
{
"name": "emqx_sn",
"version": "v3.1.0",
"description": "EMQ X MQTT SN Plugin",
"active": false
},
{
"name": "emqx_statsd",
"version": "v3.1.0",
"description": "Statsd for EMQ X",
"active": false
},
{
"name": "emqx_stomp",
"version": "v3.1.0",
"description": "EMQ X Stomp Protocol Plugin",
"active": false
},
{
"name": "emqx_web_hook",
"version": "v3.1.0",
"description": "EMQ X Webhook Plugin",
"active": false
}
]
}
]
}
获取节点插件列表¶
API 定义:
GET api/v3/nodes/${node}/plugins/
请求示例:
GET api/v3/nodes/emqx@127.0.0.1/plugins/
返回数据:
{
"code": 0,
"data": [
{
"name": "emqx_auth_clientid",
"version": "v3.1.0",
"description": "EMQ X Authentication with ClientId/Password",
"active": false
},
{
"name": "emqx_auth_http",
"version": "v3.1.0",
"description": "EMQ X Authentication/ACL with HTTP API",
"active": false
},
{
"name": "emqx_auth_jwt",
"version": "v3.1.0",
"description": "EMQ X Authentication with JWT",
"active": false
},
{
"name": "emqx_auth_ldap",
"version": "v3.1.0",
"description": "EMQ X Authentication/ACL with LDAP",
"active": false
},
{
"name": "emqx_auth_mongo",
"version": "v3.1.0",
"description": "EMQ X Authentication/ACL with MongoDB",
"active": false
},
{
"name": "emqx_auth_mysql",
"version": "v3.1.0",
"description": "EMQ X Authentication/ACL with MySQL",
"active": false
},
{
"name": "emqx_auth_pgsql",
"version": "v3.1.0",
"description": "EMQ X Authentication/ACL with PostgreSQL",
"active": false
},
{
"name": "emqx_auth_redis",
"version": "v3.1.0",
"description": "EMQ X Authentication/ACL with Redis",
"active": false
},
{
"name": "emqx_auth_username",
"version": "v3.1.0",
"description": "EMQ X Authentication with Username and Password",
"active": false
},
{
"name": "emqx_coap",
"version": "v3.1.0",
"description": "EMQ X CoAP Gateway",
"active": false
},
{
"name": "emqx_dashboard",
"version": "v3.1.0",
"description": "EMQ X Web Dashboard",
"active": true
},
{
"name": "emqx_delayed_publish",
"version": "v3.1.0",
"description": "EMQ X Delayed Publish",
"active": false
},
{
"name": "emqx_lua_hook",
"version": "v3.1.0",
"description": "EMQ X Lua Hooks",
"active": false
},
{
"name": "emqx_lwm2m",
"version": "v3.1.0",
"description": "EMQ X LwM2M Gateway",
"active": false
},
{
"name": "emqx_management",
"version": "v3.1.0",
"description": "EMQ X Management API and CLI",
"active": true
},
{
"name": "emqx_plugin_template",
"version": "v3.1.0",
"description": "EMQ X Plugin Template",
"active": false
},
{
"name": "emqx_psk_file",
"version": "v3.1.0",
"description": "EMQX PSK Plugin from File",
"active": false
},
{
"name": "emqx_recon",
"version": "v3.1.0",
"description": "EMQ X Recon Plugin",
"active": true
},
{
"name": "emqx_reloader",
"version": "v3.1.0",
"description": "EMQ X Reloader Plugin",
"active": false
},
{
"name": "emqx_retainer",
"version": "v3.1.0",
"description": "EMQ X Retainer",
"active": true
},
{
"name": "emqx_rule_engine",
"version": "v3.1.0",
"description": "EMQ X Rule Engine",
"active": true
},
{
"name": "emqx_sn",
"version": "v3.1.0",
"description": "EMQ X MQTT SN Plugin",
"active": false
},
{
"name": "emqx_statsd",
"version": "v3.1.0",
"description": "Statsd for EMQ X",
"active": false
},
{
"name": "emqx_stomp",
"version": "v3.1.0",
"description": "EMQ X Stomp Protocol Plugin",
"active": false
},
{
"name": "emqx_web_hook",
"version": "v3.1.0",
"description": "EMQ X Webhook Plugin",
"active": false
}
]
}
启用节点指定插件¶
API 定义:
PUT api/v3/nodes/${node}/plugins/${plugin}/load
请求示例:
PUT api/v3/nodes/emqx@127.0.0.1/plugins/emqx_auth_clientid/load
返回数据:
{
"code": 0
}
关闭节点指定插件¶
API 定义:
PUT api/v3/nodes/${node}/plugins/${plugin}/unload
请求示例:
PUT api/v3/nodes/emqx@127.0.0.1/plugins/emqx_auth_clientid/unload
返回数据:
{
"code": 0
}
监听器(Listeners)¶
获取集群监听器列表¶
API 定义:
GET api/v3/listeners/
请求示例:
GET api/v3/listeners/
返回数据:
{
"code": 0,
"data": [
{
"listeners": [
{
"acceptors": 16,
"current_conns": 0,
"listen_on": "8883",
"max_conns": 102400,
"protocol": "mqtt:ssl",
"shutdown_count": [ ]
},
{
"acceptors": 8,
"current_conns": 2,
"listen_on": "0.0.0.0:1883",
"max_conns": 1024000,
"protocol": "mqtt:tcp",
"shutdown_count": {
"closed": 2,
"kicked": 1
}
},
{
"acceptors": 4,
"current_conns": 0,
"listen_on": "127.0.0.1:11883",
"max_conns": 10240000,
"protocol": "mqtt:tcp",
"shutdown_count": [ ]
},
{
"acceptors": 4,
"current_conns": 1,
"listen_on": "18083",
"max_conns": 512,
"protocol": "http:dashboard",
"shutdown_count": [ ]
},
{
"acceptors": 2,
"current_conns": 0,
"listen_on": "8080",
"max_conns": 512,
"protocol": "http:management",
"shutdown_count": [ ]
},
{
"acceptors": 4,
"current_conns": 0,
"listen_on": "8083",
"max_conns": 102400,
"protocol": "mqtt:ws",
"shutdown_count": [ ]
},
{
"acceptors": 4,
"current_conns": 0,
"listen_on": "8084",
"max_conns": 16,
"protocol": "mqtt:wss",
"shutdown_count": [ ]
}
],
"node": "emqx@127.0.0.1"
}
]
}
获取节点监听器列表¶
API 定义:
GET api/v3/nodes/${node}/listeners
请求示例:
GET api/v3/nodes/emqx@127.0.0.1/listeners
返回数据:
{
"code": 0,
"data": [
{
"acceptors": 16,
"current_conns": 0,
"listen_on": "8883",
"max_conns": 102400,
"protocol": "mqtt:ssl",
"shutdown_count": [ ]
},
{
"acceptors": 8,
"current_conns": 2,
"listen_on": "0.0.0.0:1883",
"max_conns": 1024000,
"protocol": "mqtt:tcp",
"shutdown_count": {
"closed": 2,
"kicked": 1
}
},
{
"acceptors": 4,
"current_conns": 0,
"listen_on": "127.0.0.1:11883",
"max_conns": 10240000,
"protocol": "mqtt:tcp",
"shutdown_count": [ ]
},
{
"acceptors": 4,
"current_conns": 1,
"listen_on": "18083",
"max_conns": 512,
"protocol": "http:dashboard",
"shutdown_count": [ ]
},
{
"acceptors": 2,
"current_conns": 0,
"listen_on": "8080",
"max_conns": 512,
"protocol": "http:management",
"shutdown_count": [ ]
},
{
"acceptors": 4,
"current_conns": 0,
"listen_on": "8083",
"max_conns": 102400,
"protocol": "mqtt:ws",
"shutdown_count": [ ]
},
{
"acceptors": 4,
"current_conns": 0,
"listen_on": "8084",
"max_conns": 16,
"protocol": "mqtt:wss",
"shutdown_count": [ ]
}
]
}
收发报文统计¶
获取集群收发报文统计¶
API 定义:
GET api/v3/metrics/
请求示例:
GET api/v3/metrics/
返回数据:
{
"code": 0,
"data": [
{
"node": "emqx@127.0.0.1",
"metrics": {
"bytes/received": 342,
"packets/pubrel/sent": 0,
"packets/pubcomp/missed": 0,
"packets/sent": 13,
"packets/pubrel/received": 0,
"messages/qos1/received": 0,
"packets/publish/received": 2,
"packets/auth": 0,
"messages/qos0/received": 2,
"packets/pubcomp/received": 0,
"packets/unsuback": 0,
"packets/pubrec/missed": 0,
"messages/qos1/sent": 0,
"messages/qos2/sent": 0,
"bytes/sent": 116,
"messages/received": 2,
"messages/dropped": 1,
"messages/qos2/received": 0,
"packets/connect": 5,
"messages/qos0/sent": 4,
"packets/disconnect/received": 0,
"packets/pubrec/sent": 0,
"packets/publish/sent": 4,
"packets/pubrec/received": 0,
"packets/received": 11,
"packets/unsubscribe": 0,
"packets/subscribe": 4,
"packets/disconnect/sent": 0,
"packets/pingresp": 0,
"messages/qos2/dropped": 0,
"packets/puback/missed": 0,
"packets/pingreq": 0,
"packets/connack": 5,
"packets/pubrel/missed": 0,
"messages/sent": 4,
"packets/suback": 4,
"messages/retained": 3,
"packets/puback/sent": 0,
"packets/puback/received": 0,
"messages/qos2/expired": 0,
"messages/forward": 0,
"messages/expired": 0,
"packets/pubcomp/sent": 0
}
}
]
}
获取节点收发报文统计¶
API 定义:
GET api/v3/nodes/${node}/metrics/
请求示例:
GET api/v3/nodes/emqx@127.0.0.1/metrics/
返回数据:
{
"code": 0,
"data": {
"bytes/received": 342,
"packets/pubrel/sent": 0,
"packets/pubcomp/missed": 0,
"packets/sent": 13,
"packets/pubrel/received": 0,
"messages/qos1/received": 0,
"packets/publish/received": 2,
"packets/auth": 0,
"messages/qos0/received": 2,
"packets/pubcomp/received": 0,
"packets/unsuback": 0,
"packets/pubrec/missed": 0,
"messages/qos1/sent": 0,
"messages/qos2/sent": 0,
"bytes/sent": 116,
"messages/received": 2,
"messages/dropped": 1,
"messages/qos2/received": 0,
"packets/connect": 5,
"messages/qos0/sent": 4,
"packets/disconnect/received": 0,
"packets/pubrec/sent": 0,
"packets/publish/sent": 4,
"packets/pubrec/received": 0,
"packets/received": 11,
"packets/unsubscribe": 0,
"packets/subscribe": 4,
"packets/disconnect/sent": 0,
"packets/pingresp": 0,
"messages/qos2/dropped": 0,
"packets/puback/missed": 0,
"packets/pingreq": 0,
"packets/connack": 5,
"packets/pubrel/missed": 0,
"messages/sent": 4,
"packets/suback": 4,
"messages/retained": 3,
"packets/puback/sent": 0,
"packets/puback/received": 0,
"messages/qos2/expired": 0,
"messages/forward": 0,
"messages/expired": 0,
"packets/pubcomp/sent": 0
}
}
连接会话统计¶
获取集群连接会话统计¶
API 定义:
GET api/v3/stats/
请求示例:
GET api/v3/stats/
返回数据:
{
"code": 0,
"data": [
{
"node": "emqx@127.0.0.1",
"subscriptions/shared/max": 0,
"subscriptions/max": 2,
"subscribers/max": 2,
"topics/count": 0,
"subscriptions/count": 0,
"topics/max": 1,
"sessions/persistent/max": 2,
"connections/max": 2,
"subscriptions/shared/count": 0,
"sessions/persistent/count": 0,
"retained/count": 3,
"routes/count": 0,
"sessions/count": 0,
"retained/max": 3,
"sessions/max": 2,
"routes/max": 1,
"subscribers/count": 0,
"connections/count": 0
}
]
}
获取节点连接会话统计¶
API 定义:
GET api/v3/nodes/${node}/stats/
请求示例:
GET api/v3/nodes/emqx@127.0.0.1/stats/
返回数据:
{
"code": 0,
"data": {
"subscriptions/shared/max": 0,
"subscriptions/max": 2,
"subscribers/max": 2,
"topics/count": 0,
"subscriptions/count": 0,
"topics/max": 1,
"sessions/persistent/max": 2,
"connections/max": 2,
"subscriptions/shared/count": 0,
"sessions/persistent/count": 0,
"retained/count": 3,
"routes/count": 0,
"sessions/count": 0,
"retained/max": 3,
"sessions/max": 2,
"routes/max": 1,
"subscribers/count": 0,
"connections/count": 0
}
}
告警信息¶
告警类型与级别¶
告警信息 API 返回的数据中 id 字段为告警类型，支持的告警列表如下：
| 告警 ID | 级别 | 说明 |
|---|---|---|
| cpu_high_watermark | 系统 | CPU 占用过高 |
| system_memory_high_watermark | 系统 | 系统内存占用过高 |
| process_memory_high_watermark | 系统 | 单个进程内存占用过高 |
| too_many_processes | 系统 | 进程数量过多 |
| partitioned | 集群 | 集群脑裂 |
注解
部分告警触发阈值可在 etc/emqx.conf 的 os_mon.* 字段中配置。
获取集群当前告警信息¶
API 定义:
GET api/v3/alarms/present
请求示例:
GET api/v3/alarms/present
返回数据:
{
"code": 0,
"data": [
{
"alarms": [],
"node": "emqx@127.0.0.1"
}
]
}
获取节点当前告警信息¶
API 定义:
GET api/v3/alarms/present/${node}
请求示例:
GET api/v3/alarms/present/emqx@127.0.0.1
返回数据:
{
"code": 0,
"data": []
}
获取集群历史告警信息¶
API 定义:
GET api/v3/alarms/history
请求示例:
GET api/v3/alarms/history
返回数据:
{
"code": 0,
"data": [
{
"alarms": [
{
"clear_at": "2019-07-10 16:54:35",
"desc": "82.60344181007542",
"id": "cpu_high_watermark"
}
],
"node": "emqx@127.0.0.1"
}
]
}
获取节点历史告警信息¶
API 定义:
GET api/v3/alarms/present/${node}
请求示例:
GET api/v3/alarms/present/emqx@127.0.0.1
返回数据:
{
"code": 0,
"data": [
{
"clear_at": "2019-07-10 16:54:35",
"desc": "82.60344181007542",
"id": "cpu_high_watermark"
}
]
}
黑名单¶
获取黑名单列表¶
API 定义:
GET api/v3/banned/
请求示例:
GET api/v3/banned/?_page=1&_limit=10000
返回数据:
{
"code": 0,
"data": [],
"meta": {
"count": 0,
"limit": 10000,
"page": 1
}
}
创建黑名单¶
API 定义:
POST api/v3/banned/
请求参数:
{
"who": "mqttjs_ab9069449e",
"as": "client_id",
"reason": "banned the clientId",
"desc": "normal banned",
"until": 1536146187
}
请求示例:
POST api/v3/banned/
返回数据:
{
"code": 0,
"data": {
"who": "mqttjs_ab9069449e",
"as": "client_id",
"reason": "banned the clientId",
"desc": "normal banned",
"until": 1536146187
}
}
删除指定黑名单¶
API 定义:
DELETE api/v3/banned/${who}?as=${as}
请求示例:
DELETE api/v3/banned/mqttjs_ab9069449e?as=client_id
返回数据:
{
"code": 0
}
错误信息与数据分页¶
出错状态¶
HTTP 状态码大于 200 或消息体 code 值不为 0 时响应携带错误信息返回。
错误示例:
PUT api/v3/nodes/emqx@127.0.0.1/plugins/emqx_recon/load
返回数据:
{
"code": 102,
"message": "already_started"
}
错误码¶
消息体内 code 值不为 0 时请求出错，错误码信息如下
| 错误码 | 备注 |
|---|---|
| 0 | 成功 |
| 101 | badrpc |
| 102 | 未知错误 |
| 103 | 用户名密码错误 |
| 104 | 用户名密码不能为空 |
| 105 | 用户不存在 |
| 106 | admin用户不能删除 |
| 107 | 请求参数缺失 |
| 108 | 请求参数类型错误 |
| 109 | 请求参数不是json类型 |
| 110 | 插件已经启动，不能重复操作 |
| 111 | 插件已经停止，不能重复操作 |
| 112 | 客户端不在线 |
| 113 | 用户已经存在 |
| 114 | 旧密码错误 |
| 115 | topic 参数错误 |
分页参数与分页信息¶
请求示例中使用了 ?_page=1&_limit=10000 参数的接口均支持分页:
_page: 当前页码
_limit: 分页大小
返回数据:
{
"code": 0,
"data": [],
"meta": {
"page": 1,
"limit": 10000,
"count": 0
}
}
规则引擎(rule engine)¶
创建规则¶
API 定义:
POST api/v3/rules
参数定义:
| name | String，规则名字 | |
| for | String，Hook 的名字，可以为: "message.publish"，"client.connected" ... 详见 扩展插件 | |
| rawsql | String，用于筛选和转换原始数据的 SQL 语句 | |
| actions | JSON Array，动作列表 | |
| name | String, 动作名字 | |
| params | JSON Object, 动作参数 | |
| description | String，可选，规则描述 | |
请求参数示例:
{
"name": "test-rule",
"for": "message.publish",
"rawsql": "select * from \"t/a\"",
"actions": [{
"name": "built_in:inspect_action",
"params": {
"a": 1
}
}],
"description": "test-rule"
}
返回数据示例:
{
"code": 0,
"data": {
"actions": [{
"name": "built_in:inspect_action",
"params": {
"$resource": "built_in:test-resource",
"a": 1
}
}],
"description": "test-rule",
"enabled": true,
"for": "message.publish",
"id": "test-rule:1556263150688255821",
"name": "test-rule",
"rawsql": "select * from \"t/a\""
}
}
查询规则¶
API 定义:
GET api/v3/rules/${rule_id}
请求参数示例:
GET api/v3/rules/test-rule:1556263150688255821
返回数据示例:
{
"code": 0,
"data": {
"actions": [{
"name": "built_in:inspect_action",
"params": {
"$resource": "built_in:test-resource",
"a": 1
}
}],
"description": "test-rule",
"enabled": true,
"for": "message.publish",
"id": "test-rule:1556263150688255821",
"name": "test-rule",
"rawsql": "select * from \"t/a\""
}
}
获取当前规则列表¶
API 定义:
GET api/v3/rules
返回数据示例:
{
"code": 0,
"data": [{
"actions": [{
"name": "built_in:inspect_action",
"params": {
"$resource": "built_in:test-resource",
"a": 1
}
}],
"description": "test-rule",
"enabled": true,
"for": "message.publish",
"id": "test-rule:1556263150688255821",
"name": "test-rule",
"rawsql": "select * from \"t/a\""
}]
}
删除规则¶
API 定义:
DELETE api/v3/rules/${rule_id}
请求参数示例:
DELETE api/v3/rules/test-rule:1556263150688255821
返回数据示例:
{
"code": 0
}
获取当前动作列表¶
API 定义:
GET api/v3/actions?for=${hook_type}
请求参示例:
GET api/v3/actions
返回数据示例:
{
"code": 0,
"data": [{
"app": "emqx_rule_engine",
"description": "Republish a MQTT message to a another topic",
"for": "message.publish",
"name": "built_in:republish_action",
"params": {
"target_topic": {
"description": "Repubilsh the message to which topic",
"format": "topic",
"required": true,
"title": "To Which Topic",
"type": "string"
}
},
"type": "built_in"
}, {
"app": "emqx_web_hook",
"description": "Forward Events to Web Server",
"for": "$events",
"name": "web_hook:event_action",
"params": {
"$resource": {
"description": "Bind a resource to this action",
"required": true,
"title": "Resource ID",
"type": "string"
},
"template": {
"description": "The payload template to be filled with variables before sending messages",
"required": false,
"schema": {},
"title": "Payload Template",
"type": "object"
}
},
"type": "web_hook"
}, {
"app": "emqx_web_hook",
"description": "Forward Messages to Web Server",
"for": "message.publish",
"name": "web_hook:publish_action",
"params": {
"$resource": {
"description": "Bind a resource to this action",
"required": true,
"title": "Resource ID",
"type": "string"
}
},
"type": "web_hook"
}, {
"app": "emqx_rule_engine",
"description": "Inspect the details of action params for debug purpose",
"for": "$any",
"name": "built_in:inspect_action",
"params": {},
"type": "built_in"
}]
}
请求参数示例:
GET api/v3/actions?for=client.connected
返回数据示例:
{
"code": 0,
"data": [{
"app": "emqx_rule_engine",
"description": "Inspect the details of action params for debug purpose",
"for": "$any",
"name": "built_in:inspect_action",
"params": {},
"type": "built_in"
}]
}
查询动作¶
API 定义:
GET api/v3/actions/:action_name
请求参数示例:
GET api/v3/actions/built_in:inspect_action
返回数据示例:
{
"code": 0,
"data": {
"app": "emqx_rule_engine",
"description": "Inspect the details of action params for debug purpose",
"for": "$any",
"name": "built_in:inspect_action",
"params": {},
"type": "built_in"
}
}
获取当前资源类型列表¶
API 定义:
GET api/v3/resource_types
返回数据示例:
{
"code": 0,
"data": [{
"attrs": "undefined",
"config": {
"url": "http://host-name/chats"
},
"description": "forward msgs to host-name/chats",
"id": "web_hook:webhook1",
"name": "webhook1",
"type": "web_hook"
}, {
"attrs": "undefined",
"config": {
"a": 1
},
"description": "test-resource",
"id": "built_in:test-resource",
"name": "test-resource",
"type": "built_in"
}]
}
查询资源类型¶
API 定义:
GET api/v3/resource_types/${type}
请求参数示例:
GET api/v3/resource_types/built_in
返回数据示例:
{
"code": 0,
"data": {
"description": "The built in resource type for debug purpose",
"name": "built_in",
"params": {},
"provider": "emqx_rule_engine"
}
}
获取某种类型的资源¶
API 定义:
GET api/v3/resource_types/${type}/resources
请求参数示例:
GET api/v3/resource_types/built_in/resources
返回数据示例:
{
"code": 0,
"data": [{
"attrs": "undefined",
"config": {
"a": 1
},
"description": "test-resource",
"id": "built_in:test-resource",
"name": "test-resource",
"type": "built_in"
}]
}
获取某种类型的动作¶
API 定义:
GET api/v3/resource_types/${type}/actions
请求参数示例:
GET api/v3/resource_types/built_in/actions
返回数据示例:
{
"code": 0,
"data": [{
"app": "emqx_rule_engine",
"description": "Inspect the details of action params for debug purpose",
"for": "$any",
"name": "built_in:inspect_action",
"params": {},
"type": "built_in"
}, {
"app": "emqx_rule_engine",
"description": "Republish a MQTT message to a another topic",
"for": "message.publish",
"name": "built_in:republish_action",
"params": {
"target_topic": {
"description": "Repubilsh the message to which topic",
"format": "topic",
"required": true,
"title": "To Which Topic",
"type": "string"
}
},
"type": "built_in"
}]
}
创建资源¶
API 定义:
POST api/v3/resources
参数定义:
| name | String, 资源名字 |
| type | String, 资源类型 |
| config | JSON Object, 资源配置 |
| description | String，可选，规则描述 |
参数示例:
{
"name": "test-resource",
"type": "built_in",
"config": {
"a": 1
},
"description": "test-resource"
}
返回数据示例:
{
"code": 0,
"data": {
"attrs": "undefined",
"config": {
"a": 1
},
"description": "test-resource",
"id": "built_in:test-resource",
"name": "test-resource",
"type": "built_in"
}
}
获取资源列表¶
API 定义:
GET api/v3/resources
返回数据示例:
{
"code": 0,
"data": [{
"attrs": "undefined",
"config": {
"url": "http://host-name/chats"
},
"description": "forward msgs to host-name/chats",
"id": "web_hook:webhook1",
"name": "webhook1",
"type": "web_hook"
}, {
"attrs": "undefined",
"config": {
"a": 1
},
"description": "test-resource",
"id": "built_in:test-resource",
"name": "test-resource",
"type": "built_in"
}]
}
查询资源¶
API 定义:
GET api/v3/resources/:resource_id
请求参数示例:
GET api/v3/resources/built_in:test-resource
返回数据示例:
{
"code": 0,
"data": {
"attrs": "undefined",
"config": {
"a": 1
},
"description": "test-resource",
"id": "built_in:test-resource",
"name": "test-resource",
"type": "built_in"
}
}
删除资源¶
API 定义:
DELETE api/v3/resources/:resource_id
请求参数示例:
DELETE api/v3/resources/built_in:test-resource
返回数据示例:
{
"code": 0
}