All Products
Search
Document Center

Log Service:GetCheckPoint

Last Updated:Oct 26, 2023

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

Usage notes

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

  • An AccessKey pair is created and obtained. For more information, see AccessKey pairs.

    The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Simple Log Service.

  • The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see Manage a project and Manage a Logstore.

  • The name of the consumer group is obtained. For more information, see ListConsumerGroup.

Authentication resources

The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.

Action

Resource

log:GetConsumerGroupCheckPoint

acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers and does not have operation-specific request headers. For more information, see Common request parameters.

Request syntax

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

Request parameters

Parameter

Type

Position

Required

Example

Description

project

String

Host

Yes

ali-test-project

The name of the project.

logstore

String

Path

Yes

test-logstore

The name of the Logstore.

consumerGroup

String

Path

Yes

consumer-group-1

The name of the consumer group.

shard

Integer

Query

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.

Response parameters

Parameter

Type

Example

Description

Server

String

nginx

The name of the server.

Content-Type

String

application/json

The type of the response body. Valid values: application/json and application/x-protobuf.

Content-Length

String

0

The length of the response body.

Connection

String

close

Indicates whether the connection is persistent. Valid values:

  • close: The connection is non-persistent. A new TCP connection is established for each HTTP request.

  • keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.

Date

String

Sun, 27 May 2018 08:25:04 GMT

The time when the response was returned.

x-log-requestid

String

5B0A6B60BB6EE39764D458B5

The request ID.

Array

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

shard

Integer

0

The ID of the shard.

checkpoint

String

MTUyNDE1NTM3OTM3MzkwODQ5Ng==

The value of the checkpoint.

updateTime

Long

1524224984800922

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

consumer

String

consumer_1

The consumer that consumes the data from the checkpoint.

Examples

Sample requests

GET /logstores/test-logstore/consumergroups/consumer-group-1?shard=1 HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

HTTP status code

For a list of error codes, see Service error codes.

HttpStatusCode

ErrorCode

ErrorMessage

Description

404

ProjectNotExist

Project does not exist.

The specified project does not exist.

404

LogStoreNotExist

Logstore does not exist.

The specified Logstore does not exist.

404

ConsumerGroupNotExist

consumer group not exist.

The specified consumer group does not exist.

500

InternalServerError

Specified Server Error Message.

An internal server error has occurred.

For more information, see Common error codes.