OnsConsumerStatus - - Centre de documentation Alibaba Cloud

Consulte les données d'état détaillées d'un identifiant de groupe spécifié, notamment les vérifications des relations d'abonnement, les statistiques de TPS de consommation, l'état de l'équilibrage de charge et les connexions côté consommateur.

Description de l'opération

Important

Les OpenAPI d'Alibaba Cloud sont des API de gestion. Elles permettent de gérer et d'interroger les ressources d'Alibaba Cloud. Utilisez-les uniquement dans les flux de travail de gestion. Ne vous appuyez pas sur les OpenAPI dans les flux de travail principaux de publication ou de consommation de messages. Cela pourrait introduire des risques.

Vous pouvez utiliser cette opération pour dépanner une consommation anormale après avoir confirmé l'accumulation de messages ou l'état en ligne du client. La réponse vous aide à vérifier la cohérence des relations d'abonnement pour un identifiant de groupe spécifié, à confirmer le bon fonctionnement de l'équilibrage de charge et à récupérer les informations Jstack pour les clients en ligne.
Cette opération appelle de nombreuses interfaces backend pour agréger les données, ce qui peut ralentir son exécution. Par conséquent, évitez les appels fréquents.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

mq:QueryConsumerStatus

get

Group

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

Group

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

Aucune

mq:OnsInstanceBaseInfo

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
GroupId	string	Oui	L'identifiant de groupe du consommateur à interroger.	GID_test_group_id
Detail	boolean	Non	Indique si des informations détaillées doivent être renvoyées. Valeurs valides : true : renvoie des informations détaillées, y compris ConsumerConnectionInfoList et DetailInTopicList. false : valeur par défaut. Ne renvoie pas d'informations détaillées. ConsumerConnectionInfoList et DetailInTopicList sont vides.	true
NeedJstack	boolean	Non	Indique si les informations Jstack doivent être imprimées. Valeurs valides : true : imprime les informations Jstack. Récupérez la trace de pile à partir du champ de réponse Jstack. Remarque Pour imprimer les informations Jstack, définissez le paramètre de requête Detail sur true. false : valeur par défaut. N'imprime pas les informations Jstack. Le champ de réponse Jstack est vide.	true
InstanceId	string	Non	L'identifiant de l'instance associée à l'identifiant de groupe à interroger.	MQ_INST_111111111111_DOxxxxxx

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	Un paramètre commun. Chaque requête possède un identifiant unique. Utilisez-le pour localiser et dépanner les problèmes.	10EDC518-10E7-4B34-92FB-171235FA****
Data	object	Le résultat de la requête.
ConsumeTps	number	Le TPS total de consommation.	0
ConsumeModel	string	Le modèle de consommation. Valeurs valides : CLUSTERING : mode de consommation par clustering BROADCASTING : mode de consommation par broadcasting Pour plus d'informations sur ces modes d'abonnement, consultez Consommation par clustering et broadcasting.	CLUSTERING
ConnectionSet	object
ConnectionDo	array<object>	Information about currently online clients in the cluster.
	object
RemoteIP	string	The host IP address or public IP address.	42.120.74.**
Version	string	The consumer version.	V4_3_6_SNAPSHOT
ClientAddr	string	The address and port of the consumer instance.	30.5.121.**
Language	string	The consumer language.	JAVA
ClientId	string	The ID of the consumer instance.	30.5.121.**@25560#-1999745829#-1737591554#458773089270275
Diff	integer		100
TotalDiff	integer	L'accumulation totale de messages dans l'ensemble du cluster.	197
ConsumerConnectionInfoList	object
ConsumerConnectionInfoDo	array<object>	Detailed information about online clients in the cluster, including Jstack and consumption RT. To get this information, set the Detail request parameter to true. Otherwise, the response is empty.
	array<object>	test, this content is not published to ICMS
ConsumeModel	string	The consumption model. Valid values: CLUSTERING: Clustering consumption mode BROADCASTING: Broadcasting consumption mode For more information about these subscription modes, see Clustering and broadcasting consumption.	CLUSTERING
RunningDataList	object
ConsumerRunningDataDo	array<object>	Real-time status statistics.
	object
Rt	number	Consumption response time (RT), in milliseconds.	0
Topic	string	The name of the subscribed topic.	test-mq_topic
FailedCountPerHour	integer	Number of messages that failed to consume per hour.	0
OkTps	number	TPS for successfully consumed messages.	0
FailedTps	number	TPS for messages that failed to consume.	0
SubscriptionSet	object
SubscriptionData	array<object>	The collection of subscription relationships.
	array<object>
SubString	string	The tag expression used to subscribe to the topic.	*
SubVersion	integer	The subscription relationship version number. This is an auto-incrementing long integer.	1570701364301
Topic	string	The name of the subscribed topic.	test-mq_topic
TagsSet	object
Tag	array	The collection of subscribed tags.
	string	The collection of subscribed tags.	ff
Jstack	object
ThreadTrackDo	array<object>	Jstack stack trace. To get Jstack information, set the NeedJstack request parameter to true. Otherwise, the response is empty.
	array<object>	test—this content is not published to ICMS
TrackList	object
Track	array	The Jstack stack trace string.
	string	The Jstack stack trace string.	TID: 52 STATE: WAITING
Thread	string	The thread name.	ConsumeMessageThread_0
LastTimeStamp	integer	The timestamp of the last consumption. This value uses millisecond-level Unix timestamps.	1570701368114
StartTimeStamp	integer	The timestamp when consumption started. This value uses millisecond-level Unix timestamps.	1570701361528
Language	string	The client language.	JAVA
ClientId	string	The ID of the consumer instance.	30.5..@25560#-1999745829#-1737591554#458773089270275
Connection	string	The connection information.	**
Version	string	The client version number.	V4_3_6
ConsumeType	string	The message consumption mode. Valid values: PUSH: ApsaraMQ for RocketMQ pushes messages to consumers. PULL: Consumers pull messages from ApsaraMQ for RocketMQ.	PUSH
ThreadCount	integer	The number of consumption threads.	20
InstanceId	string	L'identifiant de l'instance.	MQ_INST_111111111111_DOxxxxxx
DetailInTopicList	object
DetailInTopicDo	array<object>	Consumption details for each topic. To get this information, set the Detail request parameter to true. Otherwise, the response is empty.
	object
DelayTime	integer	The consumption delay time for the specified topic, in milliseconds.	0
TotalDiff	integer	The total message accumulation for the topic.	0
LastTimestamp	integer	The timestamp of the last consumption. This value uses millisecond-level Unix timestamps.	1570701259403
Topic	string	The topic name.	test-mq_topic
SubscriptionSame	boolean	Indique si les relations d'abonnement sont cohérentes.	true
DelayTime	integer	Le délai de consommation maximal pour tous les topics auxquels l'identifiant de groupe spécifié est abonné, en millisecondes.	100857
LastTimestamp	integer	L'horodatage de la dernière consommation. Cette valeur utilise des horodatages Unix de niveau milliseconde.	1566883844954
Online	boolean	Indique si le client est en ligne.	true
RebalanceOK	boolean	Indique si le rééquilibrage est normal. Valeurs valides : true : normal false : anormal	true

Exemples

JSON format

{
  "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
  }
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.