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

Descrição da operação

Importante As operações da OpenAPI do Alibaba Cloud são APIs de gerenciamento e controle usadas para gerenciar e consultar recursos dos serviços do Alibaba Cloud. Integre-as apenas em fluxos de trabalho de gerenciamento e controle. Não dependa de operações da OpenAPI no link de dados principal para envio e recebimento de mensagens. Caso contrário, podem ocorrer riscos nos fluxos de trabalho.

Você pode chamar esta operação para consultar o horário em que as mensagens mais antiga e mais recente de um tópico são armazenadas no servidor atual e o horário em que o consumidor consumiu mensagens pela última vez. Esta operação é geralmente usada para exibir uma visão geral do progresso de consumo e é usada em conjunto com a operação OnsConsumerAccumulate.

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

get

Tópico.

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

Tópico.

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}

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
Topic	string	Sim	O tópico assinado pelo grupo de consumidores a ser consultado.	test-mq_topic
InstanceId	string	Não	O ID da instância correspondente ao ID do grupo de consumidores a ser consultado.	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. O ID de cada solicitação é único e pode ser usado para solucionar e localizar problemas.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	O resultado da consulta.
MaxTimeStamp	integer	O horário de produção da mensagem mais recente atualmente armazenada no tópico.	1570761026804
ConsumeTimeStamp	integer	O último horário em que o grupo de consumidores atual consumiu mensagens do tópico.	1570761026400
Topic	string	O tópico a ser consultado.	test-mq_topic
MinTimeStamp	integer	O horário de produção da mensagem mais antiga atualmente armazenada no tópico.	1570701231122
InstanceId	string	O ID da instância correspondente ao ID do grupo de consumidores a ser consultado.	MQ_INST_111111111111_DOxxxxxx

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****",
  "Data": {
    "MaxTimeStamp": 1570761026804,
    "ConsumeTimeStamp": 1570761026400,
    "Topic": "test-mq_topic",
    "MinTimeStamp": 1570701231122,
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx"
  }
}

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.