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

Puede llamar a OnsMessageDetail para consultar los detalles de un mensaje específico.

Descripción de la operación

Importante

Alibaba Cloud OpenAPI es una API del plano de control. Puede utilizarla para administrar y consultar recursos de servicios de Alibaba Cloud. No utilice OpenAPI para enlaces de datos principales que envían y reciben mensajes, ya que esto puede generar amenazas para sus enlaces de datos.

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

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
InstanceId	string	Sí	El ID de la instancia de ApsaraMQ for RocketMQ.	MQ_INST_184681981******_BXig0x6A
Topic	string	Sí	El tema del mensaje que se va a consultar.	test-mq_topic
MsgId	string	Sí	El ID del mensaje que se va a consultar. Este es el ID del mensaje.	1E0578FE110F18B4AAC235C0******

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	Un parámetro común. El ID de la solicitud. Cada solicitud tiene un ID único. Utilice este ID para solucionar problemas.	EAE5BE23-37A1-4354-94D6-E44AE17E****
Data	object	El resultado de la consulta.
StoreSize	integer	El tamaño del mensaje. Unidad: KB.	2
ReconsumeTimes	integer	El número de veces que se reintenta el consumo del mensaje.	0
StoreTimestamp	integer	La marca de tiempo UNIX cuando el mensaje se almacenó en el lado del servidor. Unidad: milisegundos.	1570761026708
Body	string	El cuerpo del mensaje, que es una cadena codificada en Base64.	aGVsbG8=
InstanceId	string	El ID de la instancia de ApsaraMQ for RocketMQ.	MQ_INST_184681981******_BXig0x6A
MsgId	string	El ID del mensaje.	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	La instancia del servidor donde se almacena el mensaje.	11.220.*.*:10911
Topic	string	El tema al que pertenece el mensaje.	test-mq_topic
PropertyList	array<object>	La lista de atributos del mensaje.
	object
Value	string	El valor del atributo del mensaje.	MSG_REGION
Name	string	El atributo del mensaje. Valores válidos: TRACE_ON: Indica si existe un rastro de mensaje. MSG_REGION: El ID de la región de la instancia que contiene el tema del mensaje. __MESSAGE_DECODED_TIME: La hora en que se decodificó el mensaje. __BORNHOST: La dirección IP del cliente productor. UNIQ_KEY: El identificador único del mensaje. Este es el ID del mensaje. Para obtener más información, consulte Términos.	cn-hangzhou
BornTimestamp	integer	La marca de tiempo UNIX cuando se generó el mensaje. Unidad: milisegundos.	1570761026630
BodyCRC	integer	El valor de verificación de redundancia cíclica (CRC) del cuerpo del mensaje.	907060870
BornHost	string	La instancia del cliente que generó el mensaje.	42.120..:64646
BodyStr	string	El contenido del cuerpo del mensaje.	hello

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "EAE5BE23-37A1-4354-94D6-E44AE17E****",
  "Data": {
    "StoreSize": 2,
    "ReconsumeTimes": 0,
    "StoreTimestamp": 1570761026708,
    "Body": "aGVsbG8=",
    "InstanceId": "MQ_INST_184681981******_BXig0x6A",
    "MsgId": "1E0578FE110F18B4AAC235C05F2*****",
    "StoreHost": "11.220.***.***:10911",
    "Topic": "test-mq_topic",
    "PropertyList": [
      {
        "Value": "MSG_REGION",
        "Name": "cn-hangzhou"
      }
    ],
    "BornTimestamp": 1570761026630,
    "BodyCRC": 907060870,
    "BornHost": "42.120.**.**:64646",
    "BodyStr": "hello"
  }
}

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.