Modifies a consumer group when you configure an AMQP server-side subscription.
Limits
- You cannot modify the default consumer group provided by IoT Platform.
-
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
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | UpdateConsumerGroup |
The operation that you want to perform. Set the value to UpdateConsumerGroup. |
GroupId | String | Yes | nJRaJPn5U1JITGf****** |
The consumer group ID. 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. |
NewGroupName | String | Yes | Consumer group 2 |
The new 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. |
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=UpdateConsumerGroup
&GroupId=nJRaJPn5U1JITGf******
&GroupName=Consumer group 2
&<Common request parameters>
Sample success responses
XML
format
<UpdateConsumerGroupResponse>
<RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
<Success>true</Success>
</UpdateConsumerGroupResponse>
JSON
format
{
"RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.