SubscribeTopic - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

L'appareil doit être connecté à IoT Platform et en ligne.
Chaque appel permet de s'abonner aux topics d'un seul appareil. Spécifiez jusqu'à 10 topics par appel.

Limites QPS

Chaque compte Alibaba Cloud peut appeler cette opération jusqu'à 10 fois par seconde (QPS).

Remarque

Les utilisateurs RAM partagent le quota du compte Alibaba Cloud.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	SubscribeTopic	L'opération à effectuer. Définissez la valeur sur SubscribeTopic.
DeviceName	String	Yes	device1	Le DeviceName de l'appareil auquel le topic appartient.
ProductKey	String	Yes	a1Q5XoY***	Le ProductKey du produit auquel l'appareil appartient.
Topic.N	RepeatList	Yes	/a1Q5XoY***/device1/user/get	Les topics auxquels s'abonner. Vous pouvez spécifier jusqu'à 10 topics. Les topics doivent disposer des autorisations Subscribe ou Publish and Subscribe.
IotInstanceId	String	No	iot-06***	L'ID de l'instance. Consultez l'ID sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez spécifier ce paramètre. Sinon, l'appel échouera. Si aucune page Overview ou aucun ID n'est généré pour votre instance, vous n'avez pas besoin de spécifier ce paramètre. Pour plus d'informations, consultez Vue d'ensemble.

Outre les paramètres de requête spécifiques à l'opération listés ci-dessus, vous devez également spécifier les paramètres de requête communs. Pour plus d'informations, consultez Paramètres de requête communs.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Le code d'erreur. Pour plus d'informations, consultez Codes d'erreur.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	BB71E443-4447-4024-A000-EDE09922891E	L'ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemples de requêtes

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=SubscribeTopic
&DeviceName=device1
&ProductKey=a1Q5XoY***
&Topic.1=/a1Q5XoY***/device1/user/get
&Topic.2=/a1Q5XoY***/device1/user/add
&<Common request parameters>

Exemples de réponses réussies

Format XML

<SubscribeTopicResponse>
  <RequestId>32B9828A-25DD-48E2-8E26-D1664B341940</RequestId>
  <Success>true</Success>
</SubscribeTopicResponse>

Format JSON

{
    "RequestId": "32B9828A-25DD-48E2-8E26-D1664B341940",
    "Success": true
}

Codes d'erreur

HttpCode	Error code	Error message	Description
500	Iot.MessageBroker.BatchSubTopicFailed	An error occurred while batch subscribing to the topic.	Le message d'erreur renvoyé en cas d'échec de l'abonnement groupé.
400	Iot.System.BillIsOverDue	Your account has overdue payments. Go to the expense center and add funds to your account.	Le message d'erreur renvoyé car vous avez des paiements en retard. Accédez au centre de facturation et approvisionnez votre compte.
400	Iot.MessageBroker.EmptySubTopicList	The subscription topic list is empty.	Le message d'erreur renvoyé car la liste des topics est vide.
400	Iot.Device.NotExistedDevice	The device does not exist.	Le message d'erreur renvoyé car l'appareil n'existe pas ou n'est pas activé.
403	Iot.Device.NotDeviceOwner	You are not the device owner.	Le message d'erreur renvoyé car l'opérateur actuel n'est pas le propriétaire de l'appareil.
400	Iot.MessageBroker.TopicTemplateIsNotFound	The topic template does not exist.	Le message d'erreur renvoyé car le modèle spécifié n'existe pas.
400	iot.prod.NotExistedProduct	The specified product does not exist.	Le message d'erreur renvoyé car le produit spécifié n'existe pas.
400	iot.device.InactiveDevice	The device is inactive.	Le message d'erreur renvoyé car l'appareil n'est pas activé. Cela indique que l'appareil ne s'est jamais connecté à IoT Platform.

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