# 查看所有客户端
# URI
GET /clients
返回集群下所有客户端的信息，支持分页。
查询参数:
| 参数 | 类型 | 描述 |
|---|---|---|
| _page | Integer | 页码 |
| _limit | Integer | 每页显示的数据条数 |
| clientid | String | 客户端标识符 |
| username | String | 客户端用户名 |
| zone | String | 客户端配置组名称 |
| ip_address | String | 客户端 IP 地址 |
| conn_state | Enum | 客户端当前连接状态， 可取值有：connected,idle,disconnected |
| clean_start | Bool | 客户端是否使用了全新的会话 |
| proto_name | Enum | 客户端协议名称， 可取值有：MQTT,CoAP,LwM2M,MQTT-SN |
| proto_ver | Integer | 客户端协议版本 |
| _like_clientid | String | 客户端标识符，子串方式模糊查找 |
| _like_username | String | 客户端用户名，子串方式模糊查找 |
| _gte_created_at | Integer | 客户端会话创建时间，小于等于查找 |
| _lte_created_at | Integer | 客户端会话创建时间，大于等于查找 |
| _gte_connected_at | Integer | 客户端连接创建时间，小于等于查找 |
| _lte_connected_at | Integer | 客户端连接创建时间，大于等于查找 |
# 请求消息
无
# 响应消息
| 名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 0 |
| data | Array of Objects | 所有客户端的信息 |
| data[].node | String | 客户端所连接的节点名称 |
| data[].clientid | String | 客户端标识符 |
| data[].username | String | 客户端连接时使用的用户名 |
| data[].proto_name | String | 客户端协议名称 |
| data[].proto_ver | Integer | 客户端使用的协议版本 |
| data[].ip_address | String | 客户端的 IP 地址 |
| data[].port | Integer | 客户端的端口 |
| data[].is_bridge | Boolean | 指示客户端是否通过桥接方式连接 |
| data[].connected_at | String | 客户端连接时间，格式为 "YYYY-MM-DD HH:mm:ss" |
| data[].disconnected_at | String | 客户端离线时间，格式为 "YYYY-MM-DD HH:mm:ss"， 此字段仅在 connected 为 false 时有效并被返回 |
| data[].connected | Boolean | 客户端是否处于连接状态 |
| data[].zone | String | 指示客户端使用的配置组 |
| data[].keepalive | Integer | 保持连接时间，单位：秒 |
| data[].clean_start | Boolean | 指示客户端是否使用了全新的会话 |
| data[].expiry_interval | Integer | 会话过期间隔，单位：秒 |
| data[].created_at | String | 会话创建时间，格式为 "YYYY-MM-DD HH:mm:ss" |
| data[].subscriptions_cnt | Integer | 此客户端已建立的订阅数量 |
| data[].max_subscriptions | Integer | 此客户端允许建立的最大订阅数量 |
| data[].inflight | Integer | 飞行队列当前长度 |
| data[].max_inflight | Integer | 飞行队列最大长度 |
| data[].mqueue_len | Integer | 消息队列当前长度 |
| data[].max_mqueue | Integer | 消息队列最大长度 |
| data[].mqueue_dropped | Integer | 消息队列因超出长度而丢弃的消息数量 |
| data[].awaiting_rel | Integer | 未确认的 PUBREC 报文数量 |
| data[].max_awaiting_rel | Integer | 允许存在未确认的 PUBREC 报文的最大数量 |
| data[].recv_oct | Integer | EMQX Broker（下同）接收的字节数量 |
| data[].recv_cnt | Integer | 接收的 TCP 报文数量 |
| data[].recv_pkt | Integer | 接收的 MQTT 报文数量 |
| data[].recv_msg | Integer | 接收的 PUBLISH 报文数量 |
| data[].send_oct | Integer | 发送的字节数量 |
| data[].send_cnt | Integer | 发送的 TCP 报文数量 |
| data[].send_pkt | Integer | 发送的 MQTT 报文数量 |
| data[].send_msg | Integer | 发送的 PUBLISH 报文数量 |
| data[].mailbox_len | Integer | 进程邮箱大小 |
| data[].heap_size | Integer | 进程堆栈大小，单位：字节 |
| data[].reductions | Integer | Erlang reduction |
| meta | Object | 分页信息 |
| meta.page | Integer | 页码 |
| meta.limit | Integer | 每页显示的数据条数 |
| meta.count | Integer | 数据总条数 |
# 请求示例
$ curl -u app_id:app_secret -X GET {api}/clients?_page=1&_limit=10
1
# 响应示例
{
"meta": {
"page": 1,
"limit": 10000,
"hasnext": false,
"count": 1
},
"data": [
{
"recv_cnt": 45,
"send_pkt": 44,
"clean_start": true,
"expiry_interval": 0,
"proto_ver": 4,
"recv_msg": 0,
"connected_at": "2021-03-18 02:15:57",
"recv_oct": 164,
"is_bridge": false,
"connected": true,
"max_awaiting_rel": 100,
"heap_size": 610,
"mqueue_dropped": 0,
"recv_pkt": 2,
"ip_address": "127.0.0.1",
"max_subscriptions": 0,
"created_at": "2021-03-18 02:15:57",
"awaiting_rel": 0,
"mountpoint": "undefined",
"node": "emqx@10.12.50.91",
"proto_name": "MQTT",
"mailbox_len": 0,
"send_msg": 2,
"clientid": "emqx_c_1",
"mqueue_len": 0,
"inflight": 0,
"max_mqueue": 1000,
"subscriptions_cnt": 4,
"keepalive": 60,
"reductions": 35471,
"zone": "external",
"send_cnt": 44,
"username": "test",
"send_oct": 159,
"port": 3107,
"max_inflight": 32
}
],
"code": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# 查看指定客户端的信息
# URI
GET /clients/{clientid}
返回指定客户端的信息
参数:
| 参数 | 类型 | 描述 |
|---|---|---|
| clientid | String | clientid |
# 请求信息
无
# 响应信息
| 名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 0 |
| data | Array of Objects | 客户端的信息，详细请参见 GET /clients |
# 请求示例
查询指定客户端
$ curl -u app_id:app_ssecret -X GET {api}/clients/emqx_c_1
1
# 响应示例
{
"data": [
{
"recv_cnt": 49,
"send_pkt": 48,
"clean_start": true,
"expiry_interval": 0,
"proto_ver": 4,
"recv_msg": 0,
"connected_at": "2021-03-18 02:15:57",
"recv_oct": 172,
"is_bridge": false,
"connected": true,
"max_awaiting_rel": 100,
"heap_size": 610,
"mqueue_dropped": 0,
"recv_pkt": 2,
"ip_address": "127.0.0.1",
"max_subscriptions": 0,
"created_at": "2021-03-18 02:15:57",
"awaiting_rel": 0,
"mountpoint": "undefined",
"node": "emqx@10.12.50.91",
"proto_name": "MQTT",
"mailbox_len": 0,
"send_msg": 2,
"clientid": "emqx_c_1",
"mqueue_len": 0,
"inflight": 0,
"max_mqueue": 1000,
"subscriptions_cnt": 4,
"keepalive": 60,
"reductions": 38501,
"zone": "external",
"send_cnt": 48,
"username": "test",
"send_oct": 167,
"port": 3107,
"max_inflight": 32
}
],
"code": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# 剔除客户端
# URI
DELETE /clients/{clientid}
踢除指定客户端。注意踢除客户端操作会将连接与会话一并终结。
参数:
| 参数 | 类型 | 描述 |
|---|---|---|
| clientid | String | clientid |
# 请求信息
无
# 响应消息
| 名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 0 |
# 请求示例
$ curl -u app_id:app_secret -X DELETE {api}/clients/emqx_c_1
1
# 响应示例
{
"code": 0
}
1
2
3
2
3