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

*Topic

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.	2023-05-10 10:42:11
endTime	string	Não	A hora de término.	2024-09-09 09:00:00

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
requestId	string	O ID da solicitação. Cada solicitação tem um ID exclusivo. Você pode usar esse ID para solucionar problemas.	7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49
success	boolean	Indica se a solicitação foi bem-sucedida.	true
data	object	Os dados retornados.
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	The region ID.	cn-beijing
instanceId	string	The instance ID.	rmq-cn-u0t2ygjq505
topicName	string	The topic name.	Topic_normal_inspector
messageId	string	The message ID.	0A79275A00207A4F0F2916C92F9A0B94
bornTime	string	The time when the message was generated.	2023-03-22 12:17:08
storeTime	string	The time when the message was stored.	2023-03-22 12:17:08
body	string	The message body.	{}
bornHost	string	The source of the message.	x.x.x.x
storeHost	string	The location where the message is stored.	x.x.x.x
messageType	string	The message type.	NORMAL
messageTag	string	The list of tags.	xx
messageGroup	string	The former sharding key. This parameter is specific to ordered messages.	xx
messageKeys	array	The business ID.
	string	The business ID.	xx
userProperties	object	The user-defined properties.
	string	The user-defined properties.	xx
transactionId	string	The transaction ID.	xx
liteTopicName	string	The name of the lightweight topic.	abc
producerInfo	object	As informações de rastreamento do produtor.
records	array<object>	The list of production records.
	object	The list of production records.
userName	string	The producer name.	xxx
clientHost	string	The hostname.	xx.xx.xx.xx
produceTime	string	The time when the message was sent.	2023-03-22 12:17:08
produceDuration	integer	The time taken to send the message.	100
produceStatus	string	The sending status.	SUCCESS
arriveTime	string	The arrival time.	2023-03-22 12:17:08
messageSource	string	The message source.	CONSOLE
dlqOriginTopic	string	The dead-letter queue topic.	test_topic
dlqOriginMessageId	string	The ID of the message in the dead-letter queue.	0A79275A00207A4F0F2916C92F9A0B94
recallTime	string	The time when the revoke request was initiated. This field is not empty when `messageSource` is `recall`.	Empty \| 2023-03-22 12:17:08
brokerInfo	object	As informações de rastreamento do broker.
presetDelayTime	string	The preset delivery time.	2023-03-22 12:17:08
delayStatus	string	The status of the scheduled message.	SUCCESS
operations	array<object>	The list of operations.
	object	The list of operations.
operateType	string	The operation type.	ADD
operateTime	string	The operation time.	2023-03-22 12:17:08
recallResult	string	The result of the revoke operation. This field is not empty when a revoke record exists.	Empty \| RECALL_OK \| RECALL_FAIL
consumerInfos	array<object>	As informações de rastreamento do consumidor.
	array<object>	As informações de rastreamento do consumidor.
consumerGroupId	string	The consumer group ID.	GID_inspector_group
records	array<object>	The list of consumption records.
	array<object>	The list of consumption records.
userName	string	The consumer name.	test
clientHost	string	The hostname.	xx.xx.xx.xx
fifoEnable	boolean	Indicates whether messages are consumed in order.	true
consumeStatus	string	The consumption status.	SUCCESS
operations	array<object>	The list of operations.
	object	The list of operations.
operateType	string	The operation type.	ADD
operateTime	string	The operation time.	2023-03-22 12:17:08
invisibleTime	integer	The invisibility duration, in milliseconds.	100
deadMessage	boolean	Indicates whether the message is a dead-letter message.	true
popCk	string	The POP checkpoint.	123
consumeStatus	string	The consumption status.	SUCCESS
deadMessage	boolean	Indicates whether the message is a dead-letter message.	true
deadLetterInfo	object	The information about the dead-letter message.
topicName	string	The topic name.	Register_Sync
messageId	string	The message ID.	7F000001001F7A4F0F29463F0376047D
toDlqTime	string	The time when the message arrived at the dead-letter queue.	2023-03-22 12:17:08
code	string	O código de erro.	InvalidConsumerGroupId
message	string	A mensagem de erro.	The instance cannot be found.
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": "Empty | 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": "Empty | 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.