ListTopic - - Centre de documentation Alibaba Cloud

Consulte les topics d'un compte Alibaba Cloud. Les résultats de la requête peuvent être paginés.

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.

mns:ListTopic

list

*Toutes les ressources.

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
PageNum	integer	Non	Le numéro de page des résultats renvoyés. Valeurs valides : 1 à 100000000. Si la valeur spécifiée est inférieure à 1, la valeur par défaut du système est 1. Si la valeur spécifiée est supérieure à 100000000, la valeur par défaut du système est 100000000.	1
PageSize	integer	Non	Le nombre d'entrées à renvoyer sur chaque page. Valeurs valides : 10 à 50. Si la valeur spécifiée est inférieure à 10, la valeur par défaut du système est 10. Si la valeur spécifiée est supérieure à 50, la valeur par défaut du système est 50.	20
TopicName	string	Non	Le nom du topic.	test
Tag	array<object>	Non	La liste des balises.
	object	Non	La valeur de balise correspondant à la clé de balise.
Key	string	Non	La clé de la balise.	tag1
Value	string	Non	La valeur de la balise.	test
TopicType	string	Non	Le type de topic. Valeurs valides : normal : topic normal fifo : topic FIFO	normal

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	06273500-249F-5863-121D-74D51123****
Code	integer	Le code de réponse.	200
Status	string	L'état de la réponse.	Success
Message	string	Le message de réponse.	operation success
Success	boolean	Indique si la requête a réussi.	true
Data	object	Les données de réponse.
PageNum	integer	Le numéro de page des résultats renvoyés.	1
PageSize	integer	Le nombre d'entrées renvoyées sur chaque page.	50
Total	integer	Le nombre total de résultats.	130
PageData	array<object>	Les résultats renvoyés sur la page actuelle.
	array<object>	L'élément de données.
TopicName	string	Le nom du topic.	demo-topic
MessageCount	integer	Le nombre de messages dans le topic.	0
MaxMessageSize	integer	La longueur maximale du corps du message pouvant être envoyé au topic. Unité : octets.	65536
MessageRetentionPeriod	integer	La période de rétention maximale des messages dans le topic. Une fois la période spécifiée écoulée à partir du moment où un message est envoyé au topic, le message est supprimé, qu'il ait été délivré avec succès aux utilisateurs ou non. Unité : secondes.	86400
CreateTime	integer	L'heure de création du topic. La valeur est un horodatage UNIX UTC en secondes.	1449554962
LastModifyTime	integer	L'heure de la dernière modification des attributs du topic. La valeur est un horodatage UNIX UTC en secondes.	1449554962
LoggingEnabled	boolean	Indique si la fonctionnalité de gestion des journaux est activée. Valeurs valides : True : activée False : désactivée	True
TopicUrl	string	L'URL du topic.	http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic
TopicInnerUrl	string	L'URL interne du topic.	http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic
Tags	array<object>	La liste des balises de ressource.
	object	La valeur de balise correspondant à la clé de balise.
TagKey	string	La clé de la balise.	tag1
TagValue	string	La valeur de la balise.	test
TopicType	string	Le type de topic. Valeurs valides : normal : topic normal fifo : topic FIFO	normal
EnableSSE	boolean	Indique si le chiffrement côté serveur est activé. Valeurs valides : true et false.	true
SseType	string	La méthode de chiffrement côté serveur. Valeurs valides : SMQ et KMS.	KMS
SseAlgorithm	string	L'algorithme de chiffrement côté serveur. Actuellement, AES-256-GCM est pris en charge. Si ce paramètre n'est pas spécifié, l'algorithme par défaut est utilisé.	AES-256-GCM
KmsKeyId	string	L'identifiant de la clé KMS.	key-xxx
EncryptionEnabled	boolean	Indique si le chiffrement côté serveur est activé.	true

Exemples

JSON format

{
  "RequestId": "06273500-249F-5863-121D-74D51123****",
  "Code": 200,
  "Status": "Success",
  "Message": "operation success",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 50,
    "Total": 130,
    "PageData": [
      {
        "TopicName": "demo-topic",
        "MessageCount": 0,
        "MaxMessageSize": 65536,
        "MessageRetentionPeriod": 86400,
        "CreateTime": 1449554962,
        "LastModifyTime": 1449554962,
        "LoggingEnabled": true,
        "TopicUrl": "http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic",
        "TopicInnerUrl": "http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic",
        "Tags": [
          {
            "TagKey": "tag1",
            "TagValue": "test"
          }
        ],
        "TopicType": "normal",
        "EnableSSE": true,
        "SseType": "KMS",
        "SseAlgorithm": "AES-256-GCM",
        "KmsKeyId": "key-xxx",
        "EncryptionEnabled": true
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.