根據 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. | 系統限流，請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史