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

Obtiene los resultados de una tarea de consulta de rastreo de mensajes mediante su ID de tarea.

Descripción de la operación

Importante

La OpenAPI de Alibaba Cloud es una API de gestión. Úsela para gestionar y consultar recursos de los servicios de Alibaba Cloud. Integre esta API únicamente con fines de gestión. No utilice esta API en el enlace de datos principal para enviar y recibir mensajes, ya que esto puede generar amenazas para su enlace de datos.

Después de crear una tarea de consulta de rastreo de mensajes mediante la operación OnsTraceQueryByMsgId o OnsTraceQueryByMsgKey, recibe un ID de tarea. A continuación, puede llamar a esta operación para obtener los detalles del rastreo del mensaje. El ID de la tarea es el QueryId que devuelve la operación de creación.
Las tareas de consulta de rastreo de mensajes requieren tiempo. Si llama a esta operación inmediatamente después de crear una tarea, la consulta puede devolver un resultado vacío. Si esto ocurre, espere un breve periodo y vuelva a intentar la llamada.

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

get

*Topic

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

*Topic

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

Ninguna

mq:QueryInstanceBaseInfo

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
QueryId	string	Sí	El ID de la tarea para la cual se deben obtener los resultados de la consulta de rastreo de mensajes.	272967562652883649157096685****
InstanceId	string	No	El ID de la instancia que contiene el mensaje que desea consultar.	MQ_INST_111111111111_DOxxxxxx
Topic	string	No	El tema del mensaje que desea consultar.	test

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.	84EE24D2-851F-40D6-B99E-4D6AB909****
TraceData	object	Los detalles de los resultados de la tarea de consulta.
Status	string	El resultado de la tarea de consulta. Valores válidos: finish: La consulta ha finalizado. working: La consulta está en curso. removed: La tarea se ha eliminado.	finish
MsgKey	string	La clave del mensaje correspondiente a la tarea de consulta.	ORDERID_100
UpdateTime	integer	La hora de la última actualización de la tarea de consulta.	1570966877000
CreateTime	integer	La hora de creación de la tarea de consulta.	1570966857000
Topic	string	El tema de la tarea de consulta.	test
UserId	string	El ID del usuario que inició la consulta.	27296756265288****
InstanceId	string	El ID de la instancia.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	El ID del mensaje correspondiente a la tarea de consulta.	1E05791C117818B4AAC23B1BB0CE****
TraceList	object
TraceMapDo	array<object>	La lista de rastreos de mensajes coincidentes para la tarea de consulta.
	array<object>
Status	string	El estado de envío. Valores válidos: SEND_SUCCESS: El mensaje se envió correctamente. SEND_FAILED: Error al enviar el mensaje. SEND_ROLLBACK: Se revirtió el mensaje transaccional. SEND_UNKNOWN: No se confirmó el mensaje transaccional. SEND_DELAY: El mensaje programado o retrasado está en espera de ser enviado.	SEND_SUCCESS
MsgKey	string	La clave del mensaje.	ORDERID_100
PubTime	integer	La hora en que se envió el mensaje.	1570850870478
SubList	object
SubMapDo	array<object>	La lista de rastreos de consumo del mensaje.
	array<object>
ClientList	object
SubClientInfoDo	array<object>	La lista de registros de consumo del cliente que pertenece al ID de grupo.
	object
Status	string	The consumption status. Valid values: CONSUME_FAILED: The message failed to be consumed. CONSUME_SUCCESS: The message was consumed successfully. CONSUME_NOT_RETURN: The consumption result was not returned. SEND_UNKNOWN: The transactional message was not committed. SEND_DELAY: The scheduled or delayed message is waiting to be sent.	CONSUME_SUCCESS
SubTime	integer	The UNIX timestamp for when the consumption started.	1570851590511
ReconsumeTimes	integer	The number of delivery attempts for this consumption.	1
SubGroupName	string	The group ID to which the client belongs.	GID_test
ClientHost	string	The address of the consumer client.	30.5..
CostTime	integer	The time taken for this consumption, in milliseconds.	43
FailCount	integer	El número de fallos de consumo para el ID de grupo.	0
SubGroupName	string	El ID de grupo del consumidor.	GID_test
SuccessCount	integer	El número de consumos exitosos para el ID de grupo.	1
Topic	string	El tema del mensaje.	test
CostTime	integer	El tiempo empleado en enviar el mensaje, en milisegundos.	24
Tag	string	La etiqueta del mensaje.	TagA
MsgId	string	El ID del mensaje.	0BC1F01800002A9F000000531246****
PubGroupName	string	El ID de grupo configurado en el cliente productor.	GID_test
BornHost	string	La dirección del cliente productor.	30.5..
QueryId	string	El ID de la tarea de consulta.	272967562652883649157096685****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "84EE24D2-851F-40D6-B99E-4D6AB909****",
  "TraceData": {
    "Status": "finish",
    "MsgKey": "ORDERID_100",
    "UpdateTime": 1570966877000,
    "CreateTime": 1570966857000,
    "Topic": "test",
    "UserId": "27296756265288****",
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "MsgId": "1E05791C117818B4AAC23B1BB0CE****",
    "TraceList": {
      "TraceMapDo": [
        {
          "Status": "SEND_SUCCESS",
          "MsgKey": "ORDERID_100",
          "PubTime": 1570850870478,
          "SubList": {
            "SubMapDo": [
              {
                "ClientList": {
                  "SubClientInfoDo": [
                    {
                      "Status": "CONSUME_SUCCESS",
                      "SubTime": 1570851590511,
                      "ReconsumeTimes": 1,
                      "SubGroupName": "GID_test",
                      "ClientHost": "30.5.**.**",
                      "CostTime": 43
                    }
                  ]
                },
                "FailCount": 0,
                "SubGroupName": "GID_test",
                "SuccessCount": 1
              }
            ]
          },
          "Topic": "test",
          "CostTime": 24,
          "Tag": "TagA",
          "MsgId": "0BC1F01800002A9F000000531246****",
          "PubGroupName": "GID_test",
          "BornHost": "30.5.**.**"
        }
      ]
    },
    "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.