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

Consulta uma mensagem de dead-letter especificada por ID da mensagem, incluindo o horário de armazenamento, o corpo da mensagem, a chave e a tag.

Descrição da operação

Importante As operações OpenAPI fornecidas pelo Alibaba Cloud são operações de API de gerenciamento usadas para gerenciar e consultar recursos dos serviços do Alibaba Cloud. Integre essas operações apenas no link 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 no link.

A consulta de uma mensagem de dead-letter por ID da mensagem é uma consulta exata. Você pode obter o ID da mensagem necessário para a consulta a partir do SendResult retornado após o envio bem-sucedido de uma mensagem, ou a partir de uma operação de consulta em lote. As informações consultadas incluem campos de propriedade da mensagem de dead-letter, como o horário de armazenamento, o corpo da mensagem, a chave e a tag.

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
MsgId	string	Sim	O ID da mensagem a ser consultada.	0BC16699165C03B925DB8A404E2D****
GroupId	string	Sim	O ID do grupo de consumidores a ser consultado.	GID_test_group_id
InstanceId	string	Não	O ID da instância correspondente à mensagem a ser consultada.	MQ_INST_111111111111_DOxxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O parâmetro comum. O ID da solicitação é exclusivo para cada solicitação.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	O resultado da consulta.
StoreSize	integer	O tamanho da mensagem. Unidade: KB.	407
ReconsumeTimes	integer	O número de vezes que a mensagem é reprocessada para consumo.	1
StoreTimestamp	integer	O carimbo de data e hora em que a mensagem é armazenada no servidor. Unidade: milissegundos.	1570761026708
InstanceId	string	O ID da instância.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	O ID da mensagem.	0BC16699165C03B925DB8A404E2D****
StoreHost	string	A instância do servidor que armazena a mensagem.	11.220.*.*: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 o rastreamento de mensagens está ativado. 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 os conceitos, consulte Termos.	TAGS
BornTimestamp	integer	O carimbo de data e hora em que a mensagem é gerada. Unidade: milissegundos.	1570761026630
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..:64646

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****",
  "Data": {
    "StoreSize": 407,
    "ReconsumeTimes": 1,
    "StoreTimestamp": 1570761026708,
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "MsgId": "0BC16699165C03B925DB8A404E2D****",
    "StoreHost": "11.220.***.***:10911",
    "Topic": "test-mq_topic",
    "PropertyList": {
      "MessageProperty": [
        {
          "Value": "TagA",
          "Name": "TAGS"
        }
      ]
    },
    "BornTimestamp": 1570761026630,
    "BodyCRC": 914112295,
    "BornHost": "42.120.**.**:64646"
  }
}

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.