GetCheckPoint - 获取指定消费组的消费点

更新时间:2025-03-28 03:39:11

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

接口说明

  • 请求语法中 Host 由 Project 名称和日志服务 Endpoint 构成,您需要在 Host 中指定 Project。
  • 已创建并获取 AccessKey。更多信息,请参见访问密钥

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

鉴权资源

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

动作(Action)授权策略中的资源描述方式(Resource)
动作(Action)授权策略中的资源描述方式(Resource)
log:GetConsumerGroupCheckPointacs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

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

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
projectstring

Project 名称。

ali-test-project
logstorestring

Logstore 名称。

test-logstore
consumerGroupstring

消费组名称。

consumer-group-1
shardinteger

Shard ID。

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

返回参数

名称类型描述示例值
名称类型描述示例值
headersobject
Serverstring

服务器名称。

nginx
Content-Typestring

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

application/json
Content-Lengthstring

响应内容长度。

0
Connectionstring

是否长连接。取值包括:

  • close:不是长连接,则每个 HTTP 请求都会重新建立 TCP 连接。
  • keep-alive:长连接,TCP 连接建立后保持连接状态,节省连接所需时间和带宽。
close
Datestring

当前返回响应的时间。

Sun, 27 May 2018 08:25:04 GMT
x-log-requestidstring

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

5B0A6B60BB6EE39764D458B5
array<object>

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

object

Checkpoint 结构体。

shardinteger

Shard ID。

0
checkpointstring

Checkpoint 值。

MTUyNDE1NTM3OTM3MzkwODQ5Ng==
updateTimelong

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

1524224984800922
consumerstring

Checkpoint 处的消费者。

consumer_1

示例

正常返回示例

JSON格式

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

错误码

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

HttpStatusCodeErrorCodeErrorMessage错误码描述
HttpStatusCodeErrorCodeErrorMessage错误码描述
404ProjectNotExistProject does not exist.Project 不存在。
404LogStoreNotExistLogstore does not exist.Logstore 不存在。
404ConsumerGroupNotExistconsumer group not exist.消费组不存在。
500InternalServerErrorSpecified Server Error Message.内部服务调用错误。

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

  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求语法
  • 请求参数
  • 返回参数
  • 示例
  • 错误码