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

Observação

Use esta operação para acompanhar o progresso de consumo de mensagens de um grupo de consumidores específico. Os dados retornados permitem obter detalhes sobre o consumo e a latência associada. A operação fornece o total de mensagens acumuladas em todos os tópicos assinados pelo grupo, além da contagem individual por tópico.

Nota

Para consultar informações de consumo de cada consumidor online em um grupo, chame a operação

OnsConsumerStatus.

Limite de solicitações

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

Autorização

Por padrão, contas Alibaba Cloud podem chamar esta operação. Um usuário do Resource Access Management (RAM) só pode chamar esta operação após receber as permissões necessárias. A tabela a seguir descreve as permissões que devem ser concedidas a um usuário RAM para chamar esta operação. Para saber como conceder permissões, consulte Políticas.

API

Action

Recurso em uma instância com namespace

Recurso em uma instância sem namespace

OnsConsumerAccumulate

mq:QueryInstanceBaseInfo

mq:QueryConsumerAccumulate

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

acs:mq:::{groupId}

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	OnsConsumerAccumulate	A operação a ser executada. Defina o valor como OnsConsumerAccumulate.
GroupId	String	Sim	GID_test_consumer_id	O ID do grupo de consumidores a ser consultado.
Detail	Boolean	Não	true	Especifique se os detalhes de cada tópico assinado pelo grupo devem ser consultados. Valores válidos: true: Consulta os detalhes de cada tópico. Essas informações ficam disponíveis no parâmetro de resposta DetailInTopicList. false: Não consulta os detalhes dos tópicos. Este é o valor padrão. Ao selecionar esta opção, o parâmetro de resposta DetailInTopicList retorna vazio.
InstanceId	String	Sim	MQ_INST_111111111111_DOxxxxxx	O ID da instância à qual o grupo de consumidores especificado pertence.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	CE817BFF-B389-43CD-9419-95011AC9****	O ID da solicitação. O sistema gera um identificador único para cada requisição, útil para solucionar problemas.
Data	Object		Dados referentes ao acúmulo de mensagens nos tópicos assinados pelo grupo de consumidores.
ConsumeTps	Float	10	Taxa de transações por segundo (TPS) referente ao consumo de mensagens pelos consumidores do grupo.
DelayTime	Long	10000	Latência de consumo do grupo de consumidores.
LastTimestamp	Long	1566231000000	Momento em que a mensagem mais recente consumida por um membro do grupo foi produzida.
TotalDiff	Long	100	Quantidade total de mensagens enfileiradas em todos os tópicos assinados pelo grupo.
Online	Boolean	true	Indica se o grupo de consumidores está online. Basta que um consumidor esteja ativo para considerar o grupo online. Valores válidos: true: O grupo de consumidores está online. false: O grupo de consumidores está offline.
DetailInTopicList	Array of DetailInTopicDo		Informações detalhadas de cada tópico assinado pelo grupo. Se o parâmetro Detail na solicitação estiver definido como false, este campo retornará vazio.
DetailInTopicDo
DelayTime	Long	10000	Maior latência de consumo registrada no tópico.
TotalDiff	Long	100	Número de mensagens pendentes na fila do tópico.
LastTimestamp	Long	1566231000000	Horário de produção da última mensagem consumida neste tópico.
Topic	String	test-mq-topic	Nome do tópico.

Exemplos

Exemplos de solicitações

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsConsumerAccumulate
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&GroupId=GID_test_consumer_id
&Detail=true
&<Common request parameters>

Exemplos de respostas de sucesso

XML format

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

<OnsConsumerAccumulateResponse>
<Data>
    <DetailInTopicList>
        <DetailInTopicDo>
            <TotalDiff>100</TotalDiff>
            <LastTimestamp>1566231000000</LastTimestamp>
            <DelayTime>10000</DelayTime>
            <Topic>test-mq-topic</Topic>
        </DetailInTopicDo>
    </DetailInTopicList>
    <TotalDiff>100</TotalDiff>
    <LastTimestamp>1566231000000</LastTimestamp>
    <DelayTime>10000</DelayTime>
    <Online>true</Online>
    <ConsumeTps>10</ConsumeTps>
</Data>
<RequestId>0CCF6437-CBB0-4378-BFEC-E08AC258****</RequestId>
</OnsConsumerAccumulateResponse>

JSON format

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

{
  "Data" : {
    "DetailInTopicList" : {
      "DetailInTopicDo" : [ {
        "TotalDiff" : 100,
        "LastTimestamp" : 1566231000000,
        "DelayTime" : 10000,
        "Topic" : "test-mq-topic"
      } ]
    },
    "TotalDiff" : 100,
    "LastTimestamp" : 1566231000000,
    "DelayTime" : 10000,
    "Online" : true,
    "ConsumeTps" : 10
  },
  "RequestId" : "0CCF6437-CBB0-4378-BFEC-E08AC258****"
}

Códigos de erro

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

Visualize informações de acúmulo de mensagens no console

No Message Queue for Apache RocketMQ console, visualize os dados de acúmulo de mensagens nos tópicos assinados por um grupo de consumidores. Para mais informações, consulte Visualizar o status dos consumidores.