查询设备在线状态
更新时间 2025-11-25 17:13:35
最近更新时间: 2025-11-25 17:13:35
接口功能介绍
无
接口约束
无
URI
GET /v3/api/clientOnLine
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | ||
| clientId | 是 | String | 设备ID |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| returnObj | Object | 返回对象 | returnObj | |
| message | String | 描述状态 | ||
| statusCode | String | 800-成功 其他失败 | ||
| error | String | 错误码 | ||
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| clientid | String | 设备ID | ||
| online | Boolean | 是否在线 |
枚举参数
无
请求示例
请求url
https://mqtt-global.ctapi.ctyun.cn/v3/api/clientOnLine?prodInstId=123&clientId=mqtt-1
请求头header
{
"regionId":"bb9fdb42056f11eda1610242ac110002"
}
请求体body
无
响应示例
{
“statusCode”: 800,
"returnObj": {
"clientid": "mqtt-1",
"online": true
}
}
状态码
请参考 状态码
错误码
请参考 错误码
