全部產品
Search
文件中心

Simple Log Service:create_consumer_group

更新時間:Oct 25, 2024

調用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

逾時時間。單位:秒。

消費者定期向Log Service的服務端發送心跳訊息,用於建立聯絡。若服務端在逾時時間段內沒有收到消費者發送的心跳訊息,則服務端刪除該消費者佔用相關資源。

--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
  • 查詢已建立消費組。命令樣本如下:

    aliyunlog log list_consumer_group --project="aliyun-test-project" --logstore="logstore-a"

    返回結果如下:

    [
      {
        "name": "consumer-group-1",
        "order": true,
        "timeout": 300
      }
    ]

錯誤碼

如果返回報錯資訊,請參見具體介面的錯誤碼處理。更多資訊,請參見錯誤碼

API參考

CreateConsumerGroup