ListConsumerConnections - - Centre de documentation Alibaba Cloud

Obtient les informations de connexion des clients d'un groupe de consommateurs spécifié.

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

list

*ConsumerGroup

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

Aucune

Syntaxe de la requête

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

Paramètres de chemin

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

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
topicName	string	Non	Le nom du sujet Lite.	test1
liteTopicName	string	Non	Le nom du sujet Lite MSMQ.	abc

Éléments de réponse

Élément	Type	Description	Exemple
	object	Résultat.
requestId	string	L'identifiant de la requête.	A3620115-6F1F-5CFB-AA3F-BBD4853B2EC4
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
connections	array<object>	La liste des connexions client.
	object	La liste des connexions client.
clientId	string	The client ID.	172.17.135.197@17392#1936705963#551717232#9873695589062458
hostname	string	The client hostname.	vos
egressIp	string	The host IP address or Internet egress IP address.	xx.xx.xx.xx
language	string	The client language.	java
version	string	The client version.	1.0
messageModel	string	The consumption mode of the consumer: CLUSTERING LITE_SELECTIVE BROADCASTING	BROADCASTING
code	string	Le code d'erreur.	MissingPageNumber
message	string	Le message d'erreur.	L'instance est introuvable
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": "A3620115-6F1F-5CFB-AA3F-BBD4853B2EC4",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "consumerGroupId": "CID-TEST",
    "connections": [
      {
        "clientId": "172.17.135.197@17392#1936705963#551717232#9873695589062458",
        "hostname": "vos",
        "egressIp": "xx.xx.xx.xx",
        "language": "java",
        "version": "1.0",
        "messageModel": "BROADCASTING"
      }
    ]
  },
  "code": "MissingPageNumber",
  "message": "The instance cannot be found.",
  "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.