すべてのプロダクト
Search
ドキュメントセンター

Simple Log Service:update_consumer_group

最終更新日:Sep 06, 2024

指定されたコンシューマグループの情報を変更します。

リクエスト構文

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>

リクエストパラメーター

update_consumer_groupコマンドに必要なパラメーターと具体的なパラメーターを次の表に示します。

パラメーター

データ型

必須

説明

-- プロジェクト

String

課金されます

aliyun-test-project

プロジェクトの名前。

-- logstore

String

課金されます

logstore-a

ログストアの名前

-- consumer_group

String

課金されます

consumer-グループ-1

消費者グループの名前です。

-- timeout

Integer

課金されません

360

タイムアウト期間。 単位は秒です。

コンシューマーは、接続を確立するために定期的にハートビートをLog Serviceに送信します。 Log Serviceがタイムアウト期間内にコンシューマーによって送信されたハートビートを受信しない場合、Log Serviceはコンシューマーによって占有されているリソースを解放します。

-- in_order

ブール値

課金されません

true

シャードからデータを順番に消費するかどうかを指定します。 有効な値:

  • true: シャード内のデータは順番に消費されます。 シャードが分割されると、元のシャードのデータが最初に消費されます。 その後、新しいシャードのデータが同時に消費されます。

  • false: シャード内のデータはランダムに消費されます。

Log Serviceコマンドラインインターフェイス (CLI) のグローバルパラメーターの詳細については、「グローバルパラメーター」をご参照ください。

  • リクエストの例

    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操作のエラーコードに基づいてエラーを修正します。 詳細については、エラーコードをご参照ください。

API リファレンス

UpdateConsumerGroup