Creating a Consumer Group
Function
This API is used to create a consumer group.
Multiple consumer groups can be created for a queue at a time.
After you create a consumer group, it takes 1s to 3s to initialize the system. If you operate the queue immediately after creating the consumer group, the consumption may fail. You are advised to perform these operations three seconds after creating the queue.
Request
Request parameters
Table 2 describes the request parameters.
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
groups |
Array |
Yes |
Indicates the consumer group information. A maximum of three consumer groups can be created for a queue. If there are more than three consumer groups in the request, the request will fail and consumer groups cannot be created. |
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
name |
String |
Yes |
Indicates the name of a consumer group. The value is a string of 1 to 32 characters that contain letters, digits, hyphens (-), and underscores (_). |
Example request
{ "groups" : [{ "name" : "group-aa" } ] }
Response
Response parameters
Table 4 describes the response parameters.
Parameter |
Type |
Description |
---|---|---|
id |
String |
Indicates the consumer group ID. |
name |
String |
Indicates the name of a consumer group. |
Example response
{ "groups" : [{ "id" : "g-02fb1974-9be1-4eee-8448-ed2d3e89884a", "name" : "group-aa" } ] }
Status Code
Table 5 lists the status code indicating that the operation is successful. For details about the status codes indicating that the operation fails, see Status Code.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot