ResetConsumeOffset - ApsaraMQ for RocketMQ: Central de Documentação do Alibaba Cloud

Redefine o offset de consumo de um grupo de consumidores. Ao redefinir um offset de consumo, o ponto a partir do qual um consumidor começa a consumir mensagens é alterado. Se ocorrerem falhas ou se mensagens incorretas forem consumidas durante o consumo de mensagens, você pode redefinir o offset de consumo para reverter o consumo para um offset específico e realizar o reconsumo. Você também pode redefinir o offset de consumo para o offset mais recente e deixar temporariamente as mensagens acumuladas sem processamento.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

rocketmq:ResetConsumeOffset

update

*ConsumerGroup

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

Nenhuma

Sintaxe da solicitação

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

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância.	rmq-cn-tl32ue44x0g
consumerGroupId	string	Sim	O ID do grupo de consumidores.	dolphin_status
topicName	string	Sim	O nome do tópico.	AMZN_REPORT_TOPIC

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
body	object	Não	O corpo da solicitação.
resetType	string	Não	O método usado para redefinir o offset de consumo. Valores válidos: LATEST_OFFSET e SPECIFIED_TIME. Valores válidos: SPECIFIED_TIME : Inicia o consumo a partir do offset no horário especificado. LATEST_OFFSET : Inicia o consumo a partir do offset mais recente.	LATEST_OFFSET
resetTime	string	Não	O horário em que o offset de consumo é redefinido.	2023-03-22 12:17:08

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Resultado.
requestId	string	O ID da solicitação.	F9A95891-EAD4-5A2B-8A30-676CD18921AF
success	boolean	Indica se a solicitação foi bem-sucedida.	true
code	string	O código de erro retornado.	MissingInstanceId
message	string	A mensagem de erro retornada.	The instance cannot be found.
httpStatusCode	integer	O código de status HTTP retornado.	200
dynamicCode	string	O código de erro dinâmico retornado.	InstanceId
dynamicMessage	string	A mensagem de erro dinâmico retornada.	instanceId

Exemplos

Resposta de sucesso

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 erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.