NotifyAddThingTopo - IoT Platform - Centre de documentation Alibaba Cloud

Notifie une passerelle pour ajouter des relations topologiques.

Remarques d'utilisation

Une réponse positive indique que la commande d'ajout de relations topologiques a été envoyée à la passerelle. Cela ne signifie pas que les relations topologiques ont bien été ajoutées.

Lors du développement de la passerelle, abonnez-vous au topic utilisé pour envoyer les notifications lors de l'ajout de relations topologiques. Pour plus d'informations sur le topic et le format des messages, consultez la rubrique Gérer les relations topologiques.

Limites

Chaque compte Alibaba Cloud est limité à 500 requêtes par seconde (QPS).

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota de ce compte.

Débogage

Alibaba Cloud met à disposition OpenAPI Explorer pour simplifier l'utilisation des API. OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération via OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	NotifyAddThingTopo	Opération à effectuer. Définissez la valeur sur NotifyAddThingTopo.
IotInstanceId	String	Non	iot_instc_pu***_c-v64********	ID de l'instance. Vous pouvez consulter l'ID de l'instance sur la page Aperçu de la console IoT Platform. Important Si votre instance possède un ID, vous devez configurer ce paramètre. À défaut, l'appel échouera. Si votre instance ne dispose pas de Aperçu ou d'ID, ce paramètre est facultatif. Pour plus d'informations, consultez la rubrique Aperçu.
DeviceListStr	String	Non	[{"productKey":"a1BwAGV**","deviceName":"device1"},{"IotId":"Q7uOhVRdZRRlDnTLv**00100"}]	Tableau JSON contenant les informations d'identité des sous-appareils. Spécifiez un appareil en combinant ProductKey et DeviceName, ou en utilisant uniquement IotId, par exemple [{"productKey":"a1BwAGxxx","deviceName":"device1"},{"IotId":"Q7uOhxxx"}].
GwIotId	String	Non	vWxNur6BUApsqjv****4000100	ID de l'appareil passerelle. Il s'agit de l'identifiant unique attribué à l'appareil par IoT Platform. Remarque Si vous spécifiez ce paramètre, il n'est pas nécessaire de spécifier ProductKey ni DeviceName. Le paramètre IotId correspond à l'identifiant global unique (GUID) de l'appareil, qui équivaut à la combinaison de ProductKey et de DeviceName. Si vous renseignez à la fois IotId et la combinaison ProductKey/DeviceName, IotId est prioritaire.
GwProductKey	String	Non	a1T27vz****	ProductKey du produit auquel appartient la passerelle. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre DeviceName.
GwDeviceName	String	Non	gateway	DeviceName de la passerelle. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre ProductKey.

Outre les paramètres de requête spécifiques à cette opération, vous devez spécifier les paramètres de requête communs. Pour plus d'informations, consultez la rubrique Paramètres de requête communs.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez la rubrique Codes d'erreur.
Data	Struct		Données renvoyées en cas de succès de l'appel.
MessageId	String	5443123	ID du message envoyé par IoT Platform à la passerelle. Ce message sert à notifier la passerelle d'ajouter une topologie.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	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

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=NotifyAddThingTopo
&GwProductKey=aldnfald7a
&GwDeviceName=gateway
&DeviceListStr=[{"productKey":"alabcabcab","deviceName":"device1"},{"IotId":"edAjkIeBSsdfadjjllja***"}]
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

<NotifyAddThingTopoResponse>
  <RequestId>419A3FC1-B517-4958-9414-5546765FA51F</RequestId>
  <Success>true</Success>
  <Data>
        <MessageId>2345123</MessageId>
  </Data>
</NotifyAddThingTopoResponse>

Format JSON

{
  "RequestId":"419A3FC1-B517-4958-9414-5546765FA51F",
  "Success": true,
  "Data": {
     "MessageId": "2345123"
  }
}

Codes d'erreur

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