All Products
Document Center

Log Service:get_check_point

Last Updated:Oct 26, 2023

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

Request syntax

aliyunlog log get_check_point --project=<value> --logstore=<value> --consumer_group=<value> [--shard=<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 get_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.
--shardIntegerNo1The ID of the shard.
  • If the specified shard does not exist, an empty list is returned.
  • If no shard ID is specified, the checkpoints of all shards are returned.
For information about the global parameters of the Log Service command-line interface (CLI), see Global parameters.


  • Sample requests
    Query the checkpoint of a shard from which a consumer group consumes data.
    aliyunlog log get_check_point --project="aliyun-test-project" --logstore="logstore-a" --consumer_group="consumer-group-1" --shard_id=1
  • Sample responses
        "checkpoint": "MTUyNDE1NTM3OTM3MzkwODQ5Ng==",
        "consumer": "consumer-group-1",
        "shard": 1,
        "updateTime": 1622636965080584

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 GetCheckPoint.

API reference