Use the update_consumer_group CLI command to modify information about a specified consumer group - Simple Log Service

update_consumer_group コマンドラインインターフェイス (CLI) コマンドを使用して、指定したコンシューマーグループの情報を変更します。

リクエスト構文

aliyunlog log update_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	文字列	はい	aliyun-test-project	プロジェクトの名前。
--logstore	文字列	はい	logstore-a	Logstore の名前。
--consumer_group	文字列	はい	consumer-group-1	コンシューマーグループの名前。
--timeout	整数	いいえ	360	タイムアウト期間。単位：秒。コンシューマーは、接続を確立するために定期的にハートビートをLog Serviceに送信します。 Log Serviceがタイムアウト期間内にコンシューマーによって送信されたハートビートを受信しない場合、Log Serviceはコンシューマーによって占有されているリソースを解放します。
--in_order	ブール値	いいえ	true	単一のシャード内でメッセージを順序通りに消費するかどうかを指定します。 true：単一のシャード内でメッセージが順序通りに消費されます。シャードが分割された後、元のシャードのデータが最初に消費されます。その後、2 つの新しいシャードのデータが並行して消費されます。 false：メッセージは順序通りに消費されません。

このコマンドのグローバルパラメーターについては、「グローバルパラメーター」をご参照ください。

例

リクエスト例
デフォルトアカウントを使用して、consumer-group-1 コンシューマーグループのタイムアウト期間を変更します。
```
aliyunlog log update_consumer_group --project="aliyun-test-project" --logstore="logstore-a" --consumer_group="consumer-group-1" --timeout="360" --in_order=true
```
コマンドが成功した場合、応答は返されません。次のコマンドを実行して、コンシューマーグループをクエリできます。
```
aliyunlog log list_consumer_group --project="aliyun-test-project" --logstore="logstore-a"
```
次の結果が返されます：
```
[
  {
    "name": "consumer-group-1",
    "order": true,
    "timeout": 360
  }
]
```

エラーコード

エラーメッセージが返された場合は、この API 操作のエラーコードドキュメントをご参照ください。詳細については、「エラーコード」をご参照ください。

Simple Log Service:update_consumer_group

リクエスト構文

リクエストパラメーター

例

エラーコード

関連 API