更新消费进度。
接口说明
- 当不指定消费者时，必须指定 forceSuccess 为 true 才能更新 checkpoint。
- Host 由 Project 名称和日志服务 Endpoint 构成，您需要在 Host 中指定 Project。
- 已创建并获取 AccessKey。更多信息，请参见访问密钥。
阿里云账号 AccessKey 拥有所有 API 的访问权限，风险很高。强烈建议您创建并使用 RAM 用户进行 API 访问或日常运维。RAM 用户需具备操作日志服务资源的权限。具体操作，请参见创建 RAM 用户及授权。
- 已明确您查询日志所属的 Project 名称、所属地域、Logstore 名称等。如何查询，请参见管理 Project和管理 Logstore。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /logstores/{logstore}/consumergroups/{consumerGroup}?type=checkpoint
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| project | string | 是 | Project 名称。 | ali-test-project |
| logstore | string | 是 | Logstore 名称。 | ali-test-logstore |
| consumerGroup | string | 是 | 消费组名称。 | consumer_group_test |
| consumer | string | 是 | 消费者。 | consumer_1 |
| forceSuccess | boolean | 否 | 是否强制更新。
| false |
| body | object [] | 否 | Shard ID。 | |
| shard | integer | 是 | Shard ID。 | 0 |
| checkpoint | string | 是 | checkpoint 值。 | MTUyNDE1NTM3OTM3MzkwODQ5Ng== |
返回参数
示例
正常返回示例
JSON格式
{}错误码
访问错误中心查看更多错误码。
| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |
|---|---|---|---|
| 400 | InvalidShardCheckPoint | shard checkpoint not encoded by base64. | checkpoint 不是 Base64 编码，格式错误。 |
| 404 | ProjectNotExist | Project does not exist. | Project 不存在。 |
| 404 | LogStoreNotExist | Logstore does not exist. | Logstore 不存在。 |
| 404 | ConsumerGroupNotExist | consumer group not exist. | 消费组不存在。 |
| 404 | ConsumerNotExist | consumer not exist in the consumer group. | 消费组中不存在该消费者。 |
| 404 | ShardNotExist | shard not exist. | Shard 不存在。 |
| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |
更多信息，请参见通用错误码。