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

Crea una tarea de consulta de traza basada en un nombre de tema y una clave de mensaje, y devuelve el ID de la tarea de consulta. A continuación, debe llamar a la operación OnsTraceGetResult y pasar el ID de la tarea de consulta devuelto para obtener los resultados detallados de la traza del mensaje.

Descripción de la operación

Importante

La OpenAPI proporcionada por Alibaba Cloud es una API del plano de control que se utiliza para administrar y consultar recursos de los servicios de Alibaba Cloud. Utilice esta API únicamente para la integración del plano de control. No utilice OpenAPI en el enlace de datos principal para enviar o recibir mensajes. De lo contrario, esto podría introducir amenazas en el enlace 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:QueryTrace

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
MsgKey	string	Sí	La clave del mensaje que se va a consultar.	ORDERID_100
BeginTime	integer	Sí	El inicio del intervalo de tiempo que se va a consultar. El valor es una marca de tiempo UNIX en milisegundos.	1570852800000
EndTime	integer	Sí	El fin del intervalo de tiempo que se va a consultar. El valor es una marca de tiempo UNIX en milisegundos.	1570968000000
InstanceId	string	No	El ID de la instancia a la que pertenece el tema del 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 que puede utilizar para solucionar problemas y localizar incidencias.	F8654231-122A-4DBD-801F-38E35538****
QueryId	string	El ID de la tarea de consulta. Debe llamar a la operación OnsTraceGetResult con este ID de tarea para obtener los resultados detallados.	272967562652883649157096685****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "F8654231-122A-4DBD-801F-38E35538****",
  "QueryId": "272967562652883649157096685****"
}

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.