文档

QuerySessionByClientId - 查询客户端在线状态

更新时间:
一键部署

**QuerySessionByClientId**接口一般用于线上追踪单个设备的运行状态,再根据查询到的信息排查问题。输入Client ID即可查到对应设备是否在线、设备地址等信息。

接口说明

  • QuerySessionByClientId 接口的 QPS 限制为 500。更多信息请参见 QPS 限制
  • 每成功调用一次 QuerySessionByClientId 接口,都会计算为一次消息 TPS,从而影响您的计费。详情请参见计费说明

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ClientIdstring

需要查询的目标 Client ID。

GID_test@@@test
InstanceIdstring

云消息队列 MQTT 版实例的 ID,一定要和客户端实际使用的实例 ID 匹配。您可以在控制台实例详情页面获取该 ID。

post-cn-0pp12gl****
说明 更多参数说明请参见公共参数服务接入点

返回参数

名称类型描述示例值
object
OnlineStatusboolean

设备是否在线,取值说明如下:

  • true:在线
  • false:不在线
true
RequestIdstring

公共参数,每个请求的 ID 都是唯一的。

E4581CCF-62AF-44D9-B5B4-D1DBBC0E****

示例

正常返回示例

JSON格式

{
  "OnlineStatus": true,
  "RequestId": "E4581CCF-62AF-44D9-B5B4-D1DBBC0E****"
}

错误码

HTTP status code错误码错误信息描述
400CheckAccountInfoFailedAn error occurred while checking the account information by the STS token.解析STS Token账号信息失败。
400InstancePermissionCheckFailedAn error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.实例权限校验失败,请确认MQTT实例的所属关系以及授权策略。
400ParameterCheckFailedAn error occurred while validating the parameters. The parameters may be missing or invalid.参数校验失败,可能缺失或者传入值非法。
400PermissionCheckFailedAn error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.资源权限校验失败,请检查实例、Topic和Group ID的所属权限和授权策略。
400InvalidParameter.%sAn error occurred while validating the parameter. The parameter may be missing or invalid.参数校验失败,可能缺失或者传入值非法。
404ApiNotSupportThe specified API is not supported.当前接口不支持,请检查。
500InternalErrorAn error occurred while processing your request. Try again later.MQTT后端服务异常,请重试。
500SystemOverFlowAn error occurred while processing your request. Please try again.系统限流,请重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈