使用QuerySessionByClientId查询单个客户端在线状态-云消息队列 MQTT 版-阿里云-云消息队列 MQTT 版(MQTT)-阿里云帮助中心

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

接口说明

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作

访问级别

资源类型

条件关键字

关联操作

mq:MqttInstanceAccess

get

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

无

名称	类型	必填	描述	示例值
ClientId	string	是	需要查询的目标 Client ID。	GID_test@@@test
InstanceId	string	是	云消息队列 MQTT 版实例的 ID，一定要和客户端实际使用的实例 ID 匹配。您可以在控制台实例详情页面获取该 ID。	post-cn-0pp12gl****

说明

更多参数说明请参见公共参数和服务接入点。

名称	类型	描述	示例值
	object
OnlineStatus	boolean	设备是否在线，取值说明如下： true：在线 false：不在线	true
RequestId	string	公共参数，每个请求的 ID 都是唯一的。	E4581CCF-62AF-44D9-B5B4-D1DBBC0E****

正常返回示例

JSON格式

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

HTTP status code	错误码	错误信息	描述
400	CheckAccountInfoFailed	An error occurred while checking the account information by the STS token.	解析STS Token账号信息失败。
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.	实例权限校验失败，请确认MQTT实例的所属关系以及授权策略。
400	ParameterCheckFailed	An error occurred while validating the parameters. The parameters may be missing or invalid.	参数校验失败，可能缺失或者传入值非法。
400	PermissionCheckFailed	An 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的所属权限和授权策略。
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.	参数校验失败，可能缺失或者传入值非法。
403	SystemOverFlow	An error occurred while processing your request. Please try again.
404	ApiNotSupport	The specified API is not supported.	当前接口不支持，请检查。
417	InternalError	An error occurred while processing your request. Try again later.

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

更多信息，参考变更详情。