All Products
Search

This Product

    Simple Log Service:get_check_point

    Document Center

    Simple Log Service:get_check_point

    Last Updated:Jun 16, 2026

    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 parameters of the get_check_point command.

    Parameter

    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.

    --shard

    Integer

    No

    1

    The 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 CLI, see Global parameters.

    Examples

    • 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=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, seeError codes.

    API reference

    GetCheckPoint