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

Consulta as informações sobre uma mensagem especificando o ID da mensagem e determina se a mensagem foi consumida.

Descrição da operação

Nota

As operações de API fornecidas pela Alibaba Cloud são usadas para gerenciar e consultar recursos dos serviços da Alibaba Cloud. Recomendamos que você integre essas operações de API apenas em sistemas de gerenciamento. Não use essas operações de API no sistema principal dos serviços de mensagens. Caso contrário, podem ocorrer riscos no sistema.\n\n* Se uma mensagem não for consumida conforme o esperado, você pode chamar esta operação para consultar as informações sobre a mensagem para solução de problemas.\n* Esta operação usa o método de correspondência exata para consultar uma mensagem com base no ID da mensagem. Você pode obter o ID da mensagem a partir do parâmetro SendResult que é retornado após o envio da mensagem. Você deve armazenar as informações retornadas após o envio de cada mensagem. As informações consultadas sobre uma mensagem incluem o momento em que a mensagem foi enviada, o broker no qual a mensagem está armazenada e os atributos da mensagem, como a chave e a tag da mensagem.

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:QueryMessage

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
MsgId	string	Sim	O ID da mensagem que você deseja consultar.	1E0578FE110F18B4AAC235C05F2*****
Topic	string	Sim	O tópico que contém a mensagem que você deseja consultar.	test-mq_topic
InstanceId	string	Não	O ID da instância à qual a mensagem que você deseja consultar 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 tem um ID exclusivo. Você pode usar este ID para solucionar problemas.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	Os dados retornados.
StoreSize	integer	O tamanho da mensagem.	407
ReconsumeTimes	integer	O número de tentativas que foram realizadas para enviar a mensagem aos consumidores.	1
StoreTimestamp	integer	O carimbo de data/hora que indica quando o broker do ApsaraMQ for RocketMQ armazenou a mensagem.	1570761026708
InstanceId	string	O ID da instância.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	O ID da mensagem.	1E0578FE110F18B4AAC235C0C8460BA2
StoreHost	string	O broker do ApsaraMQ for RocketMQ que armazena a mensagem.	11.220.*.*:10911
Topic	string	O tópico ao qual a mensagem pertence.	test-mq_topic
PropertyList	object
MessageProperty	array<object>	The attributes of the message.
	object
Value	string	The value of the attribute.	TagA
Name	string	The name of the attribute. Valid values: TRACE_ON: indicates whether a trace of the message exists. KEYS: indicates the key of the message. TAGS: indicates the tag that is attached to the message. INSTANCE_ID: indicates the ID of the instance which contains the message. For information about the terms that are used in Message Queue for Apache RocketMQ, see Terms.	TAGS
BornTimestamp	integer	O carimbo de data/hora que indica quando a mensagem foi produzida.	1570761026630
BodyCRC	integer	O valor de verificação de redundância cíclica (CRC) do corpo da mensagem.	914112295
BornHost	string	A instância do produtor que gerou a mensagem.	42.120..:64646

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****",
  "Data": {
    "StoreSize": 407,
    "ReconsumeTimes": 1,
    "StoreTimestamp": 1570761026708,
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "MsgId": "1E0578FE110F18B4AAC235C0C8460BA2",
    "StoreHost": "11.220.***.***:10911",
    "Topic": "test-mq_topic",
    "PropertyList": {
      "MessageProperty": [
        {
          "Value": "TagA",
          "Name": "TAGS"
        }
      ]
    },
    "BornTimestamp": 1570761026630,
    "BodyCRC": 914112295,
    "BornHost": "42.120.**.**:64646"
  }
}

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.