OnsTopicList - - Centre de documentation Alibaba Cloud

Consulte les informations sur tous les topics de votre compte.

Description de l'opération

Important L'OpenAPI d'Alibaba Cloud est une API de gestion que vous pouvez utiliser pour gérer et interroger les ressources des services Alibaba Cloud. Intégrez cette API uniquement à des fins de gestion. Ne vous appuyez pas sur cette API pour les liaisons de données principales qui envoient et reçoivent des messages. Cela peut créer des menaces de sécurité pour vos liaisons de données.

Cette opération est généralement utilisée pour générer une liste de ressources, et non pour consulter des détails spécifiques.

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.

mq:ListTopic

list

Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

Aucune

mq:QueryInstanceBaseInfo

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Topic	string	Non	Spécifie le topic à interroger. Si vous laissez ce paramètre vide, tous les topics sont interrogés.	test
InstanceId	string	Non	L'identifiant de l'instance qui contient les topics que vous souhaitez interroger.	MQ_INST_188077086902****_BXSuW61e
Tag	array<object>	Non	La liste des balises associées au topic. La liste peut contenir jusqu'à 20 éléments.
	object	Non	La structure de la balise renvoyée.
Key	string	Oui	La clé de balise du topic. Vous devez spécifier les paramètres Key et Value en même temps, ou les laisser tous les deux vides. Si vous spécifiez les deux paramètres, cette opération interroge les topics qui ont la balise spécifiée. Si vous laissez les deux paramètres vides, cette opération interroge tous les topics. Si vous spécifiez ce paramètre, sa valeur ne peut pas être une chaîne vide. La valeur peut comporter jusqu'à 128 caractères. Elle ne peut pas commencer par aliyun ou acs:. Elle ne peut pas contenir http:// ou https://.	CartService
Value	string	Oui	La valeur de balise du topic. Vous devez spécifier les paramètres Key et Value en même temps, ou les laisser tous les deux vides. Si vous spécifiez les deux paramètres, cette opération interroge les topics qui ont la balise spécifiée. Si vous laissez les deux paramètres vides, cette opération interroge tous les topics. Si vous spécifiez ce paramètre, sa valeur peut être une chaîne vide. La valeur peut comporter jusqu'à 128 caractères. Elle ne peut pas commencer par aliyun ou acs:. Elle ne peut pas contenir http:// ou https://.	ServiceA

Éléments de réponse

Élément	Type	Description	Exemple
	object	La structure de données renvoyée.
RequestId	string	Il s'agit d'un paramètre commun. Chaque requête possède un identifiant unique. Vous pouvez utiliser cet identifiant pour résoudre les problèmes.	4A978869-7681-4529-B470-107E1379****
Data	object
PublishInfoDo	array<object>	La liste des topics dans l'instance spécifiée.
	array<object>	La structure de données du topic renvoyé.
MessageType	integer	The message type. Valid values: 0: Normal message 1: Partitionally ordered message 2: Globally ordered message 4: Transactional message 5: Scheduled and delayed message	0
RelationName	string	The relation name. Valid values are Owner, Subscribable, Publishable, and Publishable and Subscribable.	授权发布/订阅
Owner	string	The ID of the topic owner. This is the ID of an Alibaba Cloud account.	138015630679****
IndependentNaming	boolean	Indicates whether the instance that contains the topic has a namespace. Valid values: true: The instance has an independent namespace. The resource name must be unique within the instance. The resource name can be the same as a resource name in another instance. false: The instance does not have an independent namespace. The resource name must be globally unique within and across all instances.	true
Remark	string	The remarks.	测试
Relation	integer	The relation ID. Valid values: 1: The owner of the topic. 2: The account can publish messages to the topic. 4: The account can subscribe to the topic. 6: The account can publish messages to and subscribe to the topic.	6
CreateTime	integer	The time when the topic was created.	1570700947000
Topic	string	The topic name.	test
Tags	object
Tag	array<object>	The tags that are attached to the topic.
	object	The definition of the tag structure.
Key	string	The tag key.	CartService
Value	string	The tag value.	SrviceA
InstanceId	string	The ID of the instance that contains the topic.	MQ_INST_188077086902****_BXSuW61e
ServiceStatus	integer	The status of the asynchronous topic creation. Valid values: 0: Creating. 1: In service.	0

Exemples

JSON format

{
  "RequestId": "4A978869-7681-4529-B470-107E1379****",
  "Data": {
    "PublishInfoDo": [
      {
        "MessageType": 0,
        "RelationName": "授权发布/订阅",
        "Owner": "138015630679****",
        "IndependentNaming": true,
        "Remark": "测试",
        "Relation": 6,
        "CreateTime": 1570700947000,
        "Topic": "test",
        "Tags": {
          "Tag": [
            {
              "Key": "CartService",
              "Value": "SrviceA"
            }
          ]
        },
        "InstanceId": "MQ_INST_188077086902****_BXSuW61e",
        "ServiceStatus": 0
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.