QueryConsumerGroupStatus - IoT Platform - Centro de documentación de Alibaba Cloud

Consulta el estado de un grupo de consumidores al usar una suscripción del lado del servidor AMQP. La información de estado incluye datos de los clientes en línea, la tasa de consumo de mensajes, la cantidad de mensajes acumulados y la hora del último consumo.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 5 consultas por segundo (QPS).

Nota

Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda ejecutar esta operación en OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryConsumerGroupStatus	La operación que se desea ejecutar. Establezca el valor en QueryConsumerGroupStatus.
GroupId	String	Sí	nJRaJPn5U1JITGf******	El ID del grupo de consumidores. Tras ejecutar la operación CreateConsumerGroup para crear un grupo de consumidores, se devuelve su ID. Ejecute la operación QueryConsumerGroupList para consultar el ID del grupo de consumidores por nombre. También puede ir a la consola de IoT Platform,y elegir Rules > Server-side Subscription > Consumer Groups para consultar el ID del grupo de consumidores.
IotInstanceId	String	No	iot-cn-0pp1n8t****	El ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, configure este parámetro. De lo contrario, la llamada fallará. Si su instancia no tiene página de Overview ni ID, no es necesario establecer este parámetro. Para obtener más información, consulte Descripción general.

Además de los parámetros de solicitud específicos de la operación mencionados anteriormente, especifique los parámetros de solicitud comunes al ejecutar esta operación. Para obtener más información, consulte Parámetros de solicitud comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
AccumulatedConsumeCountPerMinute	Integer	10	La tasa de consumo de mensajes. Unidad: mensajes/minuto.
AccumulationCount	Integer	13	La cantidad de mensajes acumulados.
ClientConnectionStatusList	Array of ConsumerGroupClientConnectionInfo		Los detalles del cliente. Para obtener más información, consulte ConsumerGroupClientConnectionInfo.
ConsumerGroupClientConnectionInfo
AccumulatedConsumeCountPerMinute	Integer	10	La tasa de consumo de mensajes acumulados en un solo cliente del grupo de consumidores. Unidad: mensajes/minuto.
ClientId	String	868575026******	El ID del cliente.
ClientIpPort	String	192.168.1.2:36918	La dirección IP y el puerto del cliente.
OnlineTime	Long	1591240546649	La última vez que el cliente estuvo en línea. Este valor es una marca de tiempo UNIX que representa el número de milisegundos transcurridos desde la época (1 de enero de 1970, 00:00:00 UTC).
RealTimeConsumeCountPerMinute	Integer	5	La tasa de consumo de mensajes en tiempo real en un solo cliente del grupo de consumidores. Unidad: mensajes/minuto.
Code	String	iot.system.SystemException	El código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
ConsumerSpeed	Integer	14	La tasa de consumo de mensajes del grupo de consumidores. Unidad: mensajes/minuto.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
LastConsumerTime	String	2020-05-29T03:37:56.000Z	La hora en que se consumió el último mensaje. El formato de la hora es yyyy-MM-dd'T'HH:mm:ss.SSSZ. Se muestra en UTC con precisión de milisegundos.
RealTimeConsumeCountPerMinute	Integer	14	La tasa de consumo de mensajes en tiempo real en el grupo de consumidores. Unidad: mensajes/minuto.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada se ejecutó correctamente. true: La llamada se ejecutó correctamente. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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 error

Para obtener una lista de códigos de error, visite el Centro de errores de API.