Queries the running status of an ApsaraMQ for MQTT client. You can troubleshoot issues based on the queried results. You can enter the ID of an ApsaraMQ for MQTT client to check the connection status and IP address of the device.
Operation description
- You can call this operation up to 500 times per second.**** For more information, see Limits on QPS.
- Each successful call to the QuerySessionByClientId operation increases the messaging transactions per second (TPS) by one. This affects the billing of your instance. For more information, see Billing rules.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ClientId | string | Yes | The ID of the ApsaraMQ for MQTT client that you want to query. | GID_test@@@test |
InstanceId | string | Yes | The ID of the ApsaraMQ for MQTT instance. The ID must be consistent with the ID of the instance that the ApsaraMQ for MQTT client uses. You can obtain the instance ID on the Instance Details page that corresponds to the instance in the ApsaraMQ for MQTT console. | post-cn-0pp12gl**** |
Note
For information about other parameters, see Common parameters and Endpoints .
Response parameters
Examples
Sample success responses
JSON
format
{
"OnlineStatus": true,
"RequestId": "E4581CCF-62AF-44D9-B5B4-D1DBBC0E****"
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
400 | CheckAccountInfoFailed | An error occurred while checking the account information by the 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. |
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. |
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. |
500 | SystemOverFlow | An error occurred while processing your request. Please try again. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|
No change history