ResetConsumeOffset - ApsaraMQ for RocketMQ - Centro de documentación de Alibaba Cloud

Restablece el desplazamiento de consumidor de un grupo de consumidores. Si restablece un desplazamiento de consumidor, se modifica el desplazamiento desde el cual un consumidor comienza a consumir mensajes. Si ocurren fallas o se consumen mensajes incorrectos durante el consumo de mensajes, puede restablecer el desplazamiento de consumidor para revertir el consumo a un desplazamiento específico y volver a consumir los mensajes. También puede restablecer el desplazamiento de consumidor al desplazamiento más reciente y dejar temporalmente sin procesar los mensajes acumulados.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

rocketmq:ResetConsumeOffset

update

*ConsumerGroup

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}

Ninguna

Sintaxis de la solicitud

PATCH /instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeOffsets/{topicName} HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
instanceId	string	Sí	El ID de la instancia.	rmq-cn-tl32ue44x0g
consumerGroupId	string	Sí	El ID del grupo de consumidores.	dolphin_status
topicName	string	Sí	El nombre del tema.	AMZN_REPORT_TOPIC

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
body	object	No	El cuerpo de la solicitud.
resetType	string	No	El método que se utiliza para restablecer el desplazamiento de consumidor. Valores válidos: LATEST_OFFSET y SPECIFIED_TIME. Valores válidos: SPECIFIED_TIME : 从指定时间的位点开始消费. LATEST_OFFSET : 从最新位点开始消费.	LATEST_OFFSET
resetTime	string	No	La hora en la que se restablece el desplazamiento de consumidor.	2023-03-22 12:17:08

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Resultado.
requestId	string	El ID de la solicitud.	F9A95891-EAD4-5A2B-8A30-676CD18921AF
success	boolean	Indica si la solicitud se realizó correctamente.	true
code	string	El código de error devuelto.	MissingInstanceId
message	string	El mensaje de error devuelto.	The instance cannot be found
httpStatusCode	integer	El código de estado HTTP devuelto.	200
dynamicCode	string	El código de error dinámico devuelto.	InstanceId
dynamicMessage	string	El mensaje de error dinámico devuelto.	instanceId

Ejemplos

Respuesta exitosa

JSON Formato

{
  "requestId": "F9A95891-EAD4-5A2B-8A30-676CD18921AF",
  "success": true,
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.