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

Esta operación consulta datos de estado detallados para un ID de grupo especificado, incluidas verificaciones de relaciones de suscripción, estadísticas de TPS de consumo, estado de balanceo de carga y conexiones del lado del consumidor.

Descripción de la operación

Importante

Las OpenAPI de Alibaba Cloud son API de gestión. Permiten gestionar y consultar recursos de Alibaba Cloud. Úselas únicamente en flujos de trabajo de gestión. No dependa de las OpenAPI en flujos de trabajo principales de publicación o consumo de mensajes, ya que esto puede introducir riesgos.

Puede utilizar esta operación para solucionar problemas de consumo anómalo después de confirmar la acumulación de mensajes o el estado de conexión del cliente. La respuesta le ayuda a verificar la consistencia de las relaciones de suscripción para un ID de grupo especificado, confirmar que el balanceo de carga es normal y obtener información de Jstack de los clientes conectados.
Esta operación invoca múltiples interfaces de backend para agregar datos, lo que puede causar una ejecución lenta. Por lo tanto, evite realizar llamadas frecuentes.

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:QueryConsumerStatus

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 de consumidores que se va a consultar.	GID_test_group_id
Detail	boolean	No	Indica si se debe devolver información detallada. Valores válidos: true: Devuelve información detallada, incluida ConsumerConnectionInfoList y DetailInTopicList. false: Valor predeterminado. No devuelve información detallada. ConsumerConnectionInfoList y DetailInTopicList están vacíos.	true
NeedJstack	boolean	No	Indica si se debe imprimir la información de Jstack. Valores válidos: true: Imprime la información de Jstack. Obtenga el seguimiento de pila desde el campo de respuesta Jstack. Nota Para imprimir la información de Jstack, establezca el parámetro de solicitud Detail en true. false: Valor predeterminado. No imprime la información de Jstack. El campo de respuesta Jstack está vacío.	true
InstanceId	string	No	El ID de la instancia asociado con el ID de grupo que se va a consultar.	MQ_INST_111111111111_DOxxxxxx

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	Un parámetro común. Cada solicitud tiene un ID único. Utilícelo para localizar y solucionar problemas.	10EDC518-10E7-4B34-92FB-171235FA****
Data	object	El resultado de la consulta.
ConsumeTps	number	TPS total de consumo.	0
ConsumeModel	string	El modelo de consumo. Valores válidos: CLUSTERING: Modo de consumo por clúster BROADCASTING: Modo de consumo por difusión Para obtener más información sobre estos modos de suscripción, consulte Consumo por clúster y por difusión.	CLUSTERING
ConnectionSet	object
ConnectionDo	array<object>	Información sobre los clientes actualmente conectados en el clúster.
	object
RemoteIP	string	La dirección IP del host o la dirección IP pública.	42.120.74.**
Version	string	La versión del consumidor.	V4_3_6_SNAPSHOT
ClientAddr	string	La dirección y el puerto de la instancia consumidora.	30.5.121.**
Language	string	El lenguaje del consumidor.	JAVA
ClientId	string	El ID de la instancia consumidora.	30.5.121.**@25560#-1999745829#-1737591554#458773089270275
Diff	integer		100
TotalDiff	integer	Acumulación total de mensajes en todo el clúster.	197
ConsumerConnectionInfoList	object
ConsumerConnectionInfoDo	array<object>	Información detallada sobre los clientes conectados en el clúster, incluidos Jstack y RT de consumo. Para obtener esta información, establezca el parámetro de solicitud Detail en true. De lo contrario, la respuesta estará vacía.
	array<object>	prueba, este contenido no se publica en ICMS.
ConsumeModel	string	El modelo de consumo. Valores válidos: CLUSTERING: Modo de consumo por clúster BROADCASTING: Modo de consumo por difusión Para obtener más información sobre estos modos de suscripción, consulte Consumo por clúster y por difusión.	CLUSTERING
RunningDataList	object
ConsumerRunningDataDo	array<object>	Estadísticas de estado en tiempo real.
	object
Rt	number	Tiempo de respuesta (RT) de consumo, en milisegundos.	0
Topic	string	El nombre del topic suscrito.	test-mq_topic
FailedCountPerHour	integer	Número de mensajes que fallaron al consumirse por hora.	0
OkTps	number	TPS de mensajes consumidos correctamente.	0
FailedTps	number	TPS de mensajes que fallaron al consumirse.	0
SubscriptionSet	object
SubscriptionData	array<object>	La colección de relaciones de suscripción.
	array<object>
SubString	string	La expresión de etiqueta utilizada para suscribirse al topic.	*
SubVersion	integer	El número de versión de la relación de suscripción. Es un entero largo de incremento automático.	1570701364301
Topic	string	El nombre del topic suscrito.	test-mq_topic
TagsSet	object
Tag	array	La colección de etiquetas suscritas.
	string	La colección de etiquetas suscritas.	ff
Jstack	object
ThreadTrackDo	array<object>	Seguimiento de pila de Jstack. Para obtener información de Jstack, establezca el parámetro de solicitud NeedJstack en true. De lo contrario, la respuesta estará vacía.
	array<object>	prueba—este contenido no se publica en ICMS.
TrackList	object
Track	array	La cadena de seguimiento de pila de Jstack.
	string	La cadena de seguimiento de pila de Jstack.	TID: 52 STATE: WAITING
Thread	string	El nombre del hilo.	ConsumeMessageThread_0
LastTimeStamp	integer	La marca de tiempo de la última operación de consumo. Este valor utiliza marcas de tiempo Unix a nivel de milisegundos.	1570701368114
StartTimeStamp	integer	La marca de tiempo en la que comenzó el consumo. Este valor utiliza marcas de tiempo Unix a nivel de milisegundos.	1570701361528
Language	string	El lenguaje del cliente.	JAVA
ClientId	string	El ID de la instancia consumidora.	30.5..@25560#-1999745829#-1737591554#458773089270275
Connection	string	La información de conexión.	**
Version	string	El número de versión del cliente.	V4_3_6
ConsumeType	string	El modo de consumo de mensajes. Valores válidos: PUSH: ApsaraMQ for RocketMQ envía mensajes a los consumidores. PULL: Los consumidores obtienen mensajes de ApsaraMQ for RocketMQ.	PUSH
ThreadCount	integer	El número de hilos de consumo.	20
InstanceId	string	El ID de la instancia.	MQ_INST_111111111111_DOxxxxxx
DetailInTopicList	object
DetailInTopicDo	array<object>	Detalles de consumo para cada topic. Para obtener esta información, establezca el parámetro de solicitud Detail en true. De lo contrario, la respuesta estará vacía.
	object
DelayTime	integer	El tiempo de retraso de consumo para el topic especificado, en milisegundos.	0
TotalDiff	integer	La acumulación total de mensajes para el topic.	0
LastTimestamp	integer	La marca de tiempo de la última operación de consumo. Este valor utiliza marcas de tiempo Unix a nivel de milisegundos.	1570701259403
Topic	string	El nombre del topic.	test-mq_topic
SubscriptionSame	boolean	Indica si las relaciones de suscripción son consistentes.	true
DelayTime	integer	El tiempo máximo de retraso de consumo en todos los topics suscritos por el ID de grupo especificado, en milisegundos.	100857
LastTimestamp	integer	La marca de tiempo de la última operación de consumo. Este valor utiliza marcas de tiempo Unix a nivel de milisegundos.	1566883844954
Online	boolean	Indica si el cliente está conectado.	true
RebalanceOK	boolean	Indica si el rebalanceo es normal. Valores válidos: true: Normal false: Anómalo	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "10EDC518-10E7-4B34-92FB-171235FA****",
  "Data": {
    "ConsumeTps": 0,
    "ConsumeModel": "CLUSTERING",
    "ConnectionSet": {
      "ConnectionDo": [
        {
          "RemoteIP": "42.120.74.**",
          "Version": "V4_3_6_SNAPSHOT",
          "ClientAddr": "30.5.121.**",
          "Language": "JAVA",
          "ClientId": "30.5.121.**@25560#-1999745829#-1737591554#458773089270275",
          "Diff": 100
        }
      ]
    },
    "TotalDiff": 197,
    "ConsumerConnectionInfoList": {
      "ConsumerConnectionInfoDo": [
        {
          "ConsumeModel": "CLUSTERING",
          "RunningDataList": {
            "ConsumerRunningDataDo": [
              {
                "Rt": 0,
                "Topic": "test-mq_topic",
                "FailedCountPerHour": 0,
                "OkTps": 0,
                "FailedTps": 0
              }
            ]
          },
          "SubscriptionSet": {
            "SubscriptionData": [
              {
                "SubString": "*",
                "SubVersion": 1570701364301,
                "Topic": "test-mq_topic",
                "TagsSet": {
                  "Tag": [
                    "ff"
                  ]
                }
              }
            ]
          },
          "Jstack": {
            "ThreadTrackDo": [
              {
                "TrackList": {
                  "Track": [
                    "TID: 52 STATE: WAITING"
                  ]
                },
                "Thread": "ConsumeMessageThread_0"
              }
            ]
          },
          "LastTimeStamp": 1570701368114,
          "StartTimeStamp": 1570701361528,
          "Language": "JAVA",
          "ClientId": "30.5.**.**@25560#-1999745829#-1737591554#458773089270275",
          "Connection": "**",
          "Version": "V4_3_6",
          "ConsumeType": "PUSH",
          "ThreadCount": 20
        }
      ]
    },
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "DetailInTopicList": {
      "DetailInTopicDo": [
        {
          "DelayTime": 0,
          "TotalDiff": 0,
          "LastTimestamp": 1570701259403,
          "Topic": "test-mq_topic"
        }
      ]
    },
    "SubscriptionSame": true,
    "DelayTime": 100857,
    "LastTimestamp": 1566883844954,
    "Online": true,
    "RebalanceOK": true
  }
}

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.