ListConsumerGroups - - Centre de documentation Alibaba Cloud

Consulte la liste des groupes de consommateurs d'une instance spécifiée.

Description de l'opération

Important L'OpenAPI fournie par Alibaba Cloud est une API de gestion et de contrôle utilisée pour gérer et interroger les ressources associées aux services Alibaba Cloud. Son utilisation est recommandée uniquement pour l'intégration dans les chaînes de gestion et de contrôle. L'utilisation de l'OpenAPI dans la chaîne de données principale pour l'envoi et la réception de messages est strictement interdite. Dans le cas contraire, des risques peuvent survenir au niveau de la chaîne.

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

list

*ConsumerGroup.

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

Aucune

Syntaxe de la requête

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

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Oui	L'identifiant de l'instance pour laquelle vous souhaitez interroger la liste des groupes de consommateurs.	rmq-cn-7e22ody****

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
filter	string	Non	La condition de filtrage pour la requête. Si vous ne spécifiez pas ce paramètre, tous les groupes de consommateurs de l'instance spécifiée sont interrogés.	CID-TEST
pageNumber	integer	Non	Le numéro de page de la pagination. Indique la page de résultats à renvoyer.	1
pageSize	integer	Non	La taille de la pagination. Le nombre maximal de résultats à renvoyer par page.\n\nValeurs valides : [10,100].	10

Éléments de réponse

Élément	Type	Description	Exemple
	object	Result<MyPage>
requestId	string	L'identifiant de la requête. Chaque requête possède un identifiant unique, qui est utilisé pour le dépannage et la localisation des problèmes.	5503A460-98ED-5543-92CF-4853DE28****
success	boolean	Indique si l'opération a été exécutée avec succès.	true
data	object	Les données renvoyées.
pageNumber	integer	Le numéro de page actuel.	1
pageSize	integer	La taille de la pagination.	10
totalCount	integer	Le nombre total de résultats renvoyés.	1
list	array<object>	Les données de pagination.
	object
regionId	string	L'identifiant de la région de l'instance.	cn-hangzhou
instanceId	string	L'identifiant de l'instance.	rmq-cn-7e22ody****
consumerGroupId	string	L'identifiant du groupe de consommateurs.	GID-TEST
status	string	L'état du groupe de consommateurs. Valeurs valides : RUNNING : En cours d'exécution. CREATING : En cours de création.	RUNNING
remark	string	Les remarques du groupe de consommateurs.	Ceci est la remarque pour le test
createTime	string	L'heure de création du groupe de consommateurs, au format AAAA-MM-JJ HH:mm:ss.	2022-08-01 20:05:50
updateTime	string	L'heure de la dernière mise à jour du groupe de consommateurs, au format AAAA-MM-JJ HH:mm:ss.	2022-08-01 20:05:50
maxReceiveTps	integer	Le TPS maximal pour la consommation de messages.	1000
messageModel	string	Le mode de consommation.	LITE_SELECTIVE
topicName	string	Le nom du sujet pour le type lite.	test1
code	string	Le code d'erreur.	MissingInstanceId
message	string	Le message d'erreur.	Le paramètre InstanceId est obligatoire pour cette action
httpStatusCode	integer	Le code d'état HTTP.	400
dynamicCode	string	Le code d'erreur dynamique.	InstanceId
dynamicMessage	string	Le message d'erreur dynamique.	instanceId

Exemples

JSON format

{
  "requestId": "5503A460-98ED-5543-92CF-4853DE28****",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "consumerGroupId": "GID-TEST",
        "status": "RUNNING",
        "remark": "Ceci est la remarque de test",
        "createTime": "2022-08-01 20:05:50",
        "updateTime": "2022-08-01 20:05:50",
        "maxReceiveTps": 1000,
        "messageModel": "LITE_SELECTIVE",
        "topicName": "test1"
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "Le paramètre InstanceId est obligatoire pour cette action",
  "httpStatusCode": 400,
  "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.