调用UpdateConsumerOffset重置消费者组的消费位点_云消息队列 Kafka 版-阿里云帮助中心

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

接口说明

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

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
alikafka:UpdateGroup	Write	全部资源	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	alikafka_post-cn-mp91inkw****
Topic	string	是	Topic 的名称。只能包含字母、数字、下划线（_）和短横线（-）。长度为 3-64 个字符，多于 64 个字符将被自动截取。一旦创建后不能再修改。若需针对当前消费者所订阅的所有主题设置消费位点，请传入空字符串。	topic_name
RegionId	string	是	Group所属实例的地域ID。	cn-hangzhou
ConsumerId	string	是	Consumer Group 名称。只能包含字母、数字、短横线（-）、下划线（_）。长度限制在 3-64 个字符，多于 64 个字符将被自动截取。一旦创建后不能再修改。	kafka-test
ResetType	string	否	重置消费者组消费位点的类型，支持以下两种： timestamp（默认） offset	timestamp
Time	string	是	传入的时间参数，格式为Unix时间戳，单位为毫秒。参数范围应小于0或在消费位点的保留时间范围内，仅在resetType为timestamp时作用生效。若想重置为最新的消费位点，请传入一个小于0的数，推荐-1。	-1
Offsets	object []	否	当resetType为offset时，用于设置消费者组对于某一主题下各个分区的消费位点。
Partition	integer	否	分区ID。	0
Offset	long	否	分区位点。	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
Success	boolean	调用是否成功。	true
RequestId	string	请求ID。	56729737-C428-4E1B-AC68-7A8C2D5****
Code	integer	返回码。返回 200 代表成功。	200
Message	string	返回信息。	operation success

示例

正常返回示例

JSON格式

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

错误码

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