Updates the attributes of a specified consumer group.

Description

Host consists of a project name and a Log Service endpoint. You must specify a project in Host.

Request headers

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

Request syntax

PUT /logstores/{logstore}/consumergroups/{consumerGroup} HTTP/1.1

Request parameters

Parameter Type Location Required Example Description
project String Host Yes ali-test-project

The name of the project.

logstore String Path Yes logstore-test

The name of the Logstore.

consumerGroup String Path No consumer-group-1

The name of the consumer group.

Object Body Yes

The body of the request.

order Boolean Body No 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.
timeout Integer Body No 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.

Response parameters

Parameter Type Example Description
Server String nginx

The name of the server.

Content-Type String application/json

The type of the response body. Valid values: application/json and application/x-protobuf.

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

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

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

400

JsonInfoInvalid

timeout is of error value type.

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

400

ConsumerGroupNotExist

consumer group not exist.

The error message returned because the specified consumer group does not exist.

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.

500

InternalServerError

Specified Server Error Message.

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

For more information, see Common error codes.