ListConsumerGroupSubscriptions - - Centre de documentation Alibaba Cloud

Répertorie les relations d'abonnement 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:ListConsumerGroupSubscriptions

list

*ConsumerGroup

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

Aucune

Syntaxe de la requête

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

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Oui	L'identifiant de l'instance ApsaraMQ for RocketMQ.	rmq-cn-tl32wwz1r05
consumerGroupId	string	Oui	L'identifiant du groupe de consommateurs dont vous souhaitez interroger les relations d'abonnement.	PRINT_RETRY_CONSUMER

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
topicName	string	Non	Le nom du sujet. Si vous ne spécifiez pas ce paramètre, toutes les relations d'abonnement sont interrogées.	topic_test

Éléments de réponse

Élément	Type	Description	Exemple
	object	Result
requestId	string	L'identifiant de la requête.	5F4D9D5F-625B-59FF-BD4F-DA8284575DB4
success	boolean	Indique si la requête a réussi.	true
data	array<object>	Les données renvoyées.
	object	La liste des relations d'abonnement du groupe de consommateurs.
consumerGroupId	string	L'identifiant du groupe de consommateurs.	CID-TEST
topicName	string	Le sujet auquel le groupe de consommateurs est abonné.	topic_test
messageModel	string	Le mode de consommation du groupe de consommateurs. BROADCASTING : le mode de consommation par diffusion. CLUSTERING : le mode de consommation par cluster.	CLUSTERING
subscriptionStatus	string	L'état de l'abonnement. ONLINE : le groupe de consommateurs est en ligne. Si un groupe de consommateurs contient plusieurs consommateurs, le groupe est considéré comme en ligne tant qu'au moins un consommateur est en ligne. OFFLINE : le groupe de consommateurs est hors ligne. Si un groupe de consommateurs contient plusieurs consommateurs, le groupe n'est considéré comme hors ligne que lorsque tous les consommateurs sont hors ligne.	ONLINE
filterExpression	string	L'expression de filtre.	*
filterExpressionType	string	Le type d'expression de filtre. SQL : filtrage SQL. TAG : filtrage par balise.	SQL
topicCreated	boolean	Indique si le sujet est créé.	true
consistency	boolean	La cohérence de la relation d'abonnement. false : la relation d'abonnement est incohérente. true : la relation d'abonnement est cohérente.	true
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.	200
dynamicCode	string	Le code d'erreur dynamique.	InstanceId
dynamicMessage	string	Le message d'erreur dynamique.	InstanceId

Exemples

JSON format

{
  "requestId": "5F4D9D5F-625B-59FF-BD4F-DA8284575DB4",
  "success": true,
  "data": [
    {
      "consumerGroupId": "CID-TEST",
      "topicName": "topic_test",
      "messageModel": "CLUSTERING",
      "subscriptionStatus": "ONLINE",
      "filterExpression": "*",
      "filterExpressionType": "SQL",
      "topicCreated": true,
      "consistency": true
    }
  ],
  "code": "MissingInstanceId",
  "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.