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

Consulta un mensaje específico de la cola de mensajes no entregados por su ID de mensaje. La información devuelta incluye la hora de almacenamiento, el cuerpo del mensaje, la clave y la etiqueta.

Descripción de la operación

Importante Alibaba Cloud OpenAPI es una API de gestión que se utiliza para administrar y consultar recursos de los servicios de Alibaba Cloud. Integre OpenAPI únicamente con fines de gestión. No utilice OpenAPI para enlaces de datos principales que envían y reciben mensajes, ya que esto puede introducir amenazas en los enlaces de datos.

La consulta de un mensaje de la cola de mensajes no entregados por su ID de mensaje es una consulta por término. Puede obtener el ID del mensaje desde el SendResult de una operación de envío exitosa o desde una llamada a la API de consulta por lotes. La consulta devuelve atributos del mensaje de la cola de mensajes no entregados, como su hora de almacenamiento, el cuerpo del mensaje, la clave y la etiqueta.

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

get

Group

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

Group

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

Ninguna

mq:OnsInstanceBaseInfo

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
MsgId	string	Sí	El ID del mensaje que se va a consultar. Este es el ID del mensaje.	0BC16699165C03B925DB8A404E2D****
GroupId	string	Sí	El ID de grupo del consumidor.	GID_test_group_id
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
RequestId	string	El ID de la solicitud. Este es un parámetro común. Cada solicitud tiene un ID único.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	Los resultados de la consulta.
StoreSize	integer	El tamaño del mensaje. Unidad: KB.	407
ReconsumeTimes	integer	El número de veces que se ha reintentado el mensaje.	1
StoreTimestamp	integer	La marca de tiempo cuando el mensaje se almacenó en el lado del servidor. Unidad: milisegundos.	1570761026708
InstanceId	string	El ID de la instancia.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	El ID del mensaje.	0BC16699165C03B925DB8A404E2D****
StoreHost	string	La instancia del servidor que almacena el mensaje.	11.220.*.*: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, consulte Términos.	TAGS
BornTimestamp	integer	La marca de tiempo cuando se generó el mensaje. Unidad: milisegundos.	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": "0BC16699165C03B925DB8A404E2D****",
    "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.