GetConsumerGroupLag - - Centre de documentation Alibaba Cloud

Consulte l'accumulation de messages d'un groupe de consommateurs.

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.

rocketmq:GetConsumerGroupLag

get

*ConsumerGroup

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}

Aucune

Syntaxe de la requête

GET /instances/{instanceId}/consumerGroups/{consumerGroupId}/lag HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Oui	L'identifiant de l'instance.	rmq-cn-2r42vrvde0j
consumerGroupId	string	Oui	L'identifiant du groupe de consommateurs.	CID-TEST

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
topicName	string	Non	Le nom du topic auquel le groupe de consommateurs est abonné.	normal-topic-1
liteTopicName	string	Non	Le nom du topic lite.	abc

Éléments de réponse

Élément	Type	Description	Exemple
	object	Result<ConsumerGroupLagDto>
requestId	string	L'identifiant de la requête.	F5764C40-FB8C-53AE-B95D-96AB3D0E9375
success	boolean	Indique si la requête a réussi.	true
data	object	Les données renvoyées.
regionId	string	L'identifiant de la région.	cn-hangzhou
instanceId	string	L'identifiant de l'instance.	rmq-cn-7e22ody****
consumerGroupId	string	L'identifiant du groupe de consommateurs.	CID-TEST
totalLag	object	L'accumulation totale de messages.
readyCount	integer	The number of ready messages.	1
inflightCount	integer	The number of inflight messages.	1
deliveryDuration	integer	The delivery latency. Unit: seconds.	12
lastConsumeTimestamp	integer	The timestamp of the last consumption.	1735629607846
topicLagMap	object	L'accumulation de messages pour chaque topic.
	object	Les détails de l'accumulation de messages.
readyCount	integer	The number of ready messages.	1
inflightCount	integer	The number of inflight messages.	1
deliveryDuration	integer	The delivery latency. Unit: seconds.	12
lastConsumeTimestamp	integer	The timestamp of the last consumption.	1735629607846
topicName	string	Le nom du topic abonné.	test1
liteTopicLagMap	object	L'accumulation de messages pour les topics lite.
	object	L'accumulation de messages pour le topic lite.
readyCount	integer	The number of accumulated messages.	300
deliveryDuration	integer	The delivery latency. Unit: seconds.	30
code	string	Le code d'erreur.	Topic.NotFound
message	string	Le message d'erreur.	Le paramètre instanceId est obligatoire pour cette action
httpStatusCode	integer	Le code d'état HTTP.	200
dynamicCode	string	Le code d'erreur dynamique.	InstanceId
dynamicMessage	string	Le message d'erreur dynamique.	instanceId

Exemples

JSON format

{
  "requestId": "F5764C40-FB8C-53AE-B95D-96AB3D0E9375",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "consumerGroupId": "CID-TEST",
    "totalLag": {
      "readyCount": 1,
      "inflightCount": 1,
      "deliveryDuration": 12,
      "lastConsumeTimestamp": 1735629607846
    },
    "topicLagMap": {
      "key": {
        "readyCount": 1,
        "inflightCount": 1,
        "deliveryDuration": 12,
        "lastConsumeTimestamp": 1735629607846
      }
    },
    "topicName": "test1",
    "liteTopicLagMap": {
      "key": {
        "readyCount": 300,
        "deliveryDuration": 30
      }
    }
  },
  "code": "Topic.NotFound",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.