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

Observação

Se uma mensagem não for consumida conforme o esperado, chame esta operação para consultar os dados da mensagem e solucionar o problema.
Use esta operação para consultar informações de uma mensagem pelo respectivo ID. Obtenha o ID da mensagem no parâmetro SendResult retornado após o envio. Armazene as informações retornadas sempre que enviar uma mensagem. A operação retorna dados como o momento de publicação da mensagem no broker do Message Queue for Apache RocketMQ, detalhes sobre o servidor do Message Queue for Apache RocketMQ onde a mensagem está armazenada e propriedades como chaves e tags da mensagem.

Limite de solicitações

Cada conta Alibaba Cloud pode chamar esta operação até 10 vezes por segundo. Se o número de solicitações enviadas dentro de um segundo atingir o limite, novas requisições falharão, o que pode interromper seus negócios. Para mais informações sobre os limites de cada operação, consulte Limites de solicitação de API.

Autorização

Contas Alibaba Cloud têm permissão padrão para chamar esta operação. Usuários do Resource Access Management (RAM) precisam receber as permissões necessárias antes de executá-la. A tabela a seguir descreve as permissões que devem ser concedidas a um usuário RAM para chamar esta operação. Para saber como conceder permissões, consulte Políticas.

API

Action

Recurso em uma instância com namespace

Recurso em uma instância sem namespace

OnsMessageGetByMsgId

mq:QueryInstanceBaseInfo

mq:QueryMessage

acs:mq:::{instanceId}%{topic}

acs:mq:::{topic}

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	OnsMessageGetByMsgId	A operação a ser executada. Defina o valor como OnsMessageGetByMsgId.
MsgId	String	Sim	1E0578FE110F18B4AAC235C05F2*	O ID da mensagem a ser consultada.
Topic	String	Sim	test-mq_topic	O tópico onde a mensagem a ser consultada está armazenada.
InstanceId	String	Sim	MQ_INST_111111111111_DOxxxxxx	O ID da instância do Message Queue for Apache RocketMQ que contém a mensagem a ser consultada.

Nota

Para mais informações sobre parâmetros de solicitação, consulte

Parâmetros comuns

e

Fazer solicitações de API

.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	A07E3902-B92E-44A6-B6C5-6AA111111****	O ID da solicitação. O sistema gera um ID exclusivo para cada solicitação. Use este ID para solucionar problemas.
Data	Object		Os dados retornados.
StoreSize	Integer	407	O tamanho da mensagem.
ReconsumeTimes	Integer	1	O número de tentativas do broker do Message Queue for Apache RocketMQ para enviar a mensagem aos consumidores.
StoreTimestamp	Long	1570761026708	O timestamp em que o broker do Message Queue for Apache RocketMQ armazenou a mensagem.
InstanceId	String	MQ_INST_111111111111_DOxxxxxx	O ID da instância do Message Queue for Apache RocketMQ que contém a mensagem.
MsgId	String	1E0578FE110F18B4AAC235C0C8460BA2	O ID da mensagem.
StoreHost	String	11.220.*.*:10911	O servidor do Message Queue for Apache RocketMQ que armazena a mensagem.
Topic	String	test-mq_topic	O tópico onde a mensagem está armazenada.
PropertyList	Array of MessageProperty		As propriedades da mensagem.
MessageProperty
Value	String	TagA	O valor da propriedade.
Name	String	TAGS	O nome da propriedade. Valores válidos: TRACE_ON: indica se existe um rastro da mensagem. KEYS: indica a chave da mensagem. TAGS: indica a propriedade de tag da mensagem. INSTANCE_ID: indica o ID da instância que contém a mensagem. Para mais informações sobre os termos usados no Message Queue for Apache RocketMQ, consulte Termos.
BornTimestamp	Long	1570761026630	O timestamp em que a mensagem foi produzida.
BodyCRC	Integer	914112295	O valor de verificação de redundância cíclica (CRC) do corpo da mensagem.
BornHost	String	42.120..:64646	O cliente produtor que gerou a mensagem.

Exemplos

Exemplos de solicitações

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsMessageGetByMsgId
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&MsgId=1E0578FE110F18B4AAC235C05F2*****
&Topic=test-mq_topic
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

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

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

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

Códigos de erro

Para obter uma lista de códigos de erro, visite a Central de Erros de API.

Consultar informações de uma mensagem no console

No Message Queue for Apache RocketMQ console, é possível consultar as informações de uma mensagem. Para mais detalhes, consulte Consultar uma mensagem.