调用CLI命令在指定的Logstore上创建一个消费组。

请求语法

aliyunlog log create_consumer_group --project=<value> --logstore=<value> --consumer_group=<value> --timeout=<value> [--in_order=<value>] [--access-id=<value>] [--access-key=<value>] [--sts-token=<value>] [--region-endpoint=<value>] [--client-name=<value>] [--jmes-filter=<value>] [--format-output=<value>] [--decode-output=<value>]

请求参数

该命令的必选和特有参数描述如下。
参数名称 数值类型 是否必选 示例值 描述
--project String aliyun-test-project Project名称。
--logstore String logstore-a Logstore名称。
--consumer_group String consumer-group-1 消费组名称,在Project下必须唯一。
--timeout Integer 300 超时时间。单位:秒。

消费者定期向日志服务的服务端发送心跳消息,用于建立联系。若服务端在超时时间段内没有收到消费者发送的心跳消息,则服务端删除该消费者占用相关资源。

--in_order Boolean true 在单个Shard中是否按顺序消费。
  • true:表示在单个Shard中按顺序消费。Shard分裂后,先消费原Shard数据,然后并列消费两个新Shard的数据。
  • false(默认值):表示不按顺序消费。
关于该命令的全局参数,请参见 全局参数

示例

  • 请求示例
    使用默认账号为logstore-a创建一个消费组。
    aliyunlog log create_consumer_group --project="aliyun-test-project" --logstore="logstore-a" --consumer_group="consumer-group-1" --timeout="300" --in_order=true
  • 返回示例

    命令执行成功后,无响应消息。

错误码

如果返回报错信息,请参见具体接口的错误码处理。更多信息,请参见CreateConsumerGroup错误码处理

API参考

CreateConsumerGroup