All Products
Document Center

Simple Log Service:CreateConsumerGroup

Last Updated:Oct 26, 2023

Creates a consumer group for a specified Logstore.

Usage notes

  • Host consists of a project name and a Log Service endpoint. You must specify a project in Host.
  • You can create up to 30 consumer groups for a Logstore. The name of a consumer group must be unique in a project.
  • An AccessKey pair is created and obtained. For more information, see AccessKey pair.

    The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Log Service.

  • The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see Manage a project and Manage a Logstore.
  • Log Service provides examples of both regular log consumption and consumer group-based log consumption by using Log Service SDK for Java. For more information, see Consume log data and Use consumer groups to consume log data.

Authentication resources

The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.





OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

POST /logstores/{logstore}/consumergroups HTTP/1.1

Request parameters


The name of the Logstore.


The name of the project.


The body of the request.


The name of the consumer group. The name must be unique in a project.


The timeout period. If Log Service does not receive heartbeats from a consumer within the timeout period, Log Service deletes the consumer. Unit: seconds.


Specifies whether to consume data in sequence. Valid values:

  • true:
    • Data in a shard is consumed in ascending order based on the value of the reserved field __tag__:__receive_time__.
    • If a shard is split, the data in the original shard is consumed first. Then, the data in the new shards is consumed at the same time.
    • If shards are merged, the data in the original shards is consumed first. Then, the data in the new shard is consumed.
  • false: The data in all shards is consumed at the same time. If a new shard is generated after a shard is split or after shards are merged, the data in the new shard is immediately consumed.

Response parameters


The name of the server.


The content type of the response body.


The content length of the response body.


Indicates whether the connection is persistent. Valid values:

  • close: The connection is non-persistent. A new TCP connection is established for each HTTP request.
  • keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.
DateStringSun, 27 May 2018 08:25:04 GMT

The time at which the response was returned.


The request ID.


Sample requests

POST /logstores/aliyun-test-logstore/consumergroups HTTP/1.1

  "consumerGroup" : "consumerGroupX",
  "timeout" : 300,
  "order" : true

Sample success responses

JSON format

HTTP/1.1 200 OK

Error codes

For a list of error codes, see Service error codes.

HTTP status code

Error code

Error message




Project does not exist.

The specified project does not exist.



Logstore does not exist.

The specified Logstore does not exist.



consumer group already exist.

The consumer group already exists.



consumerGroup or timeout is of error format.

The value of the consumerGroup or timeout parameter is in an invalid format.



Specified Server Error Message.

An internal server error has occurred.

For more information, see Common error codes.