OnsTraceGetResult - ApsaraMQ for RocketMQ: Central de Documentação do Alibaba Cloud

Obtém os resultados de uma tarefa de consulta de rastreamento de mensagens usando o ID da tarefa.

Descrição da operação

Importante

A OpenAPI do Alibaba Cloud é uma API de gerenciamento. Use-a para gerenciar e consultar recursos dos serviços do Alibaba Cloud. Integre esta API apenas para fins de gerenciamento. Não use esta API no link de dados principal para envio e recebimento de mensagens, pois isso pode criar ameaças ao seu link de dados.

Após criar uma tarefa de consulta de rastreamento de mensagens chamando a operação OnsTraceQueryByMsgId ou OnsTraceQueryByMsgKey, você recebe um ID de tarefa. Em seguida, você pode chamar esta operação para obter os detalhes do rastreamento da mensagem. O ID da tarefa é o QueryId retornado pela operação de criação.
As tarefas de consulta de rastreamento de mensagens consomem tempo. Se você chamar esta operação imediatamente após criar uma tarefa, a consulta poderá retornar um resultado vazio. Se isso ocorrer, aguarde um curto período e tente chamar novamente.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

mq:GetTraceResult

get

*Topic

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

*Topic

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

Nenhuma

mq:QueryInstanceBaseInfo

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
QueryId	string	Sim	O ID da tarefa para a qual obter os resultados da consulta de rastreamento de mensagens.	272967562652883649157096685****
InstanceId	string	Não	O ID da instância que contém a mensagem que você deseja consultar.	MQ_INST_111111111111_DOxxxxxx
Topic	string	Não	O tópico da mensagem que você deseja consultar.	test

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação. Este é um parâmetro comum. Cada solicitação tem um ID exclusivo que você pode usar para solucionar problemas.	84EE24D2-851F-40D6-B99E-4D6AB909****
TraceData	object	Os detalhes dos resultados da tarefa de consulta.
Status	string	O resultado da tarefa de consulta. Valores válidos: finish: A consulta foi concluída. working: A consulta está em andamento. removed: A tarefa foi excluída.	finish
MsgKey	string	A chave da mensagem que corresponde à tarefa de consulta.	ORDERID_100
UpdateTime	integer	A hora da última atualização da tarefa de consulta.	1570966877000
CreateTime	integer	A hora de criação da tarefa de consulta.	1570966857000
Topic	string	O tópico da tarefa de consulta.	test
UserId	string	O ID do usuário que iniciou a consulta.	27296756265288****
InstanceId	string	O ID da instância.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	O ID da mensagem que corresponde à tarefa de consulta.	1E05791C117818B4AAC23B1BB0CE****
TraceList	object
TraceMapDo	array<object>	The list of matched message traces for the query task.
	array<object>
Status	string	The sending status. Valid values: SEND_SUCCESS: The message was sent successfully. SEND_FAILED: The message failed to be sent. SEND_ROLLBACK: The transactional message was rolled back. SEND_UNKNOWN: The transactional message was not committed. SEND_DELAY: The scheduled or delayed message is waiting to be sent.	SEND_SUCCESS
MsgKey	string	The message key.	ORDERID_100
PubTime	integer	The time when the message was sent.	1570850870478
SubList	object
SubMapDo	array<object>	The list of consumption traces for the message.
	array<object>
ClientList	object
SubClientInfoDo	array<object>	The list of consumption records for the client that belongs to the group ID.
	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	The number of consumption failures for the group ID.	0
SubGroupName	string	The group ID of the consumer.	GID_test
SuccessCount	integer	The number of successful consumptions for the group ID.	1
Topic	string	The topic of the message.	test
CostTime	integer	The time taken to send the message, in milliseconds.	24
Tag	string	The message tag.	TagA
MsgId	string	The message ID.	0BC1F01800002A9F000000531246****
PubGroupName	string	The group ID configured on the producer client.	GID_test
BornHost	string	The address of the producer client.	30.5..
QueryId	string	O ID da tarefa de consulta.	272967562652883649157096685****

Exemplos

Resposta de sucesso

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 erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.