BatchQuerySessionByClientIds - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Operation description

The BatchQuerySessionByClientIds operation supports up to 100 queries per second (QPS). For more information, see QPS limits.
Each call to the BatchQuerySessionByClientIds operation can query the online status of up to 10 clients.
Each successful call to the BatchQuerySessionByClientIds operation is counted as one transaction and is included in your bill. For more information about billing, see Billing.
For performance reasons, the BatchQuerySessionByClientIds operation queries data from the internal cache. This may result in data inconsistency. For real-time queries, use the QuerySessionByClientId operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mq:BatchQuerySessionByClientIds

none

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ApsaraMQ for MQTT instance. The ID must be the same as the instance ID that the client uses. Obtain the instance ID on the Instance Details page in the console.	post-cn-0pp12gl****
ClientIdList	array	Yes	The list of clients.	ClientIdList.1
	string	No	The client ID. This indicates the Nth client ID. Note Query the status of up to 10 client IDs in a single call. The value of N ranges from 1 to 10.	ClientIdList.1

Note

For more information about other parameters, see Common parameters and Endpoints.

Response elements

Element	Type	Description	Example
	object
RequestId	string	A common parameter. Each request has a unique ID.	63309FDB-ED6C-46AE-B31C-A172FBA0****
OnlineStatusList	array<object>	The list of client statuses.
	object
OnlineStatus	boolean	Indicates whether the device is online. Valid values: true: The device is online. false: The device is offline.	true
ClientId	string	The client ID of the client. For more information about client IDs, see Terms.	GID_test@0001

Examples

Success response

JSON format

{
  "RequestId": "63309FDB-ED6C-46AE-B31C-A172FBA0****",
  "OnlineStatusList": [
    {
      "OnlineStatus": true,
      "ClientId": "GID_test@0001"
    }
  ]
}

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.
500	InternalError	An error occurred while processing your request. Try again later.
500	SystemOverFlow	An error occurred while processing your request. Please try again.
404	ApiNotSupport	The specified API is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.