根据 Client ID 批量查询客户端在线状态。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 云消息队列 MQTT 版实例的 ID，一定要和客户端实际使用的实例 ID 匹配。您可以在控制台实例详情页面获取该 ID。 | post-cn-0pp12gl**** |
| ClientIdList | array | 是 | 客户端列表。 | |
| string | 是 | 客户端编号，表示第 N 个 Client ID。 说明
单次最多批量查询 10 个 Client ID 的状态，即 N 的取值范围为 1~10。
| ClientIdList.1 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "63309FDB-ED6C-46AE-B31C-A172FBA0****",
"OnlineStatusList": [
{
"OnlineStatus": true,
"ClientId": "GID_test@0001"
}
]
}错误码
| 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. | 系统限流，请重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史