CreateConsumerGroup - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Creates a consumer group.

Operation description

The ID of the consumer group. The ID is globally unique and is used to identify a consumer group.

The following limits are imposed on the ID:

Character limit: The ID can contain letters, digits, underscores (_), hyphens (-), and percent signs (%).
Length limit: The ID must be 1 to 60 characters in length.

For more information about strings that are reserved for the system, see Limits on parameters.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation

Operation	Access level	Resource type	Condition key	Associated operation
rocketmq:CreateConsumerGroup	create	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}`	none	none

Request syntax

            
POST /instances/{instanceId}/consumerGroups/{consumerGroupId} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.	rmq-cn-7e22ody****
consumerGroupId	string	Yes	The result data that is returned.	GID_test_groupId
body	object	No	The error code.
remark	string	No	The HTTP status code.	This is the remark for test.
deliveryOrderType	string	Yes	The dynamic error message.	Concurrently
consumeRetryPolicy	object	Yes	consume retry policy
maxRetryTimes	integer	No	The maximum number of retries.	16
retryPolicy	string	Yes	The retry policy. For more information, see Message retry. Valid values: FixedRetryPolicy: Failed messages are retried at a fixed interval. DefaultRetryPolicy: Failed messages are retried at incremental intervals as the number of retries increases.	DefaultRetryPolicy
deadLetterTargetTopic	string	No	The dead-letter topic. If a consumer still fails to consume a message after the message is retried for a specified number of times, the message is delivered to a dead-letter topic for subsequent business recovery or troubleshooting. For more information, see Consumption retry and dead-letter messages.	DLQ_mqtest
maxReceiveTps	long	No	Maximum received message tps	300

Response parameters

Parameter	Type	Description	Example

Parameter	Type	Description	Example
	object	Result
requestId	string	The request ID.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Indicates whether the call was successful.	true
data	boolean	The result data that is returned.	true
code	string	The error code.	InvalidConsumerGroupId
message	string	The error message.	Parameter consumerGroupId is invalid.
httpStatusCode	integer	The HTTP status code.	400
dynamicCode	string	The dynamic error code.	ConsumerGroupId
dynamicMessage	string	The dynamic error message.	consumerGroupId

Examples

Sample success responses

JSONformat

            
            
          
{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": true,
  "code": "InvalidConsumerGroupId",
  "message": "Parameter consumerGroupId is invalid.",
  "httpStatusCode": 400,
  "dynamicCode": "ConsumerGroupId",
  "dynamicMessage": "consumerGroupId"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

Change time	Summary of changes	Operation
2025-01-02	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-12-23	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-11-17	The internal configuration of the API is changed, but the call is not affected	View Change Details