OnsConsumerAccumulate - - Centre de documentation Alibaba Cloud

Consulte l'accumulation de messages pour un identifiant de groupe spécifié. Les résultats incluent le nombre de messages accumulés et la latence de consommation.

Description de l'opération

Important L'OpenAPI d'Alibaba Cloud est une API de gestion utilisée pour gérer et interroger les ressources des services Alibaba Cloud. Intégrez cette API uniquement dans votre chaîne de données de gestion. N'utilisez pas cette API dans la chaîne de données principale pour l'envoi et la réception de messages afin d'éviter les menaces potentielles.

Vous pouvez utiliser la requête d'accumulation de messages dans un environnement de production pour surveiller la progression de la consommation d'un identifiant de groupe. Cela permet de décrire l'état et la latence de la consommation des messages. Vous pouvez interroger l'accumulation de messages pour tous les topics auxquels l'identifiant de groupe est abonné, ou pour chaque topic individuellement.

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

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 du groupe que vous souhaitez interroger.	GID_test_consumer_id
Detail	boolean	Non	Indique s'il faut interroger les détails de chaque topic. Valeurs valides : true : interroge les détails. Les détails sont renvoyés dans le paramètre DetailInTopicList. false : n'interroge pas les détails. Il s'agit de la valeur par défaut. Le paramètre DetailInTopicList renvoie un résultat vide.	true
InstanceId	string	Non	L'identifiant de l'instance.	MQ_INST_111111111111_DOxxxxxx

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête. Il s'agit d'un paramètre commun. Chaque requête possède un identifiant unique. Utilisez cet identifiant pour localiser et résoudre les problèmes.	CE817BFF-B389-43CD-9419-95011AC9****
Data	object	L'accumulation de messages du consommateur spécifié.
ConsumeTps	number	Le TPS total de consommation de messages pour le groupe d'instances de consommation qui appartiennent à l'identifiant de groupe spécifié.	10
DelayTime	integer	La latence maximale de consommation de messages pour l'identifiant de groupe. Cette valeur correspond à la latence de consommation la plus longue parmi tous les topics auxquels l'identifiant de groupe est abonné. Unité : millisecondes.	10000
LastTimestamp	integer	L'heure de production du message consommé le plus récemment dans le groupe d'instances de consommation qui appartiennent à l'identifiant de groupe spécifié. Unité : horodatage Unix en millisecondes.	1566231000000
TotalDiff	integer	Le nombre de messages accumulés pour tous les topics auxquels l'identifiant de groupe est abonné.	100
Online	boolean	Indique si une instance de consommation est en ligne sous cet identifiant de groupe. Si au moins une instance de consommation est en ligne, l'identifiant de groupe est considéré comme en ligne. Valeurs valides : true : en ligne false : hors ligne	true
DetailInTopicList	object
DetailInTopicDo	array<object>	The details of each topic. If the Detail parameter in the request is set to false, this parameter returns empty.
	object
DelayTime	integer	The maximum message consumption latency in this topic. This is the time difference between the ready time of the earliest unconsumed message in the topic and the current time. Unit: milliseconds.	10000
TotalDiff	integer	The number of stacked messages in the topic.	100
LastTimestamp	integer	The production time of the most recently consumed message in the topic. Unit: Unix timestamp in milliseconds.	1566231000000
Topic	string	The topic name.	test-mq-topic

Exemples

JSON format

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

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.