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

Consulta todas as mensagens de dead-letter existentes na memória em um grupo de consumidores especificado durante um período especificado, utilizando paginação.

Descrição da operação

Importante As operações OpenAPI fornecidas pela Alibaba Cloud são operações de API de gerenciamento usadas para gerenciar e consultar recursos dos serviços da Alibaba Cloud. Recomendamos que você integre essas operações apenas em fluxos de trabalho de gerenciamento. Não dependa de operações OpenAPI no link de dados principal para envio e recebimento de mensagens. Caso contrário, podem ocorrer riscos nos fluxos de trabalho.

A consulta de mensagens de dead-letter por ID do grupo de consumidores é uma consulta de intervalo. Os resultados da consulta paginada são exibidos ao chamador de forma paginada. Este método é aplicável apenas a cenários em que nenhum ID de mensagem é especificado como condição de pesquisa.
Ao consultar mensagens de dead-letter por ID do grupo de consumidores, minimize o intervalo de tempo da consulta paginada. Caso contrário, muitas mensagens podem ser correspondidas, o que dificulta a solução de problemas. O procedimento de chamada é o seguinte:
1. Especifique o ID do grupo de consumidores, a hora de início, a hora de término e o número de mensagens por página para realizar uma consulta paginada. Se existirem mensagens, as mensagens da primeira página, o número total de páginas e o ID da tarefa de consulta são retornados por padrão.
2. Use o ID da tarefa de consulta paginada retornado no resultado para recuperar as mensagens subsequentes. Ao recuperar mensagens subsequentes, especifique o ID da tarefa de consulta paginada e o número da página atual. A hora de início, a hora de término e o número de mensagens por página especificados não entram em vigor. Os valores dos parâmetros especificados na primeira consulta são usados por padrão.

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

Grupo.

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

Grupo.

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 carimbo de data/hora de início do intervalo de consulta. Unidade: milissegundos. Ao recuperar mensagens subsequentes usando TaskId, o valor deste parâmetro não entra em vigor. A hora de início especificada na primeira consulta é usada por padrão.	1570723200000
EndTime	integer	Sim	O carimbo de data/hora de término do intervalo de consulta. Unidade: milissegundos. Ao recuperar mensagens subsequentes usando TaskId, o valor deste parâmetro não entra em vigor. A hora de término especificada na primeira consulta é usada por padrão.	1570809600000
TaskId	string	Não	O ID da tarefa de consulta. Este parâmetro não é obrigatório para a primeira consulta, mas é necessário para recuperar mensagens subsequentes. Você pode obter este campo a partir do resultado da consulta anterior.	0BC1310300002A9F000021E4D7A48346
CurrentPage	integer	Sim	O número da página atual de mensagens a serem recuperadas. O valor começa em 1 e é incrementado. O valor máximo é 50. O número da página não pode exceder o número máximo de páginas ao recuperar mensagens.	2
PageSize	integer	Não	O número máximo de mensagens a serem exibidas por página durante a paginação. Valor padrão: 20. Valor mínimo: 5. Valor máximo: 50. Ao recuperar mensagens subsequentes usando TaskId, as configurações deste parâmetro não entram em vigor. O número de mensagens por página especificado na primeira consulta é usado por padrão.	5
InstanceId	string	Não	O ID da instância correspondente às mensagens a serem consultadas.	MQ_INST_111111111111_DOxxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O parâmetro comum. O ID de cada solicitação é único e pode ser usado para solução de problemas e localização de falhas.	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>	A coleção de mensagens na página atual. A estrutura de dados é a mesma da resposta de OnsDLQMessageGetById.
	array<object>
StoreSize	integer	O tamanho da mensagem. Unidade: KB.	406
ReconsumeTimes	integer	O número de tentativas de reconsumo da mensagem.	1
StoreTimestamp	integer	O carimbo de data/hora em que a mensagem é armazenada no servidor.	1570760999811
InstanceId	string	O ID da instância.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	O ID da mensagem.	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	A instância do servidor que armazena a mensagem.	11.193.*.*:10911
Topic	string	O tópico da mensagem.	test-mq_topic
PropertyList	object
MessageProperty	array<object>	A lista de propriedades da mensagem.
	object
Value	string	O valor da propriedade da mensagem.	TagA
Name	string	A propriedade da mensagem. Valores válidos: TRACE_ON: Indica se existe um rastreamento de mensagem. KEYS: A propriedade de chave da mensagem. TAGS: A propriedade de tag da mensagem. INSTANCE_ID: O ID da instância à qual a mensagem pertence. Para obter mais informações sobre conceitos, consulte Termos.	TAGS
BornTimestamp	integer	O carimbo de data/hora em que a mensagem é produzida.	1570760999721
BodyCRC	integer	A soma de verificação CRC do corpo da mensagem.	914112295
BornHost	string	A instância do produtor que gera a mensagem.	42.120.*.*:59270
MaxPageCount	integer	O número máximo de páginas no resultado da consulta.	400
TaskId	string	O ID da tarefa de consulta retornado quando a consulta é criada pela primeira vez. Este ID é usado para recuperar mensagens 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.