All Products
Search
Document Center

ApsaraMQ for MQTT:QuerySessionByClientId

Last Updated:Nov 28, 2023

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClientIdstringYes

The ID of the ApsaraMQ for MQTT client that you want to query.

GID_test@@@test
InstanceIdstringYes

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

ParameterTypeDescriptionExample
object
OnlineStatusboolean

Indicates whether the ApsaraMQ for MQTT client is connected to the ApsaraMQ for MQTT broker. Valid values:

  • true
  • false
true
RequestIdstring

The request ID. This parameter is a common parameter.

E4581CCF-62AF-44D9-B5B4-D1DBBC0E****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400CheckAccountInfoFailedAn error occurred while checking the account information by the STS token.
400InstancePermissionCheckFailedAn error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
400ParameterCheckFailedAn error occurred while validating the parameters. The parameters may be missing or invalid.
400PermissionCheckFailedAn error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.
400InvalidParameter.%sAn error occurred while validating the parameter. The parameter may be missing or invalid.
404ApiNotSupportThe specified API is not supported.
500InternalErrorAn error occurred while processing your request. Try again later.
500SystemOverFlowAn error occurred while processing your request. Please try again.

For a list of error codes, visit the Service error codes.