调用 DescribeCheckPoint 接口查看指定消费组在指定日志分区上的当前消费位点。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ProjectId | String | 是 | "fa************" | 待查看 CheckPoint 的日志项目 ID。 |
TopicId | String | 是 | "hsdgyr*****" | 待查看 CheckPoint 的日志主题 ID。 |
ShardId | String | 是 | "12" | 待查看 CheckPoint 的 Shard ID。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ConsumerGroupName | String | 否 | consumerGroupA | 待查看 CheckPoint 的消费组名称。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ShardID | Integer | 0 | Shard ID。 |
Checkpoint | String | NjUwYzRkYTgtMi0wMDAwMDAwMDAwMDAwMzE0LTAwNGY1LTA= | 指定消费组在指定 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 状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidArgument | Invalid argument key %s, value %s, please check argument. | 参数不合法。 |
500 | InternalServerError | We encountered an unexpected server error, please try again later. | 服务器内部错误。 |