All Products
Search
Document Center

Simple Log Service:GetCheckPoint

Last Updated:Mar 27, 2026

Queries the checkpoints of a shard from which data is consumed by a consumer group.

Operation description

Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /logstores/{logstore}/consumergroups/{consumerGroup} HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

logstore

string

Yes

The name of the Logstore.

test-logstore

consumerGroup

string

Yes

The name of the consumer group.

consumer-group-1

Request parameters

Parameter

Type

Required

Description

Example

project

string

Yes

The name of the project.

ali-test-project

shard

integer

No

The shard ID.

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

1

Response elements

Element

Type

Description

Example

array

The checkpoints of the shard from which data is consumed by a consumer group.

object

shard

integer

The shard ID.

0

checkpoint

string

The value of the checkpoint.

MTUyNDE1NTM3OTM3MzkwODQ5Ng==

updateTime

integer

The time when the checkpoint was last updated. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

1524224984800922

consumer

string

The consumer at the checkpoint.

consumer_1

Examples

Success response

JSON format

[
  {
    "shard": 0,
    "checkpoint": "MTUyNDE1NTM3OTM3MzkwODQ5Ng==",
    "updateTime": 1524224984800922,
    "consumer": "consumer_1"
  }
]

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.