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

Consulta mensagens dead-letter por página para um Group ID e intervalo de tempo especificados.

Descrição da operação

Importante

Alibaba Cloud OpenAPI é uma API de gerenciamento. Você pode usá-la para gerenciar e consultar recursos de serviços Alibaba Cloud. Integre esta API apenas para fins de gerenciamento. Não use esta API para links de dados principais que enviam e recebem mensagens, pois isso pode criar ameaças de segurança.

A consulta de mensagens dead-letter por Group ID é uma consulta paginada por intervalo. Este método se aplica apenas a cenários em que você consulta mensagens sem especificar um ID de mensagem.
Ao consultar mensagens dead-letter por Group ID, especifique um intervalo de tempo o mais curto possível. Um intervalo de tempo longo pode retornar muitas mensagens e dificultar a identificação de problemas. O fluxo de chamada é o seguinte:
1. Para a primeira consulta paginada, especifique o Group ID, a hora de início, a hora de término e o número de mensagens por página. Se mensagens forem encontradas, a API retorna as mensagens da primeira página, o número total de páginas e um ID de tarefa de consulta.
2. Use o ID de tarefa de consulta retornado para recuperar mais páginas de mensagens. Nas solicitações subsequentes, especifique o ID de tarefa de consulta e o número da página. A hora de início, a hora de término e o número de mensagens por página nessas solicitações são ignorados porque os valores da primeira consulta são utilizados.

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

get

Group

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

Group

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

Nenhuma

mq:OnsInstanceBaseInfo

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
GroupId	string	Sim	O ID do grupo de consumidores a ser consultado.	GID_test_group_id
BeginTime	integer	Sim	O início do intervalo de tempo a ser consultado. Este valor é um timestamp UNIX em milissegundos. Se você especificar `TaskId` para recuperar mais páginas, este parâmetro será ignorado. A hora de início da primeira consulta será utilizada.	1570723200000
EndTime	integer	Sim	O fim do intervalo de tempo a ser consultado. Este valor é um timestamp UNIX em milissegundos. Se você especificar `TaskId` para recuperar mais páginas, este parâmetro será ignorado. A hora de término da primeira consulta será utilizada.	1570809600000
TaskId	string	Não	O ID da tarefa de consulta. Omita este parâmetro na primeira consulta. Para consultas subsequentes, use o ID de tarefa retornado pela consulta anterior.	0BC1310300002A9F000021E4D7A48346
CurrentPage	integer	Sim	O número da página a ser retornada. As páginas começam a partir de 1. O valor pode ser até 50 e não deve exceder o número total de páginas.	2
PageSize	integer	Não	O número de mensagens a serem retornadas em cada página. Valor padrão: 20. Valor mínimo: 5. Valor máximo: 50. Se você especificar `TaskId` para recuperar mais páginas, este parâmetro será ignorado. O tamanho da página da primeira consulta será utilizado.	5
InstanceId	string	Não	O ID da instância que contém a mensagem.	MQ_INST_111111111111_DOxxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação. Cada solicitação possui um ID exclusivo. Use este ID para solucionar problemas.	B00CD3C8-D81E-4A41-85E2-38F19252****
MsgFoundDo	object	O resultado da consulta.
CurrentPage	integer	O número da página atual.	1
MsgFoundList	object
OnsRestMessageDo	array<object>	The list of messages on the current page. The data type is the same as the data type of the response to the OnsDLQMessageGetById operation.
	array<object>
StoreSize	integer	The message size in KB.	406
ReconsumeTimes	integer	The number of times the message has been reconsumed.	1
StoreTimestamp	integer	The UNIX timestamp for when the message was stored on the server.	1570760999811
InstanceId	string	The instance ID.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	The message ID.	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	The server that stores the message.	11.193.*.*:10911
Topic	string	The topic of the message.	test-mq_topic
PropertyList	object
MessageProperty	array<object>	A list of message properties.
	object
Value	string	The value of the message property.	TagA
Name	string	The message property. Valid values: TRACE_ON: Indicates whether a message trace exists. KEYS: The key of the message. TAGS: The tag of the message. INSTANCE_ID: The ID of the instance that contains the message. For more information, see Terms.	TAGS
BornTimestamp	integer	The UNIX timestamp for when the message was produced.	1570760999721
BodyCRC	integer	The cyclic redundancy check (CRC) value of the message body.	914112295
BornHost	string	The producer that generated the message.	42.120.*.*:59270
MaxPageCount	integer	O número total de páginas disponíveis.	400
TaskId	string	O ID da tarefa de consulta. Este ID é retornado na primeira consulta. Use este ID para recuperar páginas subsequentes.	0BC1310300002A9F000021E4D7A48346

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "B00CD3C8-D81E-4A41-85E2-38F19252****",
  "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.