云原生消息引擎
云原生消息引擎
文档指南
请输入
- 文档首页
云原生消息引擎BMQ 实例用户指南API 参考Group 管理ResetSubscriptionOffset - 重置消费位点
复制全文
下载 pdfResetSubscriptionOffset - 重置消费位点
文档反馈
问问助手调用 ResetSubscriptionOffset 接口，重置 Consumer Group 的分区消费位点。
使用说明
云原生消息引擎目前支持两种维度的重置消费位点：
- 重置 Topic 的消费位点：针对 Topic 级别进行重置消费位点操作。
- 重置分区的消费位点：针对 Topic 中某个分区进行重置消费位点操作。
支持两种方式重置消费位点：
- 指定时间点，直接跳转到该时间点的位点开始消费消息。
- 重新选择基准消费位置和相对偏移量，重新开始消费。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com?Action=ResetSubscriptionOffset&Version=2023-06-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：ResetSubscriptionOffset
要执行的操作，取值：ResetSubscriptionOffset。
Version string 必选 示例值：2023-06-01
API的版本，取值：2023-06-01。
TopicId string 必选 示例值：677bb****b1e406797e87e309785c4e6
Topic ID。
GroupId string 必选 示例值：b3f31****1f346a582e976cb8afdd06f
Consumer Group 的 ID。
ResetBy string 必选 示例值：OFFSET
重置方式，取值如下：
- TIMESTAMP：根据时间点重置消费位点，指定过去或将来的时间点，直接跳转到该时间点的位点开始消费。
- OFFSET：根据指定的 offset 重置消费位点，即从指定的位点开始消费，可以通过 offsetType 参数指定 offset。
OffsetType string 可选 示例值：CURRENT
重置方式为 OFFSET 时，该参数必传，指定重新消费的基准消费位置，取值如下：
- EARLIEST：基准消费位置为最早消费位点。
- CURRENT：基准消费位置为当前消费位点。
- LATEST：基准消费位置为最近消费位点。
ResetValue long 必选 示例值：100
重置值。
- 选择重置方式为 TIMESTAMP 时，该值为重新消费的时间点。例如 1722224612000。
- 选择重置方式为 OFFSET 时，该值为相对于 OffsetType 中基准位点的 相对偏移量。例如 100。
PartitionId integer 可选 示例值：0
分区序号。
针对 Topic 中某个分区进行重置消费位点操作。
返回参数
Status string 示例值：SUCCESS
操作状态。
Message string 示例值：OK
操作提示信息。
请求示例
POST /?Action=ResetSubscriptionOffset&Version=2023-06-01 HTTP/1.1
Host: bmq.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241104T131944Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=AK********/20241104/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=********
{
"TopicId": "677bb****b1e406797e87e309785c4e6",
"GroupId": "b3f31****1f346a582e976cb8afdd06f",
"PartitionId": 0,
"ResetBy": "OFFSET",
"OffsetType": "CURRENT",
"ResetValue": 0
}
返回示例
{
"ResponseMetadata": {
"RequestId": "202411042119500491891170492B****",
"Action": "ResetSubscriptionOffset",
"Version": "2023-06-01",
"Service": "bmq",
"Region": "cn-beijing"
},
"Result": {
"Status": "SUCCESS",
"Message": "OK"
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
200 | InvalidParameter | parameter is invalid, pls check parameters | 参数值无效。 |
200 | Unauthorized | authorized error | 授权错误，请授权或切换账号后重试。 |
200 | InternalServiceError | internal service error, please contact with admin | |
200 | DatabaseError | database error | 数据库错误。 |
200 | ParameterEncodingError | Failure encoding object into query map |
最近更新时间：2025.09.04 17:24:44
这个页面对您有帮助吗？
有用
有用
无用
无用