All Products
Document Center

Log Service:update_check_point

Last Updated:Oct 26, 2023

Modifies the checkpoint of a shard from which a consumer group consumes data.

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 of the update_check_point command.
--projectStringYesaliyun-test-projectThe name of the project.
--logstoreStringYeslogstore-aThe name of the Logstore.
--consumer_groupStringYesconsumer-group-1The name of the consumer group.
--shardIntegerYes1The ID of the shard.
--check_pointStringYesMTUyNDE1NTM3OTM3MzkwODQ5Ng==The value of the checkpoint.
--consumerStringNoconsumer_1The consumer.
--force_successBooleanNotrueSpecifies whether to enable forcible updates.
  • True: enables forcible updates.
  • False: disables forcible updates.
For information about the global parameters of the Log Service command-line interface (CLI), see Global parameters.


  • Sample requests
    Modify the checkpoint of a shard from which a specified consumer group consumes data.
    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
  • Sample responses

    After you run the command, no responses are returned.

Error codes

If an error message is returned, fix the error based on the error codes of the related API operation. For more information, see Error codes of UpdateCheckPoint.

API reference