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

Descripción de la operación

Importante

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

Puede utilizar esta operación para verificar el estado de consumo de un mensaje como solución de problemas preliminar cuando ocurre una excepción de consumo.
Esta operación se basa en el mecanismo de desplazamiento interno de ApsaraMQ for RocketMQ. Los resultados son confiables en la mayoría de los escenarios. Sin embargo, si restablece los desplazamientos o purga mensajes, los resultados pueden ser inexactos.

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

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.	test-mq_topic
MsgId	string	Sí	El ID del mensaje cuya traza desea consultar. Este es el ID del mensaje.	1E05791C117818B4AAC23B1BB0CE****
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. Utilice este ID para solucionar problemas.	EAE5BE23-37A1-4354-94D6-E44AE17E****
Data	object
MessageTrack	array<object>	Los resultados de la consulta.
	object
TrackType	string	El estado actual. Valores válidos: CONSUMED: El mensaje se consumió. CONSUMED_BUT_FILTERED: El mensaje se filtró y no se consumió porque no cumplía con las condiciones de suscripción del ID de grupo. NOT_CONSUME_YET: El mensaje aún no se ha consumido. NOT_ONLINE: El cliente está desconectado. UNKNOWN: Ocurrió un error desconocido.	CONSUMED
ConsumerGroup	string	El ID de grupo del consumidor que se suscribe al tema.	GID_test_group_id
InstanceId	string	El ID de la instancia a la que pertenece el mensaje.	MQ_INST_111111111111_DOxxxxxx

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "EAE5BE23-37A1-4354-94D6-E44AE17E****",
  "Data": {
    "MessageTrack": [
      {
        "TrackType": "CONSUMED",
        "ConsumerGroup": "GID_test_group_id",
        "InstanceId": "MQ_INST_111111111111_DOxxxxxx"
      }
    ]
  }
}

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.