Use the update_check_point command to modify the checkpoint of a consumer group-Simple Log Service(SLS)-阿里云帮助中心

Modifies the data consumption checkpoint of a shard for a consumer group.

Request syntax

aliyunlog log update_check_point --project=<value> --logstore=<value> --consumer_group=<value> --shard=<value> --check_point=<value> [--consumer=<value>] [--force_success=<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 specific parameters for this command.

Parameter name	Numeric types	Required	Example value	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.
--shard	Integer	Yes	1	The shard ID.
--check_point	String	Yes	MTUyNDE1NTM3OTM3MzkwODQ5Ng==	The checkpoint value.
--consumer	String	No	consumer_1	The consumer.
--force_success	Boolean	No	true	Specifies whether to force the update. true: Forces the update. false: Does not force the update.

For more information about the global parameters of the command-line interface (CLI), see Global parameters.

Examples

Example request

You can update the shard checkpoint for a specified consumer group.

aliyunlog log update_check_point --project="aliyun-test-project" --logstore="logstore-a" --consumer_group="consumer-group-1" --shard=1 --check_point="MTUyNDE1NTM3OTM3MzkwODQ5Ng==" --consumer="consumer_1" --force_success=true

If the command is successful, no response is returned.

Example

Request example

You can use the default account to modify the timeout for the consumer group 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

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

aliyunlog log  get_check_point --project="aliyun-test-project" --logstore="logstore-a" --shard=3

The following response is returned:

[
  {
    "checkpoint": "MTUyNDE1NTM3OTM3MzkwODQ5Ng==",
    "consumer": "",
    "shard": 3,
    "updateTime": 1719544024896258
  }
]

Error codes

If an error message is returned, see UpdateCheckPoint error codes for more information.

API reference

UpdateCheckPoint