OnsTraceGetResult - - Centro de documentación de Alibaba Cloud

Consulta los detalles de una traza de mensajes a partir de un ID de tarea de consulta específico.

Notas de uso

Antes de llamar a esta operación para consultar los detalles de la traza de un mensaje, debe crear una tarea de consulta de traza basada en el ID o la clave del mensaje y obtener el ID de la tarea. Posteriormente, invoque esta operación para consultar los detalles de la traza mediante dicho ID. Para crear la tarea y obtener el identificador en el parámetro de respuesta QueryId, utilice la operación OnsTraceQueryByMsgId o bien la operación OnsTraceQueryByMsgKey.
Las tareas de consulta de traza requieren tiempo de procesamiento. Si invoca esta operación inmediatamente después de crear la tarea, es posible que los resultados estén vacíos. En este caso, se recomienda intentar la consulta nuevamente más tarde.

Límite de solicitudes

Cada cuenta de Alibaba Cloud puede llamar a esta operación hasta 10 veces por segundo. Si el número de solicitudes enviadas en un segundo alcanza este límite, las nuevas solicitudes fallarán, lo cual podría interrumpir su servicio. Para obtener información sobre los límites de cada operación, consulte Límites de velocidad de API.

Autorización

De forma predeterminada, solo las cuentas de Alibaba Cloud pueden llamar a esta operación. Un usuario de Resource Access Management (RAM) requiere los permisos correspondientes para invocarla. La siguiente tabla describe los permisos que se deben otorgar al usuario de RAM. Para más información sobre cómo conceder permisos, consulte Directivas y ejemplos.

API	Action	Resource
OnsTraceGetResult	mq:QueryInstanceBaseInfo	acs:mq:::{instanceId}

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	OnsTraceGetResult	La operación que desea ejecutar. Establezca el valor como OnsTraceGetResult.
QueryId	String	Sí	272967562652883649157096685****	El ID de la tarea creada para consultar la traza del mensaje.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	84EE24D2-851F-40D6-B99E-4D6AB909****	El ID de la solicitud. El sistema genera un identificador único para cada petición, el cual sirve para solucionar problemas.
TraceData	Object		Los detalles de la traza del mensaje.
Status	String	finish	El estado de la tarea. Valores válidos: finish: La tarea ha finalizado. working: La tarea está en curso. removed: La tarea se eliminó.
MsgKey	String	ORDERID_100	La clave del mensaje consultado.
UpdateTime	Long	1570966877000	La marca de tiempo de la última actualización de la tarea.
CreateTime	Long	1570966857000	La marca de tiempo de creación de la tarea.
Topic	String	test	El tema donde se almacena el mensaje.
UserId	String	27296756265288****	El ID del usuario que creó la tarea.
InstanceId	String	MQ_INST_111111111111_DOxxxxxx	El ID de la instancia que contiene el mensaje.
MsgId	String	1E05791C117818B4AAC23B1BB0CE****	El ID del mensaje consultado.
TraceList	Array of TraceMapDo		Los detalles de la traza del mensaje.
TraceMapDo
Status	String	SEND_SUCCESS	Indica si el mensaje se envió correctamente. Valores válidos: SEND_SUCCESS: El mensaje se envió. SEND_FAILED: El envío del mensaje falló. SEND_ROLLBACK: Es un mensaje transaccional y se revirtió. SEND_UNKNOWN: Es un mensaje transaccional y no se confirmó. SEND_DELAY: Es un mensaje programado o diferido que espera ser enviado en el momento especificado.
MsgKey	String	ORDERID_100	La clave del mensaje.
PubTime	Long	1570850870478	La marca de tiempo de envío del mensaje.
SubList	Array of SubMapDo		Las trazas de consumo del mensaje.
SubMapDo
ClientList	Array of SubClientInfoDo		Información sobre el consumo del mensaje por parte de los consumidores del grupo.
SubClientInfoDo
Status	String	CONSUME_SUCCESS	Indica si el mensaje se consumió correctamente. Valores válidos: CONSUME_FAILED: El consumo del mensaje falló. CONSUME_SUCCESS: El mensaje se consumió. CONSUME_NOT_RETURN: No se devolvió ninguna respuesta. SEND_UNKNOWN: Es un mensaje transaccional y no se confirmó. SEND_DELAY: Es un mensaje programado o diferido que espera ser consumido en el momento especificado.
SubTime	Long	1570851590511	La primera marca de tiempo en la que se consumió el mensaje.
ReconsumeTimes	Integer	1	El número de intentos del broker de Message Queue for Apache RocketMQ para entregar el mensaje al consumidor.
SubGroupName	String	GID_test	El ID del grupo al que pertenece el consumidor.
ClientHost	String	30.5..	La dirección del consumidor.
CostTime	Integer	43	El tiempo que tomó consumir el mensaje. Unidad: milisegundos.
FailCount	Integer	0	El número de errores de consumo.
SubGroupName	String	GID_test	El ID del grupo de consumidores.
SuccessCount	Integer	1	El número de consumos exitosos.
Topic	String	test	El tema donde se almacena el mensaje.
CostTime	Integer	24	El tiempo que tomó enviar el mensaje. Unidad: milisegundos.
Tag	String	TagA	La etiqueta del mensaje.
MsgId	String	0BC1F01800002A9F000000531246****	El ID del mensaje.
PubGroupName	String	GID_test	El ID del grupo al que pertenece el productor.
BornHost	String	30.5..	La dirección del productor que generó el mensaje.
QueryId	String	272967562652883649157096685****	El ID de la tarea.

Ejemplos

Solicitudes de ejemplo

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsTraceGetResult
&QueryId=272967562652883649157096685****
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsTraceGetResultResponse>
<TraceData>
    <MsgId>1E05791C117818B4AAC23B1BB0CE****</MsgId>
    <Status>finish</Status>
    <TraceList>
        <TraceMapDo>
            <BornHost>30.5.**.**</BornHost>
            <MsgId>0BC1F01800002A9F000000531246****</MsgId>
            <Status>SEND_SUCCESS</Status>
            <CostTime>24</CostTime>
            <PubTime>1570850870478</PubTime>
            <Tag>TagA</Tag>
            <Topic>test</Topic>
            <MsgKey>ORDERID_100</MsgKey>
            <PubGroupName>GID_test</PubGroupName>
            <SubList>
                <SubMapDo>
                    <ClientList>
                        <SubClientInfoDo>
                            <Status>CONSUME_SUCCESS</Status>
                            <CostTime>43</CostTime>
                            <ClientHost>30.5.**.**</ClientHost>
                            <ReconsumeTimes>1</ReconsumeTimes>
                            <SubTime>1570851590511</SubTime>
                            <SubGroupName>GID_test</SubGroupName>
                        </SubClientInfoDo>
                    </ClientList>
                    <SuccessCount>1</SuccessCount>
                    <FailCount>0</FailCount>
                    <SubGroupName>GID_test</SubGroupName>
                </SubMapDo>
            </SubList>
        </TraceMapDo>
    </TraceList>
    <CreateTime>1570966857000</CreateTime>
    <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>
    <Topic>test</Topic>
    <UpdateTime>1570966877000</UpdateTime>
    <QueryId>272967562652883649157096685****</QueryId>
    <UserId>27296756265288****</UserId>
</TraceData>
<RequestId>84EE24D2-851F-40D6-B99E-4D6AB909****</RequestId>
</OnsTraceGetResultResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

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

Códigos de error

Para consultar la lista de códigos de error, visite el Centro de errores de API.

Consulta de la traza de un mensaje en la consola

También puede consultar la traza de un mensaje desde la consola de Message Queue for Apache RocketMQ. Para obtener más información, consulte Consulta de una traza de mensajes.