**QuerySessionByClientId**接口一般用于线上追踪单个设备的运行状态，再根据查询到的信息排查问题。输入Client ID即可查到对应设备是否在线、设备地址等信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| 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**** |
返回参数
示例
正常返回示例
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. | 参数校验失败，可能缺失或者传入值非法。 |
| 404 | ApiNotSupport | The specified API is not supported. | 当前接口不支持，请检查。 |
| 500 | InternalError | An error occurred while processing your request. Try again later. | MQTT后端服务异常，请重试。 |
| 500 | SystemOverFlow | An error occurred while processing your request. Please try again. | 系统限流，请重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史