Creates a consumer group that is required for 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 | CreateConsumerGroup |
The operation that you want to perform. Set the value to CreateConsumerGroup. |
GroupName | String | Yes | Consumer group 1 |
The name of the consumer group. The name must be 4 to 30 characters in length and can contain letters, digits, and underscores (_). |
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. |
ErrorMessage | String | A system exception occurred. |
The error message returned if the call fails. |
GroupId | String | nJRaJPn5U1JITGf****** |
The ID of the consumer group. |
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=CreateConsumerGroup
&GroupName=Consumer group 1
&<Common request parameters>
Sample success responses
XML
format
<CreateConsumerGroupResponse>
<GroupId>nJRaJPn5U1JITGf******</GroupId>
<RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
<Success>true</Success>
</CreateConsumerGroupResponse>
JSON
format
{
"GroupId": "nJRaJPn5U1JITGf******",
"RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.