查询全部客户端
更新时间 2025-12-03 09:39:49
最近更新时间: 2025-12-03 09:39:49
接口功能介绍
查看全部客户端信息
接口约束
无
URI
GET /v3/api/getAllClients
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | 445d30ce3d5d40a2a79dc444a8c83859 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | bb9fdb42056f11eda1610242ac110002 华东1 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| message | String | 错误信息 | ||
| statusCode | String | 800-成功 其他失败 | ||
| error | String | 错误码 | ||
| returnObj | Array of Objects | 返回数据 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| clientid | String | 客户端id | ||
| username | String | 认证的用户名 | ||
| ip_address | String | 客户端地址 | ||
| port | String | 客户端连接端口 | ||
| connected_at | String | 连接建立的时间 | ||
| disconnected_at | String | 断开连接的时间(持久化会话提供) | ||
| connected | Boolean | 是否连接状态 | ||
| subscriptions_cnt | Integer | 订阅的数量 |
枚举参数
无
请求示例
请求url
https://mqtt-global.ctapi.ctyun.cn/v3/api/getAllClients
请求头header
{
"regionId":"bb9fdb42056f11eda1610242ac110002"
}
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": [
{
"clientid": "mqtt-1",
"username": "test1",
"ip_address": "33.0.0.5",
"port": "56000",
"connected_at": "2025-01-01 00:00:00",
"disconnected_at": "2025-01-01 00:00:00",
"connected": true,
"subscriptions_cnt": 10
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码