调用 DescribeCheckPoint 接口查看指定消费组在指定日志分区上的当前消费位点。 ## 使用说明 * 此接口用于从服务端获取指定消费组在指定日志主题、日志分区上的消费位点。 * 此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。 ## 请求说明 * 请求方式：GET * 请求地址：https://{tls\-endpoint}/DescribeCheckPoint ## 请求参数下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见[公共参数](https://www.volcengine.com/docs/6470/112170)。 ### Query |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |ProjectId |String |是 |`"fa************"` |待查看 CheckPoint 的日志项目 ID。 | |TopicId |String |是 |`"hsdgyr*****"` |待查看 CheckPoint 的日志主题 ID。 | |ShardId |String |是 |`"12"` |待查看 CheckPoint 的 Shard ID。 | ### Body |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |ConsumerGroupName |String |否 |`consumerGroupA` |待查看 CheckPoint 的消费组名称。 | ## 返回参数下表仅列出本接口特有的返回参数。更多信息请参见[返回结构](https://www.volcengine.com/docs/6470/112169)。 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |ShardID |Integer |`0` |返回的Shard ID。 | |Checkpoint |String |`NjUwYzRkYTgtMi0wMDAwMDAwMDAwMDAwMzE0LTAwNGY1LTA=` |指定消费组在指定 Shard 上的消费位点，即消费进度。 | ## 请求示例 ```json GET https://{tls-endpoint}/DescribeCheckPoint HTTP/1.1 ``` ## 返回示例 ```json HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "ShardID": 0, "Checkpoint": "NjUwYzRkYTgtMi0wMDAwMDAwMDAwMDAwMzE0LTAwNGY1LTA=" } ``` ## 错误码下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见[公共错误码](https://www.volcengine.com/docs/6470/112173)文档。 |**HTTP 状态码** |**错误码** |**错误信息** |**说明** | |---|---|---|---| |400 |InvalidArgument |Invalid argument key %s, value %s, please check argument. |参数不合法。 | |500 |InternalServerError |We encountered an unexpected server error, please try again later. |服务器内部错误。 |

日志服务