You need to enable JavaScript to run this app.
导航
日志服务
  • 文档首页
    • /
  • 日志服务

DescribeCheckPoint

最近更新时间：2024.04.19 13:54:15

首次发布时间：2023.09.27 12:24:24

我的收藏

调用 DescribeCheckPoint 接口查看指定消费组在指定日志分区上的当前消费位点。

使用说明

  • 此接口用于从服务端获取指定消费组在指定日志主题、日志分区上的消费位点。
  • 此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

请求说明

  • 请求方式：GET
  • 请求地址：https://tls-{Region}.ivolces.com/DescribeCheckPoint

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数类型是否必选示例值描述
ProjectIdString是"fa************"待查看 CheckPoint 的日志项目 ID。
TopicIdString是"hsdgyr*****"待查看 CheckPoint 的日志主题 ID。
ShardIdString是"12"待查看 CheckPoint 的 Shard ID。

Body

参数类型是否必选示例值描述
ConsumerGroupNameString否consumerGroupA待查看 CheckPoint 的消费组名称。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数类型示例值描述
ShardIDInteger0Shard ID。
CheckpointStringNjUwYzRkYTgtMi0wMDAwMDAwMDAwMDAwMzE0LTAwNGY1LTA=指定消费组在指定 Shard 上的消费位点，即消费进度。

请求示例

GET https://tls-{Region}.ivolces.com/DescribeCheckPoint HTTP/1.1

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8 
{
    "ShardID": 0,
    "Checkpoint": "NjUwYzRkYTgtMi0wMDAwMDAwMDAwMDAwMzE0LTAwNGY1LTA="
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码错误码错误信息说明
400InvalidArgumentInvalid argument key %s, value %s, please check argument.参数不合法。
500InternalServerErrorWe encountered an unexpected server error, please try again later.服务器内部错误。