文档

CreateConsumerGroup - 创建消费组

更新时间:

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

接口说明

  • 请求语法中 Host 由 Project 名称和日志服务 Endpoint 构成,您需要在 Host 中指定 Project。
  • 每个 Logstore 中最多创建 30 个消费组。
  • 日志服务提供基于 Java SDK 的普通消费和消费组消费日志使用示例。更多信息,请参见普通消费通过消费组消费日志数据

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
log:CreateConsumerGroupWrite
  • LogStore
    acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}
  • log:TLSVersion

请求语法

POST /logstores/{logstore}/consumergroups

请求参数

名称类型必填描述示例值
logstorestring

Logstore 名称。

aliyun-test-logstore
projectstring

Project 名称。

aliyun-test-project
bodyobject

请求体参数。

consumerGroupstring

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

consumerGroupX
timeoutinteger

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

300
orderboolean

是否按顺序消费。

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

返回参数

名称类型描述示例值
headersobject
Serverstring

服务器名称。

nginx
Content-Typestring

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

application/json
Content-Lengthstring

响应内容长度。

0
Connectionstring

是否长链接。取值包括:

  • close:不是长链接,则每个 HTTP 请求都会重新建立 TCP 连接。
  • keep-alive:长链接,TCP 连接建立后保持连接状态,节省连接所需时间和带宽。
close
Datestring

当前返回响应的时间。

Sun, 27 May 2018 08:25:04 GMT
x-log-requestidstring

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

5B0A6B60BB6EE39764D458B5

示例

正常返回示例

JSON格式

{}

错误码

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

HttpStatusCodeErrorCodeErrorMessage错误码描述
404ProjectNotExistProject does not exist.Project 不存在。
404LogStoreNotExistLogstore does not exist.Logstore 不存在。
400ConsumerGroupAlreadyExistconsumer group already exist.消费组已存在。
400JsonInfoInvalidconsumerGroup or timeout is of error format.参数 consumerGroup 或 timeout 格式错误。
500InternalServerErrorSpecified Server Error Message.内部服务调用错误。

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

  • 本页导读 (1)