Call the CreateConsumerGroup interface to create a consumer group.

Usage notes

This interface is used to create a consumer group.

Before creating a consumer group, please make sure a project and topic have been created. For detailed instructions, please refer to Create a project, Create a topic.

You can create up to 150 consumer groups for a project.

The call frequency limit of this interface is 20 times/s. Exceeding the frequency limit will return an ExceedQPSLimit error.

Request syntax

Request Method：POST

Request URL：https://{tls-endpoint}/CreateConsumerGroup

Request parameters

The table below only lists the request parameters specific to this interface and some common parameters. For more information, please see Common parameters.

Body

Name	Type	Required	Example	Description
ProjectID	String	True	c7******	The ID of the project to which the consumer group belongs.
TopicIDList	Array of String	True	["A1 ****", " b2 ****"]	The list of topic IDs to be consumed by the consumer group.
ConsumerGroupName	String	True	my-consumer-group	Consumer group name. For naming rules, please refer to Resource Naming Rules.
HeartbeatTTL	Integer	True	60	The heartbeat expiration time, in seconds, with a value range of 1 to 300.
OrderedConsume	Boolean	True	false	Whether to consume the logs in order. true: Consume the logs in order within the shard. After the shard is split, the original shard data is consumed first, and then the shard data split from that shard is consumed in parallel; After the shard is merged, the original shard data is consumed first, and then the new shard data merged from the original shard is consumed. false: Do not consume the logs in order. That is, all shards are consumed at the same time, and the new shards generated after the shard is split or merged will also be consumed immediately.

Responses

There are no unique return parameters for this interface. For more information, please refer to the Response message.

Sample Request

Sample Response

Error code

The following table lists the error codes related to the interface and business logic. For common error codes, please refer to the Common error codes.

HTTP status code	Error code	Error message	Description
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	The parameter is invalid.
400	InvalidArgument	Invalid argument key %s, value %s, acceptable value: %s please check argument.	The parameter is invalid.
400	ExceedConsumerGroupProjectQuota	Exceed project's consumer group quota, projectID: %s	Exceeded the consumer group quota under a Project.
400	ConsumerGroupAlreadyExists	consumer group already exists	The consumer group already exists.
500	InternalServerError	We encountered an unexpected server error, please try again later.	Internal server error.

Torch Log Service