All Products
Document Center


Last Updated: May 14, 2019


You can call this operation to query the client connection status for a specified client.


The operation is used to determine whether the consumers of a specified group ID are online, and to obtain the connection details about a list of clients.

Request parameters

Name Type Required Description
InstanceId String No The ID of the instance.
PreventCache Long Yes The parameter used for CSRF verification, which can be set to the current system time. Unit: ms
GroupId String Yes The group ID you want to query.

Response parameters

Name Type Description
RequestId String A common parameter. Each request has a unique ID.
HelpUrl String A help link.
Data List(ConnectionDo) Client connection information for the specified group ID.

Fields in ConnectionDo

Name Type Description
ClientId String The ID of the consumer instance.
ClientAddr String The address and port of the consumer instance.
Language String The language used by the consumer client.
Version String The version of the consumer client.


For more information about sample codes, see API sample code and endpoints.