文档

GetCheckPoint

更新时间:

调用GetCheckPoint接口获取指定消费组消费数据时Shard的Checkpoint。

接口说明

  • 请求语法中Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。

  • 已创建并获取AccessKey。更多信息,请参见访问密钥

    阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作,请参见创建RAM用户及授权

  • 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询,请参见管理Project管理Logstore

  • 已获取消费组名称。更多信息,请参见ListConsumerGroup

鉴权资源

下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息,用于为RAM用户或RAM角色授予调用此API的权限。

动作(Action)

授权策略中的资源描述方式(Resource)

log:GetConsumerGroupCheckPoint

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

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

请求参数

名称

类型

位置

是否必选

示例值

描述

project

String

Host

ali-test-project

Project 名称。

logstore

String

Path

test-logstore

Logstore名称。

consumerGroup

String

Path

consumer-group-1

消费组名称。

shard

Integer

Query

1

Shard ID。

  • 如果指定的Shard不存在,则返回空列表。

  • 如果不指定Shard,则返回所有Shard的Checkpoint。

返回数据

名称

类型

示例值

描述

Server

String

nginx

服务器名称。

Content-Type

String

application/json

响应内容类型。支持application/json、application/x-protobuf两种类型。

Content-Length

String

0

响应内容长度。

Connection

String

close

是否长连接。取值包括:

  • close:不是长连接,则每个HTTP请求都会重新建立TCP连接。

  • keep-alive:长连接,TCP连接建立后保持连接状态,节省连接所需时间和带宽。

Date

String

Sun, 27 May 2018 08:25:04 GMT

当前返回响应的时间。

x-log-requestid

String

5B0A6B60BB6EE39764D458B5

服务端产生的标识,该请求的唯一ID。

Array

指定消费组消费数据时Shard的Checkpoint 列表。

shard

Integer

0

Shard ID。

checkpoint

String

MTUyNDE1NTM3OTM3MzkwODQ5Ng==

Checkpoint值。

updateTime

Long

1524224984800922

Checkpoint最后的更新时间。Unix时间戳格式,表示从1970-1-1 00:00:00 UTC计算起的秒数。

consumer

String

consumer_1

Checkpoint处的消费者。

示例

请求示例

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

正常返回示例

JSON格式

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

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

错误码

访问错误中心查看更多错误码。

HttpStatusCode

ErrorCode

ErrorMessage

错误码描述

404

ProjectNotExist

Project does not exist.

Project不存在。

404

LogStoreNotExist

Logstore does not exist.

Logstore不存在。

404

ConsumerGroupNotExist

consumer group not exist.

消费组不存在。

500

InternalServerError

Specified Server Error Message.

内部服务调用错误。

更多信息,请参见通用错误码

  • 本页导读 (1)
文档反馈