调用UpdateConsumerGroup接口修改指定消费组属性。

接口说明

Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
project String Host ali-test-project

Project名称。

logstore String Path logstore-test

Logstore名称。

consumerGroup String Path consumer-group-1

消费组名称。

Object Body

请求体参数。

order Boolean Body true

是否按顺序消费。

  • true:在Shard中按顺序消费。Shard分裂后,先消费原Shard数据,然后同时消费由该Shard分裂的Shard数据。Shard合并后,先消费原Shard数据,然后消费由原Shard合并后的新Shard数据。
  • false:不按顺序消费。即所有同时开始消费,Shard分裂或者合并后产生的新Shard,也会立即消费。
timeout Integer Body 300

超时时间。在超时时间段内没有收到心跳,消费者将被删除。单位:秒。

返回数据

名称 类型 示例值 描述
Server String nginx

服务器名称。

Content-Type String application/json

响应内容类型。目前Log Service服务端响应类型支持application/json、application/x-protobuf两种类型。

Content-Length String 0

响应内容长度。

Connection String close

是否长链接。取值包括:

  • close:不是长链接,则每个HTTP请求都会重新建立TCP连接。
  • keep-alive:长链接,TCP连接建立后保持连接状态,节省连接所需时间和带宽。
Date String Sun, 27 May 2018 08:25:04 GMT

返回响应的时间。

x-log-requestid String 5B0A6B60BB6EE39764D458B5

服务端产生的标识,该请求的唯一ID。

示例

请求示例

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

{ }

正常返回示例

JSON格式

HTTP/1.1 200 OK

错误码

访问错误中心查看更多错误码。

HttpStatusCode

ErrorCode

ErrorMessage

错误码描述

400

JsonInfoInvalid

timeout is of error value type.

参数timeout类型错误。

400

ConsumerGroupNotExist

consumer group not exist.

消费组不存在。

404

ProjectNotExist

Project does not exist.

Project不存在。

404

LogStoreNotExist

Logstore does not exist.

Logstore不存在。

500

InternalServerError

Specified Server Error Message.

内部服务调用错误。

更多信息,请参见通用错误码