OnsConsumerAccumulate - - Centro de documentación de Alibaba Cloud

Consulta la información sobre la acumulación de mensajes en los topics a los que está suscrito un grupo de consumidores específico. La información devuelta incluye el número de mensajes en cola y la latencia de consumo.

Nota

Esta operación es útil cuando necesita conocer el progreso de consumo de mensajes de un grupo de consumidores determinado. A partir de la respuesta, obtiene datos sobre el consumo de mensajes y la latencia asociada. La operación devuelve el número total de mensajes en cola de todos los topics a los que está suscrito el grupo de consumidores, así como el recuento individual por cada topic.

Nota

Si desea consultar la información de consumo de mensajes de cada consumidor en línea dentro de un grupo de consumidores, llame a la operación

OnsConsumerStatus.

Límite de solicitudes

Cada cuenta de Alibaba Cloud puede invocar esta operación hasta 10 veces por segundo. Si el número de solicitudes enviadas en un segundo alcanza este límite, las nuevas solicitudes fallarán, lo cual podría interrumpir su servicio. Para más información sobre los límites de solicitud de cada operación, consulte Límites de solicitudes de API.

Autorización

Las cuentas de Alibaba Cloud pueden invocar esta operación de forma predeterminada. Un usuario de Resource Access Management (RAM) solo podrá hacerlo si cuenta con los permisos necesarios. La siguiente tabla describe los permisos que se deben otorgar al usuario de RAM para ejecutar esta operación. Para obtener detalles sobre cómo asignar permisos, consulte Directivas.

API

Action

Recurso en una instancia con namespace

Recurso en una instancia sin namespace

OnsConsumerAccumulate

mq:QueryInstanceBaseInfo

mq:QueryConsumerAccumulate

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

acs:mq:::{groupId}

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	OnsConsumerAccumulate	La operación que se va a realizar. Establezca el valor en OnsConsumerAccumulate.
GroupId	String	Sí	GID_test_consumer_id	El ID del grupo de consumidores que desea consultar.
Detail	Boolean	No	true	Especifique si se deben consultar los detalles de cada topic al que está suscrito el grupo de consumidores. Valores válidos: true: Se consultan los detalles de cada topic. Puede obtenerlos mediante el parámetro de respuesta DetailInTopicList. false: No se consultan los detalles de cada topic. Este es el valor predeterminado. Si especifica este valor, el parámetro de respuesta DetailInTopicList estará vacío.
InstanceId	String	Sí	MQ_INST_111111111111_DOxxxxxx	El ID de la instancia a la que pertenece el grupo de consumidores especificado.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	CE817BFF-B389-43CD-9419-95011AC9****	El ID de la solicitud. El sistema genera un ID único para cada solicitud. Puede utilizar este ID para solucionar problemas.
Data	Object		Información sobre la acumulación de mensajes en los topics a los que está suscrito el grupo de consumidores.
ConsumeTps	Float	10	Transacciones por segundo (TPS) de consumo de mensajes de los consumidores del grupo.
DelayTime	Long	10000	Latencia de consumo del grupo de consumidores.
LastTimestamp	Long	1566231000000	Momento en que se produjo el último mensaje consumido por un consumidor del grupo.
TotalDiff	Long	100	Número total de mensajes en cola en todos los topics a los que está suscrito el grupo de consumidores.
Online	Boolean	true	Indica si el grupo de consumidores está en línea. El grupo se considera en línea si al menos uno de sus consumidores lo está. Valores válidos: true: El grupo de consumidores está en línea. false: El grupo de consumidores está fuera de línea.
DetailInTopicList	Array of DetailInTopicDo		Información detallada de cada topic al que está suscrito el grupo de consumidores. Si el parámetro Detail de la solicitud se establece en false, el valor de este parámetro estará vacío.
DetailInTopicDo
DelayTime	Long	10000	Latencia máxima de consumo de mensajes en el topic.
TotalDiff	Long	100	Número de mensajes en cola en el topic.
LastTimestamp	Long	1566231000000	Momento en que se produjo el último mensaje consumido en el topic.
Topic	String	test-mq-topic	Nombre del topic.

Ejemplos

Solicitudes de ejemplo

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

Respuestas correctas de ejemplo

Formato XML

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>

Formato JSON

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 error

Para consultar la lista de códigos de error, visite el Centro de errores de API.

Consultar la información de acumulación de mensajes en la consola

En la Message Queue for Apache RocketMQ console, puede consultar la información sobre la acumulación de mensajes en los topics a los que está suscrito un grupo de consumidores. Para más información, consulte Consultar el estado de los consumidores.