Use the update_consumer_group CLI command to modify information about a specified consumer group-Simple Log Service(SLS)-阿里云帮助中心

Use the update_consumer_group command-line interface (CLI) command to modify information about a specified consumer group.

Request syntax

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>

Request parameters

The following table describes the required and unique parameters for this command.

Parameter Name	Data type	Required	Example	Description
--project	String	Yes	aliyun-test-project	The name of the project.
--logstore	String	Yes	logstore-a	The name of the Logstore.
--consumer_group	String	Yes	consumer-group-1	The name of the consumer group.
--timeout	Integer	No	360	The timeout period. Unit: seconds. The consumer sends heartbeats to Log Service at a regular interval to establish a connection. If Log Service does not receive the heartbeats sent by the consumer within the timeout period, Log Service releases the resources that are occupied by the consumer.
--in_order	Boolean	No	true	Specifies whether to consume messages in order within a single shard. true: Messages are consumed in order within a single shard. After a shard is split, data from the original shard is consumed first. Then, data from the two new shards is consumed in parallel. false: Messages are not consumed in order.

For information about the global parameters for this command, see Global parameters.

Examples

Request example

Modify the timeout period for the `consumer-group-1` consumer group using the default account.

aliyunlog log update_consumer_group --project="aliyun-test-project" --logstore="logstore-a" --consumer_group="consumer-group-1" --timeout="360" --in_order=true

If the command is successful, no response is returned. You can run the following command to query the consumer group.

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

The following result is returned:

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

Error codes

If an error message is returned, see the error code documentation for this API operation. For more information, see Error codes.

API reference

UpdateConsumerGroup