主题订阅 API

本页的 API 文档提供了与 MQTT 客户端订阅管理相关的操作信息，包括主题订阅、取消主题订阅、批量主题订阅和批量取消主题订阅。

订阅

URI

POST /mqtt/subscribe

请求消息

名称	类型	描述
topic	String	主题，与 topics 至少指定其中之一
topics	String	以 , 分割的多个主题，使用此字段能够同时订阅多个主题
clientid	String	客户端标识符
qos	Integer	QoS

响应消息

名称	类型	描述
code	Integer	0

请求示例

$ curl -u app_id:app_secret -X POST -d '{"topic": "d","qos": 1,"clientid": "emqx_c_1"}' {api}/mqtt/subscribe

响应示例

{
  "code": 0
}

取消订阅

URI

POST /mqtt/unsubscribe

请求消息

名称	类型	描述
topic	String	主题
clientid	String	客户端标识符

响应消息

名称	类型	描述
code	Integer	0

请求示例

$ curl -u app_id:app_secret -X POST -d '{"topic": "a","clientid": "emqx_c_1"}' {api}/mqtt/unsubscribe

响应示例

{
  "code": 0
}

批量主题订阅

URI

POST /mqtt/subscribe_batch

请求消息

名称	类型	描述
[].topic	String	主题，与 topics 至少指定其中之一
[].topics	String	以 , 分割的多个主题，使用此字段能够同时订阅多个主题
[].clientid	String	clientid
[].qos	Integer	QoS 等级

响应消息

名称	类型	描述
code	Integer	0
data	Array of Objects	所有订阅信息
data[].clientid	String	clientid
data[].topic	String	订阅主题
data[].code	Integer	0

请求示例

$ curl -u app_id:app_secret -X POST -d '[{"topic": "a", "qos": 1, "clientid": "testtopic/#"}, {"topic": "topic/a", "qos": 1, "clientid": "emqx_c_1"}]' {api}/mqtt/subscribe_batch

响应示例

{
    "data": [
        {
            "topic": "a",
            "code": 112,
            "clientid": "testtopic/#"
        },
        {
            "topic": "topic/a",
            "code": 0,
            "clientid": "emqx_c_1"
        }
    ],
    "code": 0
}

批量取消主题订阅

URI

POST /mqtt/unsubscribe_batch

请求消息

名称	类型	描述
[].topic	String	主题，与 topics 至少指定其中之一
[].topics	String	以 , 分割的多个主题，使用此字段能够同时订阅多个主题
[].clientid	String	clientid
[].qos	Integer	QoS 等级

响应消息

名称	类型	描述
code	Integer	0
data	Array of Objects	所有订阅信息
data[].clientid	String	clientid
data[].topic	String	订阅主题
data[].code	Integer	0

请求示例

$ curl -u app_id:app_secret -X POST -d '[{"topic": "a","clientid": "emqx_c_1"}]' {api}/mqtt/unsubscribe_batch

响应示例

{
  "data": [
    {
      "topic": "a",
      "code": 0,
      "clientid": "emqx_c_1"
    }
  ],
  "code": 0
}