CreateDataSourceItem - IoT Platform - Centre de documentation Alibaba Cloud

Remarques sur l'utilisation

Avant d'appeler l'opération CreateDataSourceItem, créez une source de données. Pour plus d'informations, consultez les « Étape 1 à Étape 6 » de la rubrique Créer une source de données. Procédez ensuite comme suit pour afficher l'ID de la source de données : connectez-vous à la console IoT Platform et cliquez sur le nom de l'instance à laquelle la source de données appartient. Choisissez Rules Engine > Data Forwarding. Dans l'onglet Data Source, consultez l'ID of the data source.

Limites QPS

Chaque compte Alibaba Cloud peut exécuter jusqu'à 10 requêtes par seconde (QPS).

Remarque

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

Débogage

OpenAPI Explorer calcule automatiquement la valeur de la signature. Par souci de simplicité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de la requête

Parameter	Type	Required	Example	Description
Action	String	Yes	CreateDataSourceItem	Opération à effectuer. Définissez la valeur sur CreateDataSourceItem.
DataSourceId	Long	Yes	1002	ID de la source de données.
Topic	String	Yes	/as/mqtt/status/gy***z/+	Topic à ajouter à la source de données dans le moteur de règles. Format : `/${productKey}/${deviceName}/topicShortName`. `${productKey}` spécifie le ProductKey du produit auquel appartient un appareil. `${deviceName}` spécifie le nom de l'appareil. `topicShortName` spécifie le nom personnalisé du topic. Le format des topics de communication de base ou des topics de communication TSL est `/${productKey}/${deviceName}/topicShortName`. Vous pouvez remplacer `${deviceName}` par le caractère générique `+`. Ce caractère générique indique que le topic s'applique à tous les appareils du produit. Valeurs valides pour `topicShortName` : `/thing/event/property/post` : soumet les données de propriété d'un appareil. `/thing/event/${tsl.event.identifier}/post` : soumet les données d'événement d'un appareil. `${tsl.event.identifier}` spécifie l'identifiant d'un événement dans le modèle TSL. `/thing/lifecycle` : soumet les modifications du cycle de vie de l'appareil. `/thing/downlink/reply/message` : envoie une réponse à une demande provenant d'IoT Platform. `/thing/list/found` : soumet les données lorsqu'une passerelle détecte un nouveau sous-appareil. `/thing/topo/lifecycle` : soumet les modifications de la topologie des appareils. `/thing/event/property/history/post` : soumet les données historiques de propriété d'un appareil. `/thing/event/${tsl.event.identifier}/post` : soumet les données d'événement historiques d'un appareil. `${tsl.event.identifier}` spécifie l'identifiant d'un événement dans le TSL. `/ota/upgrade` : soumet les statuts de mise à jour OTA. `/ota/version/post` : soumet les versions des modules OTA. `/thing/deviceinfo/update` : soumet les modifications des tags d'appareil. `${packageId}/${jobId}/ota/job/status` : soumet le statut de chaque lot de mise à jour OTA. Ce topic est un topic de communication de base. `${packageId}` spécifie l'ID du package de mise à jour. `${jobId}` spécifie l'ID du lot de mise à jour. Le format des topics personnalisés est `/${productKey}/${deviceName}/user/#`. Exemple : `/${productKey}/${deviceName}/user/get`. Appelez l'opération QueryProductTopic pour afficher tous les topics personnalisés du produit. Lorsque vous spécifiez un topic personnalisé, vous pouvez utiliser les caractères génériques `+` et `#`. Vous pouvez remplacer `${deviceName}` par le caractère générique `+`. Ce caractère générique indique que le topic s'applique à tous les appareils du produit. Vous pouvez remplacer les champs qui suivent ${deviceName} par `/user/#`. Le caractère générique `#` indique que le topic s'applique à tous les champs qui suivent `/user`. Le format des topics utilisés pour soumettre les modifications d'état des appareils est `/as/mqtt/status/${productKey}/${deviceName}`. Vous pouvez utiliser le caractère générique `+`. Dans ce cas, les modifications d'état de tous les appareils du produit sont soumises. Pour plus d'informations sur l'utilisation des caractères génériques, consultez Caractères génériques dans les topics. Pour plus d'informations sur les formats de données des topics, consultez Formats de données.
IotInstanceId	String	No	iot-0pp1n8t***	ID de l'instance. Vous pouvez afficher l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez spécifier cet ID pour 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 configurer ce paramètre. Pour plus d'informations, consultez Vue d'ensemble.

En plus des paramètres de requête spécifiques à l'opération mentionnés ci-dessus, configurez les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez les Paramètres de requête communs.

Paramètres de la réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez les Codes d'erreur.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	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=CreateDataSourceItem
&DataSourceId=1002
&Topic=/as/mqtt/status/gy***z/+
&<Common request parameters>

Exemples de réponses réussies

Format XML

<CreateDataSourceItemResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Success>true</Success>
</CreateDataSourceItemResponse>

Format JSON

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Success": true
}

Codes d'erreur

HttpCode	Error code	Error message	Description
400	iot.prod.NotExistedProduct	The specified product does not exist.	Message d'erreur renvoyé car le produit spécifié n'existe pas.
400	iot.system.SystemException	An internal error occurred. Try again later.	Message d'erreur renvoyé car une exception système s'est produite.
400	iot.common.InvalidFormattedParameter	The parameter format is invalid.	Message d'erreur renvoyé car le format du paramètre n'est pas valide.

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