API Endpoints - 内置模块 - 《EMQ X Broker v4.1 使用教程》

内置模块

内置模块

GET /api/v4/modules

返回集群下所有内置模块信息。

Path Parameters: 无

Success Response Body (JSON):

Name	Type	Description
code	Integer	0
data	Array of Objects	各节点上的内置模块列表
data[0].node	String	节点名称
data[0].modules	Object	内置模块信息列表，详见下面的 modules:

modules:

Name	Type	Description
name	String	模块名
description	String	模块功能描述
active	Boolean	是否处于活跃状态（是否正在运行）

Examples:

$ curl -i --basic -u admin:public -X GET "http://localhost:8081/api/v4/modules"
{"data":[{"node":"emqx@127.0.0.1","modules":[{"name":"emqx_mod_delayed","description":"EMQ X Delayed Publish Module","active":true},{"name":"emqx_mod_topic_metrics","description":"EMQ X Topic Metrics Module","active":false},{"name":"emqx_mod_subscription","description":"EMQ X Subscription Module","active":false},{"name":"emqx_mod_acl_internal","description":"EMQ X Internal ACL Module","active":true},{"name":"emqx_mod_rewrite","description":"EMQ X Topic Rewrite Module","active":false},{"name":"emqx_mod_presence","description":"EMQ X Presence Module","active":true}]}],"code":0}

GET /api/v4/nodes/{node}/modules

类似 GET /api/v4/modules，返回指定节点下所有内置模块信息。

PUT /api/v4/modules/{module}/load

加载集群下所有节点的指定内置模块。

Path Parameters: 无

Success Response Body (JSON):

Name	Type	Description
code	Integer	0
message	String	仅在发生错误时返回，用于提供更详细的错误信息

$ curl -i --basic -u admin:public -X PUT "http://localhost:8081/api/v4/modules/emqx_mod_topic_metrics/load"
{"code":0}

PUT /api/v4/nodes/{node}/modules/{module}/load

类似 PUT /api/v4/modules/{module}/load，加载指定节点下的指定内置模块。

PUT /api/v4/modules/{module}/unload

卸载集群下所有节点的指定内置模块。

Path Parameters: 无

Success Response Body (JSON):

Name	Type	Description
code	Integer	0
message	String	仅在发生错误时返回，用于提供更详细的错误信息

$ curl -i --basic -u admin:public -X PUT "http://localhost:8081/api/v4/modules/emqx_mod_topic_metrics/unload"
{"code":0}

PUT /api/v4/nodes/{node}/modules/{module}/unload

类似 PUT /api/v4/modules/{module}/unload，卸载指定节点下的指定内置模块。

PUT /api/v4/modules/{module}/reload

重新加载集群下所有节点的指定内置模块，仅为 emqx_mod_acl_internal 提供此功能。

Name	Type	Description
code	Integer	0
message	String	仅在发生错误时返回，用于提供更详细的错误信息

$ curl -i --basic -u admin:public -X PUT "http://localhost:8081/api/v4/modules/emqx_mod_acl_internal/reload"
{"code":0}

PUT /api/v4/nodes/{node}/modules/{module}/reload

类似 PUT /api/v4/modules/{module}/reload，重新加载指定节点下的指定内置模块，仅为 emqx_mod_acl_internal 提供此功能。