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

Consulta todas as mensagens armazenadas em um tópico especificado dentro de um intervalo de tempo especificado, por página.

Descrição da operação

Nota

As operações de API fornecidas pela Alibaba Cloud são usadas para gerenciar e consultar recursos dos serviços da Alibaba Cloud. Recomendamos que você integre essas operações de API apenas em sistemas de gerenciamento. Não use essas operações de API no sistema principal dos serviços de mensagens. Caso contrário, podem ocorrer riscos no sistema.

Se você não souber o ID ou a chave de uma mensagem que deseja consultar, poderá chamar esta operação para consultar todas as mensagens armazenadas no tópico dentro de um intervalo de tempo especificado. Os resultados são exibidos por página.
Recomendamos que você especifique um intervalo de tempo curto para consultar mensagens. Se você especificar um intervalo de tempo longo, um grande número de mensagens será retornado. Nesse caso, você não conseguirá encontrar a mensagem que deseja consultar de maneira eficiente. Você pode executar as seguintes etapas para consultar mensagens:
1. Execute uma consulta paginada especificando o tópico, a hora de início, a hora de término e o número de entradas a serem retornadas em cada página. Se o tópico contiver mensagens, as informações sobre as mensagens na primeira página, o número total de páginas e o ID da tarefa serão retornados por padrão.
2. Especifique o ID da tarefa e um número de página para chamar esta operação novamente e consultar as mensagens na página especificada. Os parâmetros BeginTime, EndTime e PageSize não entram em vigor. Por padrão, o sistema usa os valores desses parâmetros que você especificou na solicitação ao criar a tarefa de consulta especificada.

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

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 nome do tópico cujas mensagens você deseja consultar.	test-mq_topic
BeginTime	integer	Sim	O início do intervalo de tempo a ser consultado. O valor deste parâmetro é um carimbo de data/hora UNIX em milissegundos. Se você especificar um valor válido para o parâmetro TaskId na solicitação, este parâmetro não entrará em vigor. O sistema usa o valor do parâmetro BeginTime que você especificou na solicitação ao criar a tarefa de consulta especificada.	1570723200000
EndTime	integer	Sim	O fim do intervalo de tempo a ser consultado. O valor deste parâmetro é um carimbo de data/hora UNIX em milissegundos. Se você especificar um valor válido para o parâmetro TaskId na solicitação, este parâmetro não entrará em vigor. O sistema usa o valor do parâmetro EndTime que você especificou na solicitação ao criar a tarefa de consulta especificada.	1570809600000
TaskId	string	Não	O ID da tarefa de consulta. Na primeira vez que você chama esta operação para consultar as informações sobre mensagens em um tópico especificado dentro de um intervalo de tempo especificado, este parâmetro não é obrigatório. Este parâmetro é obrigatório em consultas subsequentes para mensagens em uma página especificada. Você pode obter o ID da tarefa a partir do resultado retornado da primeira consulta.	0BC1310300002A9F000021E4D7A48346
CurrentPage	integer	Sim	O número da página a ser retornada. As páginas começam na página 1. Valores válidos: 1 a 50.	2
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 5 a 50. Valor padrão: 20. Se você especificar um valor válido para o parâmetro TaskId na solicitação, este parâmetro não entrará em vigor. O sistema usa o valor do parâmetro PageSize que você especificou na solicitação para criar a tarefa de consulta.	5
InstanceId	string	Não	O ID da instância à qual a mensagem que você deseja consultar pertence.	MQ_INST_111111111111_DOxxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação. Este parâmetro é um parâmetro comum. Cada solicitação tem um ID exclusivo. Você pode usar este ID para solucionar problemas.	5DC2A47E-2B31-4722-96C8-FA59C9*****
MsgFoundDo	object	As informações sobre a mensagem consultada.
CurrentPage	integer	O número da página retornada.	1
MsgFoundList	object
OnsRestMessageDo	array<object>	The information about messages on the returned page. The information that is contained in this parameter is the same as the information that is returned by the OnsMessageGetByMsgId operation.
	array<object>
StoreSize	integer	The size of the message. Unit: KB.	406
ReconsumeTimes	integer	The number of retries that were performed to send the message to consumers.	1
StoreTimestamp	integer	The time when the ApsaraMQ for RocketMQ broker stored the message. The value is a UNIX timestamp that represents the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1570760999811
InstanceId	string	The ID of the instance	MQ_INST_111111111111_DOxxxxxx
MsgId	string	The ID of the message.	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	The ApsaraMQ for RocketMQ broker that stores the message.	11.193.*.*:10911
Topic	string	The topic to which the message belongs.	test-mq_topic
PropertyList	object
MessageProperty	array<object>	The attributes of the message.
	object
Value	string	The value of the attribute.	TagA
Name	string	The name of the attribute. Valid values: TRACE_ON: indicates whether a trace of the message exists. KEYS: indicates the key of the message. TAGS: indicates the tag of the message. INSTANCE_ID: indicates the ID of the instance that contains the message. For information about the terms that are used in ApsaraMQ for RocketMQ see Terms.	TAGS
BornTimestamp	integer	The time when the message was generated. The value is a UNIX timestamp that represents the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1570760999721
BodyCRC	integer	The cyclic redundancy check (CRC) value of the message body.	914112295
BornHost	string	The producer client that generated the message.	42.120.*.*:59270
MaxPageCount	integer	O número total de páginas retornadas.	400
TaskId	string	O ID da tarefa de consulta. Na primeira vez que você chama esta operação para consultar as mensagens enviadas a um grupo de consumidores especificado dentro de um intervalo de tempo especificado, este parâmetro é retornado. Você pode usar o ID da tarefa para consultar os detalhes das mensagens em outras páginas retornadas.	0BC1310300002A9F000021E4D7A48346

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "5DC2A47E-2B31-4722-96C8-FA59C9*****",
  "MsgFoundDo": {
    "CurrentPage": 1,
    "MsgFoundList": {
      "OnsRestMessageDo": [
        {
          "StoreSize": 406,
          "ReconsumeTimes": 1,
          "StoreTimestamp": 1570760999811,
          "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
          "MsgId": "1E0578FE110F18B4AAC235C05F2*****",
          "StoreHost": "11.193.***.***:10911",
          "Topic": "test-mq_topic",
          "PropertyList": {
            "MessageProperty": [
              {
                "Value": "TagA",
                "Name": "TAGS"
              }
            ]
          },
          "BornTimestamp": 1570760999721,
          "BodyCRC": 914112295,
          "BornHost": "42.120.***.***:59270"
        }
      ]
    },
    "MaxPageCount": 400,
    "TaskId": "0BC1310300002A9F000021E4D7A48346"
  }
}

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.