全部产品
Search
文档中心

日志服务:CreateConsumerGroup

更新时间:Oct 26, 2023

调用CreateConsumerGroup接口在指定的Logstore上创建一个消费组。

接口说明

  • 请求语法中Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。
  • 每个Logstore中最多创建30个消费组。消费组名称,在Project下必须唯一。
  • 已创建并获取AccessKey。更多信息,请参见访问密钥

    阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作,请参见创建RAM用户及授权

  • 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询,请参见管理Project管理Logstore
  • 日志服务提供基于Java SDK的普通消费和消费组消费日志使用示例。更多信息,请参见普通消费通过消费组消费日志数据

鉴权资源

下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息,用于为RAM用户或RAM角色授予调用此API的权限。

动作(Action)

授权策略中的资源描述方式(Resource)

log:CreateConsumerGroup acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

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

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
logstore String Path aliyun-test-logstore

Logstore名称。

project String Host aliyun-test-project

Project名称。

Object Body

请求体参数。

consumerGroup String Body consumerGroupX

消费组名称,在Project下必须唯一。

timeout Integer Body 300

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

order Boolean Body true

是否按顺序消费。

  • true:按顺序消费。
    • 同一个Shard内按照保留字段__tag__:__receive_time__由小到大按顺序消费。
    • Shard分裂后,先消费原Shard数据,然后同时消费由该Shard分裂的Shard数据。
    • Shard合并后,先消费原Shard数据,然后消费由原Shard合并后的新Shard数据。
  • false:不按顺序消费。即所有Shard同时开始消费,Shard分裂或者合并后产生的新Shard,也会立即消费。

返回数据

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

服务器名称。

Content-Type String application/json

返回的响应体的内容格式。

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。

示例

请求示例

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

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

正常返回示例

JSON格式

HTTP/1.1 200 OK

错误码

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

HttpStatusCode

ErrorCode

ErrorMessage

错误码描述

404

ProjectNotExist

Project does not exist.

Project不存在。

404

LogStoreNotExist

Logstore does not exist.

Logstore不存在。

400

ConsumerGroupAlreadyExist

consumer group already exist.

消费组已存在。

400

JsonInfoInvalid

consumerGroup or timeout is of error format.

参数consumerGroup或timeout格式错误。

500

InternalServerError

Specified Server Error Message.

内部服务调用错误。

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