Queries the status of a consumer group when you use an AMQP server-side subscription. The status information includes online client information, message consumption rate, number of accumulated messages, and last message consumption time.


Each Alibaba Cloud account can run a maximum of 5 queries per second (QPS).

Note RAM users of an Alibaba Cloud account share the quota of the account.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes QueryConsumerGroupStatus

The operation that you want to perform. Set the value to QueryConsumerGroupStatus.

GroupId String Yes nJRaJPn5U1JITGf******

The ID of the consumer group. After you call the CreateConsumerGroup operation to create a consumer group, the consumer group ID is returned. You can call the QueryConsumerGroupList operation to query the consumer group ID by group name. You can also go to the IoT Platform console,and choose Rules > Server-side Subscription > Consumer Groups to view the consumer group ID.

IotInstanceId String No iot-cn-0pp1n8t****

The ID of the instance. You can view the instance ID on the Overview page in the IoT Platform console.

  • If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
  • If your instance has no Overview page or ID, you do not need to set this parameter.

For more information, see Overview.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common request parameters.

Response parameters

Parameter Type Example Description
AccumulatedConsumeCountPerMinute Integer 10

The message consumption rate. Unit: messages/minute.

AccumulationCount Integer 13

The number of accumulated messages.

ClientConnectionStatusList Array of ConsumerGroupClientConnectionInfo

The details about the client. For more information, see ConsumerGroupClientConnectionInfo.

AccumulatedConsumeCountPerMinute Integer 10

The consumption rate of accumulated messages on a single client of the consumer group. Unit: messages/minute.

ClientId String 868575026******

The ID of the client.

ClientIpPort String

The IP address and port of the client.

OnlineTime Long 1591240546649

The last time when the client was online. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

RealTimeConsumeCountPerMinute Integer 5

The consumption rate of real-time messages on a single client of the consumer group. Unit: messages/minute.

Code String iot.system.SystemException

The error code returned if the call fails. For more information, see Error codes.

ConsumerSpeed Integer 14

The message consumption rate of the consumer group. Unit: messages/minute.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

LastConsumerTime String 2020-05-29T03:37:56.000Z

The time when the last message was consumed. The time is in the yyyy-MM-dd'T'HH:mm:ss.SSSZ format. The time is displayed in UTC and accurate to milliseconds.

RealTimeConsumeCountPerMinute Integer 14

The consumption rate of real-time messages in the consumer group. Unit: messages/minute.

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.


Sample requests

&<Common request parameters>

Sample success responses

XML format


JSON format

    "ClientConnectionStatusList": {
        "ConsumerGroupClientConnectionInfo": [
                "ClientId": "12345-1",
                "AccumulatedConsumeCountPerMinute": 8,
                "OnlineTime": 1627624830193,
                "ClientIpPort": "",
                "RealTimeConsumeCountPerMinute": 16
                "ClientId": "12345-0",
                "AccumulatedConsumeCountPerMinute": 10,
                "OnlineTime": 1627624829763,
                "ClientIpPort": "",
                "RealTimeConsumeCountPerMinute": 14
    "RequestId": "4EC250E4-70CE-546E-9D4A-31D06E04EAD8",
    "AccumulatedConsumeCountPerMinute": 10,
    "Success": true,
    "RealTimeConsumeCountPerMinute": 14,
    "AccumulationCount": 26,
    "ConsumerSpeed": 14

Error codes

For a list of error codes, visit the API Error Center.