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

Obtém o rastreamento de uma mensagem especificada em um tópico especificado.

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

rocketmq:GetTrace

get

*Tópico.

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}

Nenhuma

Sintaxe da solicitação

GET /instances/{instanceId}/topics/{topicName}/traces/{messageId} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância a ser consultada.	rmq-cn-zvp2vtypu05
topicName	string	Sim	O nome do tópico a ser consultado.	linkedcare-image
messageId	string	Sim	O ID da mensagem.	012A5AB0BBEC8A000104C6342B00001ECF

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
startTime	string	Não	A hora de início, no formato AAAA-MM-DD HH:mm:ss.	2023-05-10 10:42:11
endTime	string	Não	A hora de término, no formato AAAA-MM-DD HH:mm:ss.	2024-09-09 09:00:00

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Resultado.
requestId	string	O ID da solicitação. Cada solicitação possui um ID exclusivo que você pode usar para solucionar problemas.	7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49
success	boolean	Indica se a solicitação foi bem-sucedida.	true
data	object	O resultado retornado.
regionId	string	O ID da região.	cn-hangzhou
instanceId	string	O ID da instância.	rmq-cn-7e22ody****
topicName	string	O nome do tópico.	topic_test
messageInfo	object	As informações da mensagem.
regionId	string	O ID da região.	cn-beijing
instanceId	string	O ID da instância.	rmq-cn-u0t2ygjq505
topicName	string	O nome do tópico.	Topic_normal_inspector
messageId	string	O ID da mensagem.	0A79275A00207A4F0F2916C92F9A0B94
bornTime	string	A hora em que a mensagem foi gerada, no formato AAAA-MM-DD HH:mm:ss.	2023-03-22 12:17:08
storeTime	string	A hora em que a mensagem foi armazenada no broker, no formato AAAA-MM-DD HH:mm:ss.	2023-03-22 12:17:08
body	string	O corpo da mensagem.	{}
bornHost	string	A origem da mensagem.	x.x.x.x
storeHost	string	O endereço do broker onde a mensagem está armazenada.	x.x.x.x
messageType	string	O tipo de mensagem.	NORMAL
messageTag	string	A lista de tags.	xx
messageGroup	string	A chave de fragmentação. Este campo é exclusivo para mensagens ordenadas.	xx
messageKeys	array	A chave da mensagem.
	string	A chave da mensagem.	xx
userProperties	object	As propriedades do usuário.
	string	As propriedades do usuário.	xx
transactionId	string	O ID da transação.	xx
liteTopicName	string	O nome do tópico lite.	abc
producerInfo	object	As informações de rastreamento de mensagem do produtor.
records	array<object>	A lista de registros do produtor.
	object	A lista de registros do produtor.
userName	string	O nome do produtor.	xxx
clientHost	string	O nome do host.	xx.xx.xx.xx
produceTime	string	A hora em que a mensagem foi enviada, no formato AAAA-MM-DD HH:mm:ss.	2023-03-22 12:17:08
produceDuration	integer	O tempo necessário para enviar a mensagem.	100
produceStatus	string	O status de envio.	SUCCESS
arriveTime	string	A hora em que a mensagem chegou, no formato AAAA-MM-DD HH:mm:ss.	2023-03-22 12:17:08
messageSource	string	A fonte da mensagem.	CONSOLE
dlqOriginTopic	string	O tópico da fila de mensagens mortas.	test_topic
dlqOriginMessageId	string	O ID da mensagem da fila de mensagens mortas.	0A79275A00207A4F0F2916C92F9A0B94
recallTime	string	A hora em que a solicitação de recall foi iniciada. Este campo não está vazio quando messageSource é "recall".	2023-03-22 12:17:08
brokerInfo	object	As informações de rastreamento de mensagem do broker.
presetDelayTime	string	A hora de entrega predefinida, no formato AAAA-MM-DD HH:mm:ss.	2023-03-22 12:17:08
delayStatus	string	O status da mensagem agendada.	SUCCESS
operations	array<object>	A lista de operações.
	object	A lista de operações.
operateType	string	O tipo de operação.	ADD
operateTime	string	A hora da operação, no formato AAAA-MM-DD HH:mm:ss.	2023-03-22 12:17:08
recallResult	string	O resultado do recall. Este campo não está vazio quando existe um registro de recall.	RECALL_OK \| RECALL_FAIL
consumerInfos	array<object>	As informações de rastreamento de mensagem do consumidor.
	array<object>	As informações de rastreamento de mensagem do consumidor.
consumerGroupId	string	O ID do grupo de consumidores.	GID_inspector_group
records	array<object>	A lista de registros de consumo.
	array<object>	A lista de registros de consumo.
userName	string	O nome do consumidor.	test
clientHost	string	O nome do host.	xx.xx.xx.xx
fifoEnable	boolean	Indica se o consumo ordenado está ativado.	true
consumeStatus	string	O status de consumo.	SUCCESS
operations	array<object>	A lista de operações.
	object	A lista de operações.
operateType	string	O tipo de operação.	ADD
operateTime	string	A hora da operação, no formato AAAA-MM-DD HH:mm:ss.	2023-03-22 12:17:08
invisibleTime	integer	O tempo de invisibilidade, em milissegundos.	100
deadMessage	boolean	Indica se a mensagem é uma mensagem morta.	true
popCk	string	POP_CK.	123
consumeStatus	string	O status de consumo.	SUCCESS
deadMessage	boolean	Indica se a mensagem é uma mensagem morta.	true
deadLetterInfo	object	As informações da mensagem morta.
topicName	string	O nome do tópico.	Register_Sync
messageId	string	O ID da mensagem.	7F000001001F7A4F0F29463F0376047D
toDlqTime	string	A hora em que a mensagem chegou à fila de mensagens mortas, no formato AAAA-MM-DD HH:mm:ss.	2023-03-22 12:17:08
code	string	O código de erro.	InvalidConsumerGroupId
message	string	A mensagem de erro.	A instância não pode ser encontrada
httpStatusCode	integer	O código de status HTTP.	200
dynamicCode	string	O código de erro dinâmico.	InstanceId
dynamicMessage	string	A mensagem de erro dinâmico.	instanceId

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "topicName": "topic_test",
    "messageInfo": {
      "regionId": "cn-beijing",
      "instanceId": "rmq-cn-u0t2ygjq505",
      "topicName": "Topic_normal_inspector",
      "messageId": "0A79275A00207A4F0F2916C92F9A0B94",
      "bornTime": "2023-03-22 12:17:08",
      "storeTime": "2023-03-22 12:17:08",
      "body": "{}",
      "bornHost": "x.x.x.x",
      "storeHost": "x.x.x.x",
      "messageType": "NORMAL",
      "messageTag": "xx",
      "messageGroup": "xx",
      "messageKeys": [
        "xx"
      ],
      "userProperties": {
        "key": "xx"
      },
      "transactionId": "xx",
      "liteTopicName": "abc"
    },
    "producerInfo": {
      "records": [
        {
          "userName": "xxx",
          "clientHost": "xx.xx.xx.xx",
          "produceTime": "2023-03-22 12:17:08",
          "produceDuration": 100,
          "produceStatus": "SUCCESS",
          "arriveTime": "2023-03-22 12:17:08",
          "messageSource": "CONSOLE",
          "dlqOriginTopic": "test_topic",
          "dlqOriginMessageId": "0A79275A00207A4F0F2916C92F9A0B94",
          "recallTime": "2023-03-22 12:17:08"
        }
      ]
    },
    "brokerInfo": {
      "presetDelayTime": "2023-03-22 12:17:08",
      "delayStatus": "SUCCESS",
      "operations": [
        {
          "operateType": "ADD",
          "operateTime": "2023-03-22 12:17:08"
        }
      ],
      "recallResult": "RECALL_OK | RECALL_FAIL"
    },
    "consumerInfos": [
      {
        "consumerGroupId": "GID_inspector_group",
        "records": [
          {
            "userName": "test",
            "clientHost": "xx.xx.xx.xx",
            "fifoEnable": true,
            "consumeStatus": "SUCCESS",
            "operations": [
              {
                "operateType": "ADD",
                "operateTime": "2023-03-22 12:17:08",
                "invisibleTime": 100,
                "deadMessage": true
              }
            ],
            "popCk": "123"
          }
        ],
        "consumeStatus": "SUCCESS",
        "deadMessage": true,
        "deadLetterInfo": {
          "topicName": "Register_Sync",
          "messageId": "7F000001001F7A4F0F29463F0376047D",
          "toDlqTime": "2023-03-22 12:17:08"
        }
      }
    ]
  },
  "code": "InvalidConsumerGroupId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

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.