Creates a consumer group for a specified Logstore.

Description

  • 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.
  • 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.

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

Parameter Type Location Required Example Description
logstore String Path Yes aliyun-test-logstore

The name of the Logstore.

project String Host Yes aliyun-test-project

The name of the project.

Object Body Yes

The body of the request.

consumerGroup String Body Yes consumerGroupX

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

timeout Integer Body Yes 300

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

order Boolean Body Yes true

Specifies whether to consume data in sequence. Valid values:

  • true: consumes data in shards in sequence. 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: does not consume data in shards in sequence. The data in all shards is consumed at the same time. If a new shard is generated after a shard is split or shards are merged, the data in the new shard is immediately consumed.

Response parameters

Parameter Type Example Description
Server String nginx

The name of the server.

Content-Length String 0

The length of the response body.

Connection String close

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.
Access-Control-Allow-Origin String *

Indicates whether code from any origin is allowed to access the resource.

Date String Sun, 27 May 2018 08:25:04 GMT

The time at which the response is returned.

x-log-requestid String 5B0A6B60BB6EE39764D458B5

The unique ID of the request. The ID is generated by Log Service.

Examples

Sample requests

POST /logstores/logstoreName/consumergroups HTTP/1.1
Host:aliyun-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

null

Sample success responses

JSON format 

HTTP/1.1 200 OK

Error codes

For a list of error codes, visit the API Error Center.

HTTP status code

Error code

Error message

Description

404

ProjectNotExist

Project does not exist.

The error message returned because the specified project does not exist.

404

LogStoreNotExist

Logstore does not exist.

The error message returned because the specified Logstore does not exist.

400

ConsumerGroupAlreadyExist

consumer group already exist.

The error message returned because the consumer group already exists.

400

JsonInfoInvalid

consumerGroup or timeout is of error format.

The error message returned because the value of the consumerGroup or timeout parameter is in an invalid format.

500

InternalServerError

Specified Server Error Message.

The error message returned because an internal server error has occurred.

For more information, see Common error codes.