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

Notas de uso

Se você desconhecer o ID da mensagem de dead-letter desejada, chame esta operação para listar todas as mensagens desse tipo enviadas a um grupo de consumidores em um período específico. Os resultados são exibidos de forma paginada.
Recomendamos definir um intervalo de tempo curto para a consulta. Intervalos longos retornam grande volume de mensagens e aumentam o tempo necessário para localizar o item desejado. Siga os passos abaixo para consultar mensagens de dead-letter:

1. Especifique os parâmetros Topic, BeginTime, EndTime e PageSize ao chamar esta operação para criar uma tarefa de consulta. Por padrão, a operação retorna as informações das mensagens de dead-letter da primeira página, o número total de páginas e o ID da tarefa.

2. Informe o ID da tarefa e o número da página para chamar a operação novamente e obter as mensagens da página especificada. Nessa etapa, os parâmetros BeginTime, EndTime e PageSize não têm efeito. O sistema utiliza automaticamente os valores definidos na requisição original que criou a tarefa de consulta.

Limite de requisições

Cada conta Alibaba Cloud pode chamar esta operação até 10 vezes por segundo. Se o volume de requisições atingir esse limite em um segundo, novas chamadas falharão e poderão interromper seus serviços. Para mais detalhes sobre os limites de cada operação, consulte Limites de taxa de API.

Autorização

Por padrão, apenas contas Alibaba Cloud podem executar esta operação. Usuários do Resource Access Management (RAM) precisam receber as permissões adequadas antes de chamá-la. A tabela a seguir descreve as permissões necessárias para usuários RAM. Para saber como conceder acesso, consulte Políticas e exemplos.

API

Action

Resource em instância com namespace

Resource em instância sem namespace

OnsDLQMessagePageQueryByGroupId

mq:QueryInstanceBaseInfo

mq:QueryDLQMessage

acs:mq:::{instanceId}%{groupId}

acs:mq:::{groupId}

Parâmetros da requisição

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	OnsDLQMessagePageQueryByGroupId	Operação a ser executada. Defina o valor como OnsDLQMessagePageQueryByGroupId.
GroupId	String	Sim	GID_test_group_id	ID do grupo de consumidores cujas mensagens de dead-letter serão consultadas.
BeginTime	Long	Sim	1570723200000	Início do intervalo de tempo da consulta. Defina o valor como um timestamp UNIX que representa os milissegundos decorridos desde a época 1º de janeiro de 1970, 00:00:00 UTC. Se você especificar um valor válido para o parâmetro TaskId na requisição, este parâmetro não terá efeito. O sistema usará o valor de BeginTime definido na requisição que criou a tarefa de consulta correspondente.
EndTime	Long	Sim	1570809600000	Fim do intervalo de tempo da consulta. Defina o valor como um timestamp UNIX que representa os milissegundos decorridos desde a época 1º de janeiro de 1970, 00:00:00 UTC. Se você especificar um valor válido para o parâmetro TaskId na requisição, este parâmetro não terá efeito. O sistema usará o valor de EndTime definido na requisição que criou a tarefa de consulta correspondente.
TaskId	String	Não	0BC1310300002A9F000021E4D7A48346	ID da tarefa de consulta. Este parâmetro é opcional na primeira chamada para consultar mensagens de dead-letter de um grupo em um período determinado, mas torna-se obrigatório nas consultas subsequentes para páginas específicas. Obtenha o ID da tarefa na resposta da primeira consulta.
CurrentPage	Integer	Sim	2	Número da página a ser retornada. A contagem começa em 1. Valores válidos: 1 a 50.
PageSize	Integer	Não	5	Quantidade de mensagens retornadas por 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 requisição, este parâmetro não terá efeito. O sistema usará o valor de PageSize definido na requisição que criou a tarefa de consulta correspondente.
InstanceId	String	Sim	MQ_INST_111111111111_DOxxxxxx	ID da instância do Message Queue for Apache RocketMQ que contém o grupo de consumidores.

Nota

Para mais informações sobre parâmetros de requisição, consulte

Parâmetros comuns

e

Fazer requisições de API

.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	B00CD3C8-D81E-4A41-85E2-38F19252****	ID da requisição. O sistema gera um identificador único para cada solicitação, permitindo solucionar problemas com base nesse ID.
MsgFoundDo	Object		Informações sobre as mensagens de dead-letter consultadas.
CurrentPage	Long	1	Número da página retornada.
MsgFoundList	Array of OnsRestMessageDo		Dados das mensagens de dead-letter presentes na página atual. O conteúdo deste parâmetro equivale às informações retornadas pela operação OnsDLQMessageGetById.
OnsRestMessageDo
StoreSize	Integer	406	Tamanho da mensagem. Unidade: KB.
ReconsumeTimes	Integer	1	Quantidade de tentativas do Message Queue for Apache RocketMQ para entregar a mensagem de dead-letter aos consumidores.
StoreTimestamp	Long	1570760999811	Momento em que o broker do Message Queue for Apache RocketMQ armazenou a mensagem.
InstanceId	String	MQ_INST_111111111111_DOxxxxxx	ID da instância.
MsgId	String	1E0578FE110F18B4AAC235C05F2*****	ID da mensagem.
StoreHost	String	11.193.*.*:10911	Broker do Message Queue for Apache RocketMQ que armazena a mensagem.
Topic	String	test-mq_topic	Tópico onde a mensagem está armazenada.
PropertyList	Array of MessageProperty		Propriedades da mensagem.
MessageProperty
Value	String	TagA	Valor da propriedade.
Name	String	TAGS	Nome da propriedade. Valores válidos: TRACE_ON: indica se existe rastro da mensagem. KEYS: chave da mensagem. TAGS: tag da mensagem. INSTANCE_ID: ID da instância que contém a mensagem. Para entender os termos utilizados no Message Queue for Apache RocketMQ, consulte Termos.
BornTimestamp	Long	1570760999721	Momento em que a mensagem foi produzida.
BodyCRC	Integer	914112295	Valor de verificação cíclica de redundância (CRC) do corpo da mensagem.
BornHost	String	42.120.*.*:59270	Instância produtora que gerou a mensagem.
MaxPageCount	Long	400	Número total de páginas de resultados.
TaskId	String	0BC1310300002A9F000021E4D7A48346	ID da tarefa de consulta. Retornado na primeira chamada desta operação para buscar mensagens de dead-letter publicadas em um tópico durante um período específico. Use este ID para recuperar detalhes de mensagens em outras páginas de resultado.

Exemplos

Exemplos de requisições

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsDLQMessagePageQueryByGroupId
&BeginTime=1570723200000
&CurrentPage=2
&EndTime=1570809600000
&GroupId=GID_test_group_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&TaskId=0BC1310300002A9F000021E4D7A48346
&PageSize=5
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

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

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

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

Códigos de erro

Para obter uma lista de códigos de erro, visite a Central de Erros de API.

Consultar mensagens de dead-letter no console

Você também pode consultar as mensagens de dead-letter de um grupo de consumidores diretamente no Message Queue for Apache RocketMQ console. Para mais detalhes, consulte Filas de dead-letter.