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

Consulta os detalhes de uma mensagem específica.

Descrição da operação

Importante

A OpenAPI do Alibaba Cloud é uma API de plano de controle. Você pode usá-la para gerenciar e consultar recursos de serviço do Alibaba Cloud. Não use a OpenAPI para links de dados principais que enviam e recebem mensagens, pois isso pode criar ameaças aos seus links de dados.

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

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
InstanceId	string	Sim	O ID da instância do ApsaraMQ for RocketMQ.	MQ_INST_184681981******_BXig0x6A
Topic	string	Sim	O tópico da mensagem a ser consultada.	test-mq_topic
MsgId	string	Sim	O ID da mensagem a ser consultada. Este é o ID da mensagem.	1E0578FE110F18B4AAC235C0******

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	Um parâmetro comum. O ID da solicitação. Cada solicitação tem um ID exclusivo. Use este ID para solucionar problemas.	EAE5BE23-37A1-4354-94D6-E44AE17E****
Data	object	O resultado da consulta.
StoreSize	integer	O tamanho da mensagem. Unidade: KB.	2
ReconsumeTimes	integer	O número de vezes que o consumo da mensagem é tentado novamente.	0
StoreTimestamp	integer	O carimbo de data/hora UNIX de quando a mensagem foi armazenada no lado do servidor. Unidade: milissegundos.	1570761026708
Body	string	O corpo da mensagem, que é uma string codificada em Base64.	aGVsbG8=
InstanceId	string	O ID da instância do ApsaraMQ for RocketMQ.	MQ_INST_184681981******_BXig0x6A
MsgId	string	O ID da mensagem.	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	A instância do servidor onde a mensagem está armazenada.	11.220.*.*:10911
Topic	string	O tópico ao qual a mensagem pertence.	test-mq_topic
PropertyList	array<object>	A lista de atributos da mensagem.
	object
Value	string	The value of the message attribute.	MSG_REGION
Name	string	The message attribute. Valid values: TRACE_ON: Indicates whether a message trace exists. MSG_REGION: The region ID of the instance that contains the message topic. __MESSAGE_DECODED_TIME: The time when the message was decoded. __BORNHOST: The IP address of the producer client. UNIQ_KEY: The unique identifier of the message. This is the message ID. For more information, see Terms.	cn-hangzhou
BornTimestamp	integer	O carimbo de data/hora UNIX de quando a mensagem foi gerada. Unidade: milissegundos.	1570761026630
BodyCRC	integer	O valor de verificação de redundância cíclica (CRC) do corpo da mensagem.	907060870
BornHost	string	A instância do cliente que gerou a mensagem.	42.120..:64646
BodyStr	string	O conteúdo do corpo da mensagem.	hello

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "EAE5BE23-37A1-4354-94D6-E44AE17E****",
  "Data": {
    "StoreSize": 2,
    "ReconsumeTimes": 0,
    "StoreTimestamp": 1570761026708,
    "Body": "aGVsbG8=",
    "InstanceId": "MQ_INST_184681981******_BXig0x6A",
    "MsgId": "1E0578FE110F18B4AAC235C05F2*****",
    "StoreHost": "11.220.***.***:10911",
    "Topic": "test-mq_topic",
    "PropertyList": [
      {
        "Value": "MSG_REGION",
        "Name": "cn-hangzhou"
      }
    ],
    "BornTimestamp": 1570761026630,
    "BodyCRC": 907060870,
    "BornHost": "42.120.**.**:64646",
    "BodyStr": "hello"
  }
}

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.