文档中心

云原生消息引擎

最佳实践

使用 RestAPI 修改集群状态

使用 RestAPI 修改集群状态

云原生消息引擎 MQTT 版基于 EMQX 构建，支持 MQTT 协议，支持 MQTT 协议的客户端连接，支持 MQTT 协议的消息发布、订阅、转发等功能。MQTT 产品在使用中，可以通过 RestAPI 方式修改集群配置，并通过 EMQX 控制台查看实例运行状态。

准备工作

创建云原生消息引擎 MQTT 实例，详细操作请参见创建 MQTT 实例。

操作流程

查看 EMQX RestAPI

创建 EMQX RestAPI 密钥

通过 EMQX RestAPI 访问 EMQX

通过 curl 命令发起请求

通过 postman 发起请求

操作步骤

查看 EMQX RestAPI。

详细操作请参见查看 MQTT 实例信息。

通过实例详情页面查看 Dashboard 地址，改地址可以接收 RestAPI 请求。

可以通过 {instance_url:port}/api-docs/index.html 查看全部的 RestAPI。

创建 EMQX RestAPI 密钥。

详细操作请参见创建 API 密钥。

在控制台中创建 API 密钥。

创建后，必须复制密钥，因为密钥仅显示一次。

确认密钥状态为启动。

通过 EMQX RestAPI 访问 EMQX。

例子使用 /api/v5/configs ，查看集群配置。

通过 curl 命令发起请求

curl -X GET https://{instance_url}:{port}/api/v5/configs -u {ak}:{sk} -H "Content-Type: application/json"

通过 postman 发起请求

auth type 选择 basic auth。

最近更新时间：2025.08.04 17:30:05

这个页面对您有帮助吗？

有用

有用

无用

无用