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

Consulta la información de un mensaje al especificar el ID del mensaje y determina si el mensaje se ha consumido.

Descripción de la operación

Nota

Las operaciones de API proporcionadas por Alibaba Cloud se utilizan para administrar y consultar recursos de los servicios de Alibaba Cloud. Se recomienda integrar estas operaciones de API únicamente en sistemas de administración. No utilice estas operaciones de API en el sistema principal de los servicios de mensajería. De lo contrario, pueden producirse riesgos en el sistema.

Si un mensaje no se consume como se esperaba, puede llamar a esta operación para consultar la información del mensaje con fines de solución de problemas.
Esta operación utiliza el método de coincidencia exacta para consultar un mensaje según el ID del mensaje. Puede obtener el ID del mensaje del parámetro SendResult que se devuelve después de enviar el mensaje. Debe almacenar la información devuelta después de cada envío de mensaje. La información consultada sobre un mensaje incluye el momento en que se envió el mensaje, el broker en el que se almacena el mensaje y los atributos del mensaje, como la clave y la etiqueta del mensaje.

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
MsgId	string	Sí	El ID del mensaje que desea consultar.	1E0578FE110F18B4AAC235C05F2*****
Topic	string	Sí	El tema que contiene el mensaje que desea consultar.	test-mq_topic
InstanceId	string	No	El ID de la instancia a la que pertenece el mensaje que desea consultar.	MQ_INST_111111111111_DOxxxxxx

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud. Este parámetro es un parámetro común. Cada solicitud tiene un ID único. Puede utilizar este ID para solucionar problemas.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	Los datos devueltos.
StoreSize	integer	El tamaño del mensaje.	407
ReconsumeTimes	integer	El número de reintentos realizados para enviar el mensaje a los consumidores.	1
StoreTimestamp	integer	La marca de tiempo que indica cuándo el broker de ApsaraMQ for RocketMQ almacenó el mensaje.	1570761026708
InstanceId	string	El ID de la instancia.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	El ID del mensaje.	1E0578FE110F18B4AAC235C0C8460BA2
StoreHost	string	El broker de ApsaraMQ for RocketMQ que almacena el mensaje.	11.220.*.*:10911
Topic	string	El tema al que pertenece el mensaje.	test-mq_topic
PropertyList	object
MessageProperty	array<object>	Los atributos del mensaje.
	object
Value	string	El valor del atributo.	TagA
Name	string	El nombre del atributo. Valores válidos: TRACE_ON: indica si existe un rastro del mensaje. KEYS: indica la clave del mensaje. TAGS: indica la etiqueta adjunta al mensaje. INSTANCE_ID: indica el ID de la instancia que contiene el mensaje. Para obtener información sobre los términos utilizados en Message Queue for Apache RocketMQ, consulte Términos.	TAGS
BornTimestamp	integer	La marca de tiempo que indica cuándo se produjo el mensaje.	1570761026630
BodyCRC	integer	El valor de verificación de redundancia cíclica (CRC) del cuerpo del mensaje.	914112295
BornHost	string	La instancia del productor que generó el mensaje.	42.120..:64646

Ejemplos

Respuesta exitosa

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 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.