OnsTopicList - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Cette opération renvoie les informations de base sur les topics, mais pas leurs détails.

Limite de requêtes

Chaque compte Alibaba Cloud peut appeler cette opération jusqu'à 10 fois par seconde. Si le nombre de requêtes envoyées pour appeler cette opération en une seconde atteint la limite, les nouvelles requêtes échouent. Cela peut interrompre votre activité commerciale. Pour plus d'informations sur les limites de requêtes de chaque opération, consultez les Limites de débit des API.

Autorisation

Par défaut, seuls les comptes Alibaba Cloud peuvent appeler cette opération. Un utilisateur RAM (Resource Access Management) ne peut l'appeler qu'après avoir reçu les autorisations nécessaires. Le tableau suivant décrit les autorisations qui doivent être accordées à un utilisateur RAM pour appeler cette opération.

API	Action	Resource
OnsTopicList	mq:QueryInstanceBaseInfo	acs:mq:::{instanceId}

Remarque

Lorsque vous utilisez les identifiants d'un utilisateur RAM pour appeler cette opération, celle-ci renvoie uniquement les informations sur les topics pour lesquels l'utilisateur RAM dispose des autorisations nécessaires. Pour obtenir les informations sur d'autres topics, connectez-vous à la console RAM avec votre compte Alibaba Cloud afin d'accorder à l'utilisateur RAM les autorisations requises sur les topics auxquels vous souhaitez accéder. Pour savoir comment accorder des autorisations, consultez les Politiques et exemples.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	OnsTopicList	L'opération que vous souhaitez effectuer. Définissez la valeur sur OnsTopicList.
Topic	String	No	test	Le nom du topic que vous souhaitez interroger. Ce paramètre est requis lorsque vous voulez interroger un topic spécifique. Si vous n'incluez pas ce paramètre dans la requête, tous les topics auxquels vous pouvez accéder sont interrogés.
InstanceId	String	Yes	MQ_INST_188077086902****_BXSuW61e	L'ID de l'instance Message Queue for Apache RocketMQ qui contient les topics que vous souhaitez interroger.
Tag.N.Key	String	Yes	CartService	La clé d'un tag attaché aux topics que vous souhaitez interroger. Ce paramètre n'est pas obligatoire. Si vous configurez ce paramètre, vous devez également configurer le paramètre Tag.N.Value. Si vous incluez les paramètres Tag.N.Key et Tag.N.Value dans une requête, cette opération interroge uniquement les topics qui utilisent les tags spécifiés. Si vous n'incluez pas ces paramètres dans une requête, cette opération interroge tous les topics auxquels vous pouvez accéder. La valeur de N doit être un entier compris entre 1 et 20. Si vous incluez ce paramètre dans une requête, sa valeur ne peut pas être une chaîne vide. La valeur de ce paramètre doit comporter au maximum 128 caractères et ne peut pas commencer par acs: ou aliyun, ni contenir http:// ou https://.
Tag.N.Value	String	Yes	ServiceA	La valeur d'un tag attaché aux topics que vous souhaitez interroger. Ce paramètre n'est pas obligatoire. Si vous configurez ce paramètre, vous devez également configurer le paramètre Tag.N.Key. Si vous incluez les paramètres Tag.N.Key et Tag.N.Value dans une requête, cette opération interroge uniquement les topics qui utilisent les tags spécifiés. Si vous n'incluez pas ces paramètres dans une requête, cette opération interroge tous les topics auxquels vous pouvez accéder. La valeur de N doit être un entier compris entre 1 et 20. La valeur de ce paramètre peut être une chaîne vide. La valeur de ce paramètre doit comporter au maximum 128 caractères et ne peut pas commencer par acs: ou aliyun, ni contenir http:// ou https://.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	4A978869-7681-4529-B470-107E1379****	L'ID de la requête. Le système génère un ID unique pour chaque requête. Vous pouvez résoudre les problèmes en vous basant sur l'ID de la requête.
Data	Array of PublishInfoDo		La liste des topics.
PublishInfoDo
MessageType	Integer	0	Le type de message. Valeurs possibles : 0 : messages normaux 1 : messages ordonnés partiellement 2 : messages ordonnés globalement 4 : messages transactionnels 5 : messages planifiés ou différés
RelationName	String	Publish and subscribe	Le nom de la relation entre le compte actuel et le topic. La valeur de ce paramètre indique que le compte actuel est le propriétaire du topic, qu'il peut publier des messages sur le topic, s'y abonner, ou les deux.
Owner	String	138015630679****	L'ID utilisateur du propriétaire du topic.
IndependentNaming	Boolean	true	Indique si l'instance Message Queue for Apache RocketMQ qui contient le topic utilise un namespace. Valeurs possibles : true : L'instance utilise un namespace. L'identifiant de chaque ressource dans l'instance doit être unique au sein de celle-ci. Toutefois, l'identifiant d'une ressource dans l'instance peut être identique à celui d'une ressource dans une autre instance utilisant un namespace différent. false : L'instance n'utilise pas de namespace. L'identifiant de chaque ressource dans l'instance doit être unique across les instances.
Remark	String	Test	La description du topic.
Relation	Integer	6	Indique la relation entre le compte actuel et le topic. Valeurs possibles : 1 : Le compte actuel est le propriétaire du topic. 2 : Le compte actuel peut publier des messages sur le topic. 4 : Le compte actuel peut s'abonner au topic. 6 : Le compte actuel peut publier des messages sur le topic et s'y abonner.
CreateTime	Long	1570700947000	Le moment où le topic a été créé.
Topic	String	test	Le nom du topic.
Tags	Array of Tag		Les tags attachés au topic.
Tag
Key	String	CartService	La clé du tag.
Value	String	SrviceA	La valeur du tag.
InstanceId	String	MQ_INST_188077086902****_BXSuW61e	L'ID de l'instance Message Queue for Apache RocketMQ qui contient le topic.
ServiceStatus	Integer	0	Le statut du topic. Valeurs possibles : 0 : Le topic est en cours de création. 1 : Le topic est en service.

Exemples

Exemples de requêtes

http(s)://ons.cn-zhangjiakou.aliyuncs.com/?Action=OnsTopicList
&InstanceId=MQ_INST_188077086902****_BXSuW61e
&Tag.1.Key=CartService
&Tag.1.Value=ServiceA
&<Common request parameters>

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsTopicListResponse>
    <RequestId>4A978869-7681-4529-B470-107E1379****</RequestId>
    <Data>
        <MessageType>0</MessageType>
        <RelationName>Publish and subscribe</RelationName>
        <Owner>138015630679****</Owner>
        <IndependentNaming>true</IndependentNaming>
        <Remark>Test</Remark>
        <Relation>6</Relation>
        <CreateTime>1570700947000</CreateTime>
        <Topic>test</Topic>
        <Tags>
            <Key>CartService</Key>
            <Value>SrviceA</Value>
        </Tags>
        <InstanceId>MQ_INST_188077086902****_BXSuW61e</InstanceId>
        <ServiceStatus>0</ServiceStatus>
    </Data>
</OnsTopicListResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4A978869-7681-4529-B470-107E1379****",
  "Data" : [ {
    "MessageType" : 0,
    "RelationName": "Publish and subscribe",
    "Owner" : "138015630679****",
    "IndependentNaming" : true,
    "Remark": "Test",
    "Relation" : 6,
    "CreateTime" : 1570700947000,
    "Topic" : "test",
    "Tags" : [ {
      "Key" : "CartService",
      "Value" : "SrviceA"
    } ],
    "InstanceId" : "MQ_INST_188077086902****_BXSuW61e",
    "ServiceStatus" : 0
  } ]
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.