QueryConsumerGroupStatus - IoT Platform: Central de Documentação do Alibaba Cloud

Consulta o status de um grupo de consumidores em uma assinatura do lado do servidor AMQP. As informações incluem dados de clientes online, taxa de consumo de mensagens, quantidade de mensagens acumuladas e horário da última mensagem consumida.

Limites

Cada conta Alibaba Cloud permite no máximo 5 consultas por segundo (QPS).

Nota

Usuários RAM de uma conta Alibaba Cloud compartilham a cota dessa conta.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	QueryConsumerGroupStatus	Operação a ser executada. Defina o valor como QueryConsumerGroupStatus.
GroupId	String	Sim	nJRaJPn5U1JITGf******	ID do grupo de consumidores. Esse ID é retornado após a chamada da operação CreateConsumerGroup. Para consultar o ID pelo nome do grupo, chame a operação QueryConsumerGroupList. Alternativamente, acesse o console do IoT Platform,e escolha Rules > Server-side Subscription > Consumer Groups para visualizar o ID do grupo de consumidores.
IotInstanceId	String	Não	iot-cn-0pp1n8t****	ID da instância. Visualize o ID da instância na página Overview do console do IoT Platform. Importante Se a instância tiver um ID, configure este parâmetro obrigatoriamente. Caso contrário, a chamada falhará. Se a instância não tiver uma página Overview ou ID, não defina este parâmetro. Para mais informações, consulte Overview.

Além dos parâmetros específicos listados acima, especifique os parâmetros comuns de solicitação ao chamar esta operação. Para mais detalhes, consulte Parâmetros comuns de solicitação.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
AccumulatedConsumeCountPerMinute	Integer	10	Taxa de consumo de mensagens. Unidade: mensagens/minuto.
AccumulationCount	Integer	13	Quantidade de mensagens acumuladas.
ClientConnectionStatusList	Array of ConsumerGroupClientConnectionInfo		Detalhes do cliente. Para mais informações, consulte ConsumerGroupClientConnectionInfo.
ConsumerGroupClientConnectionInfo
AccumulatedConsumeCountPerMinute	Integer	10	Taxa de consumo de mensagens acumuladas em um único cliente do grupo de consumidores. Unidade: mensagens/minuto.
ClientId	String	868575026******	ID do cliente.
ClientIpPort	String	192.168.1.2:36918	Endereço IP e porta do cliente.
OnlineTime	Long	1591240546649	Último momento em que o cliente esteve online. Valor em timestamp UNIX representando milissegundos decorridos desde a época (1º de janeiro de 1970, 00:00:00 UTC).
RealTimeConsumeCountPerMinute	Integer	5	Taxa de consumo de mensagens em tempo real em um único cliente do grupo de consumidores. Unidade: mensagens/minuto.
Code	String	iot.system.SystemException	Código de erro retornado em caso de falha na chamada. Para mais informações, consulte Códigos de erro.
ConsumerSpeed	Integer	14	Taxa de consumo de mensagens do grupo de consumidores. Unidade: mensagens/minuto.
ErrorMessage	String	A system exception occurred.	Mensagem de erro retornada em caso de falha na chamada.
LastConsumerTime	String	2020-05-29T03:37:56.000Z	Horário de consumo da última mensagem. Formato: yyyy-MM-dd'T'HH:mm:ss.SSSZ. Exibido em UTC com precisão de milissegundos.
RealTimeConsumeCountPerMinute	Integer	14	Taxa de consumo de mensagens em tempo real no grupo de consumidores. Unidade: mensagens/minuto.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. true: Chamada bem-sucedida. false: Falha na chamada.

Exemplos

Exemplos de solicitações

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryConsumerGroupStatus
&GroupId=nJRaJPn5U1JITGf******
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<QueryConsumerGroupStatusResponse>
  <ClientConnectionStatusList>
        <ConsumerGroupClientConnectionInfo>
              <ClientId>12345-1</ClientId>
              <AccumulatedConsumeCountPerMinute>8</AccumulatedConsumeCountPerMinute>
              <OnlineTime>1627624830193</OnlineTime>
              <ClientIpPort>192.168.1.2:55545</ClientIpPort>
              <RealTimeConsumeCountPerMinute>16</RealTimeConsumeCountPerMinute>
        </ConsumerGroupClientConnectionInfo>
        <ConsumerGroupClientConnectionInfo>
              <ClientId>12345-0</ClientId>
              <AccumulatedConsumeCountPerMinute>10</AccumulatedConsumeCountPerMinute>
              <OnlineTime>1627624829763</OnlineTime>
              <ClientIpPort>192.168.1.2:55526</ClientIpPort>
              <RealTimeConsumeCountPerMinute>14</RealTimeConsumeCountPerMinute>
        </ConsumerGroupClientConnectionInfo>
  </ClientConnectionStatusList>
  <RequestId>4EC250E4-70CE-546E-9D4A-31D06E04EAD8</RequestId>
  <AccumulatedConsumeCountPerMinute>10</AccumulatedConsumeCountPerMinute>
  <Success>true</Success>
  <RealTimeConsumeCountPerMinute>14</RealTimeConsumeCountPerMinute>
  <AccumulationCount>26</AccumulationCount>
  <ConsumerSpeed>14</ConsumerSpeed>
</QueryConsumerGroupStatusResponse>

Formato JSON

{
    "ClientConnectionStatusList": {
        "ConsumerGroupClientConnectionInfo": [
            {
                "ClientId": "12345-1",
                "AccumulatedConsumeCountPerMinute": 8,
                "OnlineTime": 1627624830193,
                "ClientIpPort": "192.168.1.2:55545",
                "RealTimeConsumeCountPerMinute": 16
            },
            {
                "ClientId": "12345-0",
                "AccumulatedConsumeCountPerMinute": 10,
                "OnlineTime": 1627624829763,
                "ClientIpPort": "192.168.1.2:55526",
                "RealTimeConsumeCountPerMinute": 14
            }
        ]
    },
    "RequestId": "4EC250E4-70CE-546E-9D4A-31D06E04EAD8",
    "AccumulatedConsumeCountPerMinute": 10,
    "Success": true,
    "RealTimeConsumeCountPerMinute": 14,
    "AccumulationCount": 26,
    "ConsumerSpeed": 14
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.