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

Realiza uma consulta aproximada de uma lista de mensagens com base em um tópico e uma chave de mensagem.

Descrição da operação

Importante

A OpenAPI fornecida pela Alibaba Cloud é uma API de gerenciamento. Você pode usá-la para gerenciar e consultar recursos dos serviços da Alibaba Cloud. Recomendamos que você integre esta API apenas em links de dados de gerenciamento. Não use esta API para links de dados principais que enviam e recebem mensagens. Isso pode introduzir ameaças de segurança aos seus links de dados.

Esta operação realiza uma consulta aproximada de mensagens com base em uma chave de mensagem. Como uma chave de mensagem nem sempre é exclusiva, a consulta pode retornar várias mensagens.
Você pode usar esta operação quando não for possível obter um ID de mensagem. Nesse cenário, siga estas etapas:
1. Chame esta operação para realizar uma consulta aproximada e obter uma lista de IDs de mensagem.
2. Chame a operação OnsMessageGetByMsgId para realizar uma consulta exata. Para obter mais informações sobre a operação OnsMessageGetByMsgId, consulte OnsMessageGetByMsgId.

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
Topic	string	Sim	O tópico da mensagem a ser consultado.	test-mq_topic
Key	string	Sim	A chave da mensagem a ser consultada.	messageKey1
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	A resposta.
RequestId	string	Um parâmetro comum. O ID da solicitação é exclusivo e pode ser usado para solucionar e localizar problemas.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object
OnsRestMessageDo	array<object>	A lista de resultados da consulta.
	array<object>
StoreSize	integer	The size of the message.	406
ReconsumeTimes	integer	The number of times the message was reconsumed.	1
StoreTimestamp	integer	The timestamp indicating when the message was stored by the broker.	1570760999811
InstanceId	string	The instance ID.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	The message ID.	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	The server instance that stores the message.	11.193.*.*:10911
Topic	string	The topic of the message.	test-mq_topic
PropertyList	object
MessageProperty	array<object>	The list of message attributes.
	object
Value	string	The value of the message attribute.	TagA
Name	string	The message attribute. Valid values: TRACE_ON: indicates whether a message trace exists. KEYS: the key of the message. TAGS: the tag of the message. INSTANCE_ID: the ID of the instance to which the message belongs. For more information about the concepts, see Terms.	TAGS
BornTimestamp	integer	The timestamp indicating when the message was created.	1570760999721
BodyCRC	integer	The CRC checksum of the message body.	914112295
BornHost	string	The client instance that created the message.	42.120.*.*:59270

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****",
  "Data": {
    "OnsRestMessageDo": [
      {
        "StoreSize": 406,
        "ReconsumeTimes": 1,
        "StoreTimestamp": 1570760999811,
        "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
        "MsgId": "1E0578FE110F18B4AAC235C05F2*****",
        "StoreHost": "11.193.***.***:10911",
        "Topic": "test-mq_topic",
        "PropertyList": {
          "MessageProperty": [
            {
              "Value": "TagA",
              "Name": "TAGS"
            }
          ]
        },
        "BornTimestamp": 1570760999721,
        "BodyCRC": 914112295,
        "BornHost": "42.120.***.***:59270"
      }
    ]
  }
}

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.