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

Consulta o acúmulo de mensagens para um ID de grupo especificado. Os resultados incluem o número de mensagens acumuladas e a latência de consumo.

Descrição da operação

Importante A OpenAPI do Alibaba Cloud é uma API de gerenciamento usada para gerenciar e consultar recursos de serviço do Alibaba Cloud. Integre esta API apenas ao seu link de dados de gerenciamento. Não use esta API no link de dados principal para envio e recebimento de mensagens para evitar possíveis ameaças.

Você pode usar a consulta de acúmulo de mensagens em um ambiente de produção para monitorar o progresso de consumo de um ID de grupo. Isso fornece uma visão geral do status e da latência de consumo de mensagens. Você pode consultar o acúmulo de mensagens para todos os tópicos aos quais o ID de grupo está inscrito ou para cada tópico individual.

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

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 que você deseja consultar.	GID_test_consumer_id
Detail	boolean	Não	Especifica se devem ser consultados os detalhes de cada tópico. Valores válidos: true: Consulta os detalhes. Os detalhes são retornados no parâmetro DetailInTopicList. false: Não consulta os detalhes. Este é o valor padrão. O parâmetro DetailInTopicList retorna vazio.	true
InstanceId	string	Não	O ID da instância.	MQ_INST_111111111111_DOxxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação. Este é um parâmetro comum. Cada solicitação tem um ID exclusivo. Use este ID para localizar e solucionar problemas.	CE817BFF-B389-43CD-9419-95011AC9****
Data	object	O acúmulo de mensagens do consumidor especificado.
ConsumeTps	number	O TPS total de consumo de mensagens para o grupo de instâncias consumidoras que pertencem ao ID de grupo especificado.	10
DelayTime	integer	A latência máxima de consumo de mensagens para o ID de grupo. O valor é a maior latência de consumo entre todos os tópicos aos quais o ID de grupo está inscrito. Unidade: milissegundos.	10000
LastTimestamp	integer	A hora de produção da mensagem consumida mais recentemente no grupo de instâncias consumidoras que pertencem ao ID de grupo especificado. Unidade: timestamp Unix em milissegundos.	1566231000000
TotalDiff	integer	O número de mensagens acumuladas para todos os tópicos aos quais o ID de grupo está inscrito.	100
Online	boolean	Indica se uma instância consumidora está online sob este ID de grupo. Se pelo menos uma instância consumidora estiver online, o ID de grupo é considerado online. Valores válidos: true: Online false: Offline	true
DetailInTopicList	object
DetailInTopicDo	array<object>	The details of each topic. If the Detail parameter in the request is set to false, this parameter returns empty.
	object
DelayTime	integer	The maximum message consumption latency in this topic. This is the time difference between the ready time of the earliest unconsumed message in the topic and the current time. Unit: milliseconds.	10000
TotalDiff	integer	The number of stacked messages in the topic.	100
LastTimestamp	integer	The production time of the most recently consumed message in the topic. Unit: Unix timestamp in milliseconds.	1566231000000
Topic	string	The topic name.	test-mq-topic

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "CE817BFF-B389-43CD-9419-95011AC9****",
  "Data": {
    "ConsumeTps": 10,
    "DelayTime": 10000,
    "LastTimestamp": 1566231000000,
    "TotalDiff": 100,
    "Online": true,
    "DetailInTopicList": {
      "DetailInTopicDo": [
        {
          "DelayTime": 10000,
          "TotalDiff": 100,
          "LastTimestamp": 1566231000000,
          "Topic": "test-mq-topic"
        }
      ]
    }
  }
}

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.