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

Consulta os rastreamentos de mensagens de 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:ListTraces

get

*Topic

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

Nenhuma

Sintaxe da solicitação

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

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância.	rmq-cn-tl32upjeb08
topicName	string	Sim	O nome do tópico.	topic_hpms_product_price_change

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
startTime	string	Sim	A hora de início.	2023-05-10 10:42:11
endTime	string	Sim	A hora de término.	2023-05-19 10:10:09
pageNumber	integer	Sim	O número da página dos resultados a serem retornados.	1
pageSize	integer	Sim	O número de entradas a serem retornadas em cada página.	10
queryType	string	Sim	O tipo de consulta. Valores válidos: MESSAGE_ID : MESSAGE_ID. MESSAGE_KEY : MESSAGE_KEY. TOPIC : TOPIC.	MESSAGE_ID
messageId	string	Não	O ID da mensagem. Este parâmetro é obrigatório se queryType estiver definido como MESSAGE_ID.	0100163E0EC1F1965C04C7906700000000
messageKey	string	Não	A chave da mensagem. Este parâmetro é obrigatório se queryType estiver definido como MESSAGE_KEY.	order_ceating
liteTopicName	string	Não	O nome do tópico leve.	abc

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
requestId	string	O ID da solicitação.	EDFF77E1-1ED1-5389-B6A8-651D9433BBE5
success	boolean	Indica se a solicitação foi bem-sucedida.	true
code	string	O código de erro.	Topic.NotFound
message	string	A mensagem de erro.	Parameter instanceId is mandatory for this action .
data	object	Os dados retornados.
pageNumber	integer	O número da página retornada.	1
pageSize	integer	O número de entradas retornadas por página.	10
totalCount	integer	O número total de entradas retornadas.	1
list	array<object>	Os dados paginados.
	object	Os dados paginados.
regionId	string	The region ID.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
topicName	string	The topic name.	topic_test
messageId	string	The message ID.	7F00000100207A4F0F294A938F7807AE
bornTime	string	The time when the message was created.	2023-03-22 12:17:08
messageTag	string	The message tag.	xx
messageKeys	array	The business keys.
	string	A business key.	xx
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âmica.	InstanceId

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "EDFF77E1-1ED1-5389-B6A8-651D9433BBE5",
  "success": true,
  "code": "Topic.NotFound",
  "message": "Parameter instanceId is mandatory for this action .",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "topicName": "topic_test",
        "messageId": "7F00000100207A4F0F294A938F7807AE",
        "bornTime": "2023-03-22 12:17:08",
        "messageTag": "xx",
        "messageKeys": [
          "xx"
        ]
      }
    ]
  },
  "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.