# REST API

EMQ X Cloud API 遵循 REST 体系结构,您可以通过编程方式访问 EMQ X 的功能。

# API 概览

API描述
认证管理管理认证信息的创建,删除和更新
访问控制管理管理访问控制的创建,删除和更新
客户端管理查看在线客户端信息,剔除客户端
订阅信息查看订阅信息
主题订阅订阅,取消订阅,批量订阅,批量取消订阅
消息发布消息发布,批量消息发布
指标查看指标

# 如何调用 API

# 构造请求

请求地址由以下几个部分组成

{API}/{resource-path}?{query-string}

您可以在部署详情页面下的 API 访问中,获取到 API 访问地址

api—access

# 认证鉴权

HTTP API 使用 Basic 认证 (opens new window) 方式,id 和 password 须分别填写 AppID 和 AppSecret。 您可以在部署详情页面下的 API 访问中,通过创建应用访问来添加和删除 AppID/AppSecret。

api-app

# 响应码

# HTTP 状态码 (status codes)

接口在调用成功时总是返回 200 OK,响应内容则以 JSON 格式返回。

可能的状态码如下:

状态码描述
200成功,返回的 JSON 数据将提供更多信息
400客户端请求无效,例如请求体或参数错误
401客户端未通过服务端认证,使用无效的身份验证凭据可能会发生
404找不到请求的路径或者请求的对象不存在
500服务端处理请求时发生内部错误

# 返回码 (result codes)

接口的响应消息体为 JSON 格式,其中总是包含返回码 code

可能的返回码如下:

返回码描述
0成功
101RPC 错误
102未知错误
103用户名或密码错误
104空用户名或密码
105用户不存在
106管理员账户不可删除
107关键请求参数缺失
108请求参数错误
109请求参数不是合法 JSON 格式
110插件已开启
111插件已关闭
112客户端不在线
113用户已存在
114旧密码错误
115不合法的主题