You need to enable JavaScript to run this app.
导航

DescribeCheckPoint

最近更新时间2023.11.13 16:31:41

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

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

使用说明

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

URI

请求方法
GET

URI

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

传输协议

HTTPS

URL 请求参数

参数
参数类型
是否必选
示例值
说明

ProjectId

String

c7******

待查看消费进度的日志项目 ID。

TopicId

String

b6******

待查看消费进度的日志主题 ID。

ShardId

Integer

0

待查看消费进度的 Shard ID。

Body 请求参数

参数
参数类型
是否必选
示例值
说明

ConsumerGroupName

String

my-consumer-group

待查询 CheckPoint 的消费组名称。

响应参数

参数
参数类型
示例值
说明

ShardID

Integer

0

Shard ID。

Checkpoint

String

NjUwYzRkYTgtMi0wMDAwMDAwMDAwMDAwMzE0LTAwNGY1LTA=

指定消费组在指定 Shard 上的消费位点,即游标进度。

示例

请求示例

GET https://tls-{Region}.ivolces.com/DescribeCheckPoint?ProjectId=c******&TopicId=b*******&ShardId=0
Content-Type: application/json
...
{
    "ConsumerGroupName": "my-consumer-group"
}

响应示例

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

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。