文档

UpdateConsumerOffset - 重置消费者组的消费位点

更新时间:

通过 UpdateConsumerOffset 重置消费者组的消费位点。

接口说明

此接口用于重置指定消费组的消费位点,支持以 timestamp 和 offset 的方式重置消费者组的消费位点。通过传入不同参数的组合可以实现如下功能:

  • 支持从最新位点开始消费,将消费位点指定到最新的位置(支持所有主题和单一主题)。
  • 支持从指定时间点的位点开始消费,输入时间格式,从指定时间点的位点开始消费(支持所有主题和单一主题)。
  • 支持按分区消费位点进行重置,输入目标分区 ID 和消费位点,从指定的分区和位点开始消费(支持单一主题)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alikafka:UpdateGroupWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

alikafka_post-cn-mp91inkw****
Topicstring

Topic 的名称。

  • 只能包含字母、数字、下划线(_)和短横线(-)。
  • 长度为 3-64 个字符,多于 64 个字符将被自动截取。
  • 一旦创建后不能再修改。

若需针对当前消费者所订阅的所有主题设置消费位点,请传入空字符串。

topic_name
RegionIdstring

Group 所属实例的地域 ID。

cn-hangzhou
ConsumerIdstring

Consumer Group 名称。

  • 只能包含字母、数字、短横线(-)、下划线(_)。
  • 长度限制在 3-64 个字符,多于 64 个字符将被自动截取。
  • 一旦创建后不能再修改。
kafka-test
ResetTypestring

重置消费者组消费位点的类型,支持以下两种:

  • timestamp(默认)
  • offset
timestamp
Timestring

传入的时间参数,格式为 Unix 时间戳,单位为毫秒。 参数范围应小于 0在消费位点的保留时间范围内,仅在 resetType 为 timestamp 时作用生效。

  • 若希望重置为最新的消费位点,请传入-1。

  • 若希望重置为最早的消费位点,请传入-2。

-1
Offsetsobject []

当 resetType 为 offset 时,用于设置消费者组对于某一主题下各个分区的消费位点。

Partitioninteger

分区 ID。

0
Offsetlong

分区位点。

1

(1)将消费者组下所有订阅主题的消费位点重置为最新消费位点,此时 Time 需设置为小于 0 的数,推荐为-1。

{
  "RegionId":"cn-beijing",
  "InstanceId":"alikafka_post-cn-xxxxxx",
  "Topic":"",
  "ConsumerId":"ConsumerGroup1",
  "ResetType": timestamp,
  "Time":-1,
  "Offsets": null
}

(2) 将消费者组下所有订阅主题的消费位点根据传入的参数 Time 重置,Time 的格式为 Unix 时间戳,单位毫秒。

{
  "RegionId":"cn-beijing",
  "InstanceId":"alikafka_post-cn-xxxxxx",
  "Topic":"",
  "ConsumerId":"ConsumerGroup1",
  "ResetType": timestamp,
  "Time":1679587200000,
  "Offsets": null
}

(3) 将消费者组下某一主题的消费位点重置为最新消费位点,此时 Time 需设置为小于 0 的数,推荐为-1。

{
  "RegionId":"cn-beijing",
  "InstanceId":"alikafka_post-cn-xxxxxx",
  "Topic":"topic1",
  "ConsumerId":"ConsumerGroup1",
  "ResetType": timestamp,
  "Time":-1,
  "Offsets": null
}

(4)将消费者组下某一主题的消费位点根据传入的参数时间戳 Time 重置,Time 的格式为 Unix 时间戳,单位毫秒。

{
  "RegionId":"cn-beijing",
  "InstanceId":"alikafka_post-cn-xxxxxxx",
  "Topic":"topic1",
  "ConsumerId":"ConsumerG1",
  "ResetType": timestamp,
  "Time":1679587200000,
  "Offsets": null
}

(5)将消费者组下某一主题的消费位点根据传入的 offsets 重置

{
  "RegionId":"cn-beijing",
  "InstanceId":"alikafka_post-cn-xxxxxxx",
  "Topic":"topic1",
  "ConsumerId":"ConsumerG1",
  "Time":-1,
  "ResetType":"offset",
  "Offsets":"[{\"partition\":1,\"offset\":1},{\"partition\":2,\"offset\":2},{\"partition\":3,\"offset\":3}]"
}

返回参数

名称类型描述示例值
object
Successboolean

调用是否成功。

true
RequestIdstring

请求 ID。

56729737-C428-4E1B-AC68-7A8C2D5****
Codeinteger

返回码。返回 200 代表成功。

200
Messagestring

返回信息。

operation success

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "56729737-C428-4E1B-AC68-7A8C2D5****",
  "Code": 200,
  "Message": "operation success"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-03-15API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)