客户端下线
更新时间 2025-11-25 17:14:28
最近更新时间: 2025-11-25 17:14:28
接口功能介绍
客户端下线
接口约束
无
URI
POST /v3/api/kickOutOneClient
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例Id | ||
| clientId | 是 | String | 客户端id |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| returnObj | String | 返回数据 | ||
| message | String | 描述状态 | ||
| statusCode | String | 800-成功 | ||
| error | String | 错误码 |
枚举参数
无
请求示例
请求url
https://mqtt-global.ctapi.ctyun.cn/v3/api/kickOutOneClient
请求头header
{
"regionId":"bb9fdb42056f11eda1610242ac110002"
}
请求体body
{
"prodInstId": "123",
"clientId": "mqtt-1"
}
响应示例
{
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
