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

Cria uma tarefa de consulta de rastreamento com base no nome de um tópico e em uma chave de mensagem e retorna o ID da tarefa de consulta. Em seguida, você deve chamar a operação OnsTraceGetResult e passar o ID da tarefa de consulta retornado para recuperar os resultados detalhados do rastreamento da mensagem.

Descrição da operação

Importante

A OpenAPI fornecida pela Alibaba Cloud é uma API de plano de controle usada para gerenciar e consultar recursos dos serviços da Alibaba Cloud. Use esta API apenas para integração do plano de controle. Não use a OpenAPI no link de dados principal para enviar ou receber mensagens. Caso contrário, isso pode introduzir ameaças ao link de dados.

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:QueryTrace

get

Topic

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

Topic

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

Nenhuma

mq:OnsInstanceBaseInfo

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Topic	string	Sim	O tópico da mensagem a ser consultado.	test
MsgKey	string	Sim	A chave da mensagem a ser consultada.	ORDERID_100
BeginTime	integer	Sim	O início do intervalo de tempo a ser consultado. O valor é um timestamp UNIX em milissegundos.	1570852800000
EndTime	integer	Sim	O fim do intervalo de tempo a ser consultado. O valor é um timestamp UNIX em milissegundos.	1570968000000
InstanceId	string	Não	O ID da instância à qual o tópico da mensagem pertence.	MQ_INST_111111111111_DOxxxxxx

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 e localizar problemas.	F8654231-122A-4DBD-801F-38E35538****
QueryId	string	O ID da tarefa de consulta. Você deve chamar a operação OnsTraceGetResult com este ID de tarefa para obter os resultados detalhados.	272967562652883649157096685****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "F8654231-122A-4DBD-801F-38E35538****",
  "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.