OnsMessageGetByKey - ApsaraMQ for RocketMQ - Centro de documentación de Alibaba Cloud

Realiza una consulta difusa para obtener una lista de mensajes basada en un tema y una clave de mensaje.

Descripción de la operación

Importante

La OpenAPI proporcionada por Alibaba Cloud es una API de gestión. Puede utilizarla para gestionar y consultar recursos de los servicios de Alibaba Cloud. Se recomienda integrar esta API únicamente en enlaces de datos de gestión. No utilice esta API para enlaces de datos principales que envían y reciben mensajes, ya que esto puede introducir amenazas de seguridad en sus enlaces de datos.

Esta operación realiza una consulta difusa de mensajes basada en una clave de mensaje. Dado que la clave de mensaje no siempre es única, la consulta puede devolver varios mensajes.
Puede utilizar esta operación cuando no pueda obtener un ID de mensaje. En este escenario, siga estos pasos:
1. Llame a esta operación para realizar una consulta difusa y obtener una lista de ID de mensajes.
2. Llame a la operación OnsMessageGetByMsgId para realizar una consulta exacta. Para obtener más información sobre la operación OnsMessageGetByMsgId, consulte OnsMessageGetByMsgId.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

mq:QueryMessage

get

Topic

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

Topic

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

Ninguna

mq:OnsInstanceBaseInfo

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Topic	string	Sí	El tema del mensaje que se va a consultar.	test-mq_topic
Key	string	Sí	La clave del mensaje que se va a consultar.	messageKey1
InstanceId	string	No	El ID de la instancia a la que pertenece el mensaje.	MQ_INST_111111111111_DOxxxxxx

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La respuesta.
RequestId	string	Un parámetro común. El ID de la solicitud es único y se puede utilizar para solucionar problemas y localizar incidencias.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object
OnsRestMessageDo	array<object>	La lista de resultados de la consulta.
	array<object>
StoreSize	integer	El tamaño del mensaje.	406
ReconsumeTimes	integer	El número de veces que se volvió a consumir el mensaje.	1
StoreTimestamp	integer	La marca de tiempo que indica cuándo almacenó el mensaje el broker.	1570760999811
InstanceId	string	El ID de la instancia.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	El ID del mensaje.	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	La instancia de servidor que almacena el mensaje.	11.193.*.*:10911
Topic	string	El tema del mensaje.	test-mq_topic
PropertyList	object
MessageProperty	array<object>	La lista de atributos del mensaje.
	object
Value	string	El valor del atributo del mensaje.	TagA
Name	string	El atributo del mensaje. Valores válidos: TRACE_ON: indica si existe un rastro de mensaje. KEYS: la clave del mensaje. TAGS: la etiqueta del mensaje. INSTANCE_ID: el ID de la instancia a la que pertenece el mensaje. Para obtener más información sobre los conceptos, consulte Términos.	TAGS
BornTimestamp	integer	La marca de tiempo que indica cuándo se creó el mensaje.	1570760999721
BodyCRC	integer	La suma de comprobación CRC del cuerpo del mensaje.	914112295
BornHost	string	La instancia cliente que creó el mensaje.	42.120.*.*:59270

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.