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

Consulta o acúmulo de consumo de mensagens de um ID de grupo especificado, incluindo o número atual de mensagens acumuladas e o tempo de atraso de consumo.

Descrição da operação

Importante As operações OpenAPI fornecidas pela Alibaba Cloud são operações de API de gerenciamento e controle usadas para gerenciar e consultar recursos dos serviços da Alibaba Cloud. Integre essas operações de API apenas em links de gerenciamento e controle. Não dependa de operações OpenAPI nos links de dados principais para envio e recebimento de mensagens. Caso contrário, podem ocorrer riscos nos links.

Você pode consultar o acúmulo de consumo de mensagens quando precisar monitorar o progresso de consumo de um ID de grupo em um ambiente de produção. Isso ajuda a estimar aproximadamente o consumo e o atraso das mensagens. Você pode consultar o acúmulo de consumo de mensagens de todos os tópicos aos quais o ID do grupo está inscrito, bem como o acúmulo de consumo de mensagens de cada tópico.

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

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_consumer_id
Detail	boolean	Não	Especifica se deve consultar os detalhes de cada tópico. Valores válidos: true: consulta os detalhes e retorna os detalhes do parâmetro DetailInTopicList. false: não consulta os detalhes. Este é o valor padrão. O parâmetro DetailInTopicList fica 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 parâmetro comum. Cada solicitação tem um ID exclusivo que pode ser usado para solução de problemas e localização de problemas.	CE817BFF-B389-43CD-9419-95011AC9****
Data	object	O acúmulo de consumo de mensagens do consumidor especificado.
ConsumeTps	number	O total de transações por segundo (TPS) de mensagens recebidas pelo grupo de instâncias de consumidor sob o ID do grupo.	10
DelayTime	integer	O tempo máximo de atraso para o consumo de mensagens sob o ID do grupo. O valor é o tempo máximo de atraso entre todos os tópicos aos quais o ID do grupo está inscrito. Unidade: milissegundos.	10000
LastTimestamp	integer	A hora de produção da mensagem consumida mais recentemente no grupo de instâncias de consumidor sob o ID do grupo. Unidade: timestamp UNIX em milissegundos.	1566231000000
TotalDiff	integer	O número total de mensagens acumuladas para todos os tópicos aos quais o ID do grupo está inscrito.	100
Online	boolean	Indica se uma instância de consumidor está online sob o ID do grupo. Se pelo menos uma instância de consumidor estiver online, o ID do grupo é considerado online. Valores válidos: true: O ID do grupo está online. false: O ID do grupo está offline.	true
DetailInTopicList	object
DetailInTopicDo	array<object>	Os detalhes de cada tópico. Se o parâmetro de solicitação Detail estiver definido como false, este parâmetro ficará vazio.
	object
DelayTime	integer	O tempo máximo de atraso para o consumo de mensagens no tópico. Esta é a diferença entre a hora de disponibilidade da mensagem não consumida mais antiga no tópico e a hora atual. Unidade: milissegundos.	10000
TotalDiff	integer	O número de mensagens acumuladas no tópico.	100
LastTimestamp	integer	A hora de produção da mensagem consumida mais recentemente no tópico. Unidade: timestamp UNIX em milissegundos.	1566231000000
Topic	string	O nome do tópico.	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.