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.

Limits

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.

Debugging

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 based on the group name. You can also log on 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. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased.

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

Response parameters

Parameter Type Example Description
AccumulationCount Integer 13

The number of accumulated messages.

ClientConnectionStatusList Array

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

ConsumerGroupClientConnectionInfo
ClientId String 868575026******

The ID of the client.

ClientIpPort String 192.168.xxx.xxx:36918

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.

Code String iot.system.SystemException

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

ConsumerSpeed Integer 14

The message consumption rate. 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 follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ss.SSSZ format. The time is displayed in UTC and accurate to milliseconds.

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.

Examples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryConsumerGroupStatus
&GroupId=nJRaJPn5U1JITGf******
&<Common request parameters>

Sample success responses

XML format

<QueryConsumerGroupStatusResponse>
    <AccumulationCount>13</AccumulationCount>
    <ConsumerSpeed>14</ConsumerSpeed>
    <ClientConnectionStatusList>
        <ConsumerGroupClientConnectionInfo>
            <ClientId>868575026******</ClientId>
            <OnlineTime>1591240546649</OnlineTime>
            <ClientIpPort>192.168.xxx.xxx:36918</ClientIpPort>
        </ConsumerGroupClientConnectionInfo>
    </ClientConnectionStatusList>
    <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
    <Success>true</Success>
</QueryConsumerGroupStatusResponse>

JSON format

{
  "AccumulationCount": 13,
  "ConsumerSpeed": 14,
  "ClientConnectionStatusList": {
        "ConsumerGroupClientConnectionInfo": [
            {
                "ClientId": "868575026******",
                "OnlineTime": 1591240546649,
                "ClientIpPort": "192.168.xxx.xxx:36918"
            }
        ]
    },
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "Success": true
}

Error codes

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