OnsConsumerAccumulate - ApsaraMQ for RocketMQ - Centro de documentación de Alibaba Cloud

Consulta la acumulación de mensajes para un ID de grupo especificado. Los resultados incluyen el número de mensajes acumulados y la latencia de consumo.

Descripción de la operación

Importante La OpenAPI de Alibaba Cloud es una API de gestión que se utiliza para administrar y consultar recursos de servicios de Alibaba Cloud. Integre esta API únicamente en su enlace de datos de gestión. No utilice esta API en el enlace de datos principal para enviar y recibir mensajes, a fin de evitar posibles amenazas.

Puede utilizar la consulta de acumulación de mensajes en un entorno de producción para monitorear el progreso de consumo de un ID de grupo. Esto describe el estado y la latencia del consumo de mensajes. Puede consultar la acumulación de mensajes para todos los temas a los que está suscrito el ID de grupo, o para cada tema individualmente.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

mq:QueryConsumerAccumulate

get

Group

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

Group

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

Ninguna

mq:OnsInstanceBaseInfo

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
GroupId	string	Sí	El ID del grupo que desea consultar.	GID_test_consumer_id
Detail	boolean	No	Especifica si se deben consultar los detalles de cada tema. Valores válidos: true: Consulta los detalles. Los detalles se devuelven en el parámetro DetailInTopicList. false: No consulta los detalles. Este es el valor predeterminado. El parámetro DetailInTopicList se devuelve vacío.	true
InstanceId	string	No	El ID de la instancia.	MQ_INST_111111111111_DOxxxxxx

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud. Este es un parámetro común. Cada solicitud tiene un ID único. Utilice este ID para localizar y solucionar problemas.	CE817BFF-B389-43CD-9419-95011AC9****
Data	object	La acumulación de mensajes del consumidor especificado.
ConsumeTps	number	El TPS total de consumo de mensajes para el grupo de instancias consumidoras que pertenecen al ID de grupo especificado.	10
DelayTime	integer	La latencia máxima de consumo de mensajes para el ID de grupo. El valor corresponde a la mayor latencia de consumo entre todos los temas a los que está suscrito el ID de grupo. Unidad: milisegundos.	10000
LastTimestamp	integer	La hora de producción del mensaje consumido más recientemente en el grupo de instancias consumidoras que pertenecen al ID de grupo especificado. Unidad: marca de tiempo Unix en milisegundos.	1566231000000
TotalDiff	integer	El número de mensajes acumulados para todos los temas a los que está suscrito el ID de grupo.	100
Online	boolean	Indica si hay una instancia consumidora en línea bajo este ID de grupo. Si al menos una instancia consumidora está en línea, se considera que el ID de grupo está en línea. Valores válidos: true: En línea false: Fuera de línea	true
DetailInTopicList	object
DetailInTopicDo	array<object>	Los detalles de cada tema. Si el parámetro Detail en la solicitud se establece en false, este parámetro se devuelve vacío.
	object
DelayTime	integer	La latencia máxima de consumo de mensajes en este tema. Es la diferencia de tiempo entre la hora de disponibilidad del mensaje no consumido más antiguo en el tema y la hora actual. Unidad: milisegundos.	10000
TotalDiff	integer	El número de mensajes acumulados en el tema.	100
LastTimestamp	integer	La hora de producción del mensaje consumido más recientemente en el tema. Unidad: marca de tiempo Unix en milisegundos.	1566231000000
Topic	string	El nombre del tema.	test-mq-topic

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "CE817BFF-B389-43CD-9419-95011AC9****",
  "Data": {
    "ConsumeTps": 10,
    "DelayTime": 10000,
    "LastTimestamp": 1566231000000,
    "TotalDiff": 100,
    "Online": true,
    "DetailInTopicList": {
      "DetailInTopicDo": [
        {
          "DelayTime": 10000,
          "TotalDiff": 100,
          "LastTimestamp": 1566231000000,
          "Topic": "test-mq-topic"
        }
      ]
    }
  }
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.