Queries the detailed information about a consumer group based on the consumer group ID when you use an AMQP server-side subscription.
Limits
Each Alibaba Cloud account can run a maximum of 5 queries per second (QPS).
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | QueryConsumerGroupByGroupId |
The operation that you want to perform. Set the value to QueryConsumerGroupByGroupId. |
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. Notice
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 |
---|---|---|---|
Code | String | iot.system.SystemException |
The error code returned if the call fails. For more information, see Error codes. |
Data | Struct |
The details about the consumer group. This parameter is returned if the call is successful. |
|
CreateTime | String | 2020-05-20T00:05:20.000Z |
The time when the consumer group was created. 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. |
GroupId | String | nJRaJPn5U1JITGf****** |
The ID of the consumer group. |
GroupName | String | Consumer group 1 |
The name of the consumer group. |
ErrorMessage | String | A system exception occurred. |
The error message returned if the call fails. |
RequestId | String | 73B9DF43-7780-47DE-8BED-077729D28BD2 |
The ID of the request. |
Success | Boolean | true |
Indicates whether the call was successful.
|
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryConsumerGroupByGroupId
&GroupId=nJRaJPn5U1JITGf******
&<Common request parameters>
Sample success responses
XML
format
<QueryConsumerGroupByGroupIdResponse>
<Data>
<GroupId>nJRaJPn5U1JITGf******</GroupId>
<GroupName>Consumer group 1</GroupName>
<CreateTime>2019-11-12T11:19:13.000Z</CreateTime>
</Data>
<RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
<Success>true</Success>
</QueryConsumerGroupByGroupIdResponse>
JSON
format
{
"Data": {
"GroupId": "nJRaJPn5U1JITGf******",
"GroupName": "Consumer Group 1",
"CreateTime": "2019-11-12T11:19:13.000Z"
},
"RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.