ListTopicSubscriptions - - Centre de documentation Alibaba Cloud

Consulte les abonnements d'un topic spécifique.

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

list

*Topic

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}

Aucune

Syntaxe de la requête

GET /instances/{instanceId}/topics/{topicName}/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-zpr34udri0w
topicName	string	Oui	Le nom du topic sur l'instance ApsaraMQ for RocketMQ.	dev4-HMH_INSURANCE_NOMAL_TOPIC

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

Éléments de réponse

Élément	Type	Description	Exemple
	object	Result<List>
requestId	string	L'identifiant de la requête.	92A9BE4E-B794-50C8-979C-0456E4D32943
success	boolean	Indique si la requête a réussi.	true
data	array<object>	Les données renvoyées.
	object	Les abonnements du topic.
consumerGroupId	string	L'identifiant du groupe de consommateurs.	CID-TEST
topicName	string	Le nom du topic.	topic_test
messageModel	string	Le mode de consommation. Valeurs valides : BROADCASTING et CLUSTERING.	BROADCASTING
subscriptionStatus	string	L'état de l'abonnement. Valeurs valides : ONLINE et OFFLINE.	ONLINE
filterExpression	string	L'expression de filtrage.	*
filterExpressionType	string	Le type d'expression de filtrage. Valeurs valides : SQL, TAG et UNSPECIFIED. La valeur SQL indique que les messages sont filtrés à l'aide d'expressions SQL. La valeur TAG indique que les messages sont filtrés à l'aide de balises. La valeur UNSPECIFIED indique qu'aucun type d'expression de filtrage n'est spécifié.	SQL
consistency	string	Indique si la consommation des messages est cohérente. Valeurs valides : false : des messages non consommés existent dans le groupe de consommateurs. true : aucun message non consommé n'existe dans le groupe de consommateurs.	true
code	string	Le code d'erreur.	MissingInstanceId
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.	Topic
dynamicMessage	string	Le message d'erreur dynamique.	instanceId

Exemples

JSON format

{
  "requestId": "92A9BE4E-B794-50C8-979C-0456E4D32943",
  "success": true,
  "data": [
    {
      "consumerGroupId": "CID-TEST",
      "topicName": "topic_test",
      "messageModel": "BROADCASTING",
      "subscriptionStatus": "ONLINE",
      "filterExpression": "*",
      "filterExpressionType": "SQL",
      "consistency": "true"
    }
  ],
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "Topic",
  "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.