CreateConsumerGroup - - Alibaba Cloud Documentation Center

Creates a consumer group for a Logstore.

Operation description

Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.
You can create up to 30 consumer groups for a Logstore.
Simple Log Service provides examples of both regular log consumption and consumer group-based log consumption by using Simple Log Service SDKs for Java. For more information, see Consume log data and Use consumer groups to consume data.

There is currently no authorization information disclosed in the API.

POST /logstores/{logstore}/consumergroups

Parameter	Type	Required	Description	Example
logstore	string	Yes	The name of the Logstore.	aliyun-test-logstore
project	string	Yes	The name of the project.	aliyun-test-project
body	object	Yes	The information about the consumer group.
consumerGroup	string	Yes	The name of the consumer group. The name must be unique in a project.	consumerGroupX
timeout	integer	Yes	The timeout period. If the server does not receive heartbeats from a consumer within the timeout period, the server deletes the consumer. Unit: seconds.	300
order	boolean	Yes	Specifies whether to consume data in sequence. Valid values: true In a shard, data is consumed in ascending order based on the value of the __tag__:__receive_time__ field. If a shard is split, data in the original shard is consumed first. Then, data in the new shards is consumed at the same time. If shards are merged, data in the original shards is consumed first. Then, data in the new shard is consumed. false 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, data in the new shard is immediately consumed.	true

Parameter	Type	Description	Example
headers	object
Server	string	The name of the server.	nginx
Content-Type	string	The format in which the response body is returned.	application/json
Content-Length	string	The length of the response body.	0
Connection	string	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.	close
Date	string	The time when the response was returned.	Sun, 27 May 2018 08:25:04 GMT
x-log-requestid	string	The request ID.	5B0A6B60BB6EE39764D458B5

Sample success responses

JSONformat

{}

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