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

Descrição da operação

Importante

Alibaba Cloud OpenAPI é uma API de gerenciamento usada para gerenciar e consultar os recursos dos serviços Alibaba Cloud. Integre esta API apenas para fins de gerenciamento. Não use esta API para links de dados principais que enviam e recebem mensagens. Isso pode introduzir ameaças aos seus links de dados.

Você pode usar esta operação para verificar o status de consumo de uma mensagem para solução de problemas preliminar quando ocorrer uma exceção de consumo.
Esta operação é baseada no mecanismo interno de offset do ApsaraMQ for RocketMQ. Os resultados são confiáveis na maioria dos cenários. No entanto, se você redefinir offsets ou limpar mensagens, os resultados podem ser imprecisos.

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

mq:QueryMessageTrace

get

Topic

acs:mq:{#regionId}:{#accountId}:{#TopicName}

Topic

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}

Nenhuma

mq:OnsInstanceBaseInfo

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Topic	string	Sim	O tópico da mensagem.	test-mq_topic
MsgId	string	Sim	O ID da mensagem cuja rastreabilidade você deseja consultar. Este é o ID da mensagem.	1E05791C117818B4AAC23B1BB0CE****
InstanceId	string	Não	O ID da instância à qual a mensagem pertence.	MQ_INST_111111111111_DOxxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação. Este é um parâmetro comum. Cada solicitação possui um ID exclusivo. Use este ID para solucionar problemas.	EAE5BE23-37A1-4354-94D6-E44AE17E****
Data	object
MessageTrack	array<object>	Os resultados da consulta.
	object
TrackType	string	The current status. Valid values: CONSUMED: The message was consumed. CONSUMED_BUT_FILTERED: The message was filtered out and not consumed because it did not meet the subscription conditions of the group ID. NOT_CONSUME_YET: The message has not been consumed. NOT_ONLINE: The client is offline. UNKNOWN: An unknown error occurred.	CONSUMED
ConsumerGroup	string	The group ID of the consumer that subscribes to the topic.	GID_test_group_id
InstanceId	string	The ID of the instance to which the message belongs.	MQ_INST_111111111111_DOxxxxxx

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "EAE5BE23-37A1-4354-94D6-E44AE17E****",
  "Data": {
    "MessageTrack": [
      {
        "TrackType": "CONSUMED",
        "ConsumerGroup": "GID_test_group_id",
        "InstanceId": "MQ_INST_111111111111_DOxxxxxx"
      }
    ]
  }
}

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.