重置指定消费者分组的消费位点。重置消费位点是指改变订阅者当前的消费位置。当消费者出现故障或者消费错误数据时,您可通过重置消费位点将消费位置回滚到之前的某个位点重新开始消费,您也可以将消费位置移动至最新位点,暂时不处理堆积的消息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rocketmq:ResetConsumeOffset | update | *ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId} |
| 无 |
请求语法
PATCH /instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeOffsets/{topicName} HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
instanceId | string | 是 | 云消息队列 RocketMQ 版的实例 ID。 | rmq-cn-tl32ue44x0g |
consumerGroupId | string | 是 | 消费者分组 ID。 | dolphin_status |
topicName | string | 是 | 消费者分组订阅的主题名称。 | AMZN_REPORT_TOPIC |
body | object | 否 | 请求体对象。 | |
resetType | string | 否 | 重置方式。
| LATEST_OFFSET |
resetTime | string | 否 | 指定重置时间。表示消费者将从该时间点对应的消费位点重新开始消费消息。 仅当 resetType(重置方式)选择 SPECIFIED_TIME(指定时间)时需要填写该参数。 格式为 YYYY-MM-DD HH:mm:ss,例如:2023-11-23 10:00:00。 | 2023-03-22 12:17:08 |
返回参数
示例
正常返回示例
JSON
格式
{
"requestId": "F9A95891-EAD4-5A2B-8A30-676CD18921AF",
"success": true,
"code": "MissingInstanceId",
"message": "The instance cannot be found.",
"httpStatusCode": 200,
"dynamicCode": "InstanceId",
"dynamicMessage": "instanceId"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|