IoT Platform:Liste des opérations par fonction

Produits

API	Description
CreateProduct	Crée un produit.
UpdateProduct	Modifie les informations d'un produit.
QueryProductList	Interroge la liste des produits.
QueryProduct	Obtient les détails d'un produit.
DeleteProduct	Supprime un produit.
CreateProductTags	Ajoute des tags à un produit.
UpdateProductTags	Met à jour les tags d'un produit.
DeleteProductTags	Retire les tags d'un produit.
ListProductTags	Liste tous les tags associés à un produit.
ListProductByTags	Recherche des produits selon leurs tags.
UpdateProductFilterConfig	Actualise la règle de déduplication des messages de propriétés envoyés par les appareils d'un produit.
ReleaseProduct	Publie un produit.
CancelReleaseProduct	Annule la publication d'un produit.

Appareils

API	Description
RegisterDevice	Enregistre un appareil.
QueryClientIds	Récupère les ClientID d'un appareil. Cette opération s'applique à l'authentification par certificat unique par modèle sans pré-enregistrement.
TransformClientId	Désigne un ClientID valide pour éviter les accès illégitimes lorsqu'un appareil en possède plusieurs. Concerne l'authentification par certificat unique par modèle sans pré-enregistrement.
DeleteClientIds	Purge l'ensemble des ClientID d'un appareil si leur quantité excède le plafond de 5. Réservé au mode certificat unique par modèle sans pré-enregistrement.
QueryDeviceInfo	Donne les caractéristiques essentielles d'un appareil : ID, certificat et alias.
QueryDeviceDetail	Fournit les détails complets d'un appareil.
BatchQueryDeviceDetail	Permet d'obtenir les détails de plusieurs appareils simultanément.
QueryDevice	Liste les appareils appartenant à un produit.
DeleteDevice	Retire un appareil de la plateforme.
GetDeviceStatus	Indique l'état de fonctionnement d'un appareil.
BatchGetDeviceState	Renvoie l'état de plusieurs appareils en une seule requête.
DisableThing	Désactive un appareil.
EnableThing	Réactive un appareil précédemment désactivé.
ResetThing	Réinitialise un appareil.
BatchCheckDeviceNames	Vérifie la validité d'une liste de noms d'appareils personnalisés avant leur création sur IoT Platform.
BatchRegisterDeviceWithApplyId	Demande l'enregistrement en lot d'appareils à partir d'un identifiant de demande.
BatchRegisterDevice	Lance une demande d'enregistrement pour un nombre défini d'appareils.
QueryBatchRegisterDeviceStatus	Consulte l'avancement d'une procédure d'enregistrement en lot.
QueryPageByApplyId	Affiche la liste paginée des appareils issus d'une demande par lots.
SaveDeviceProp	Définit des tags pour un appareil.
QueryDeviceProp	Renvoie la liste des tags attribués à un appareil.
DeleteDeviceProp	Efface les tags d'un appareil.
GetThingTopo	Énumère les sous-appareils rattachés à une passerelle.
NotifyAddThingTopo	Signale à la passerelle l'établissement d'une relation topologique avec un sous-appareil.
BatchAddThingTopo	Établit des relations topologiques en lot entre plusieurs sous-appareils et une passerelle.
RemoveThingTopo	Dissocie les relations topologiques d'un appareil.
QueryDeviceStatistics	Fournit des statistiques agrégées sur les appareils.
GetGatewayBySubDevice	Identifie la passerelle associée à un sous-appareil donné.
QueryDeviceByTags	Filtre les appareils selon leurs tags.
QueryDeviceFileList	Répertorie les fichiers déposés sur IoT Platform par un appareil.
QueryDeviceFile	Donne les métadonnées d'un fichier spécifique uploadé par un appareil sur IoT Platform.
DeleteDeviceFile	Efface un fichier stocké sur IoT Platform par un appareil.
BatchUpdateDeviceNickname	Renomme plusieurs appareils en une seule opération.
QueryDeviceByStatus	Sélectionne les appareils selon leur statut actuel.
ListOTAModuleVersionsByDevice	Affiche l'historique des versions de module OTA déclarées par un appareil.
ImportDevice	Intègre un appareil unique sous un produit de passerelle MQTT.
BatchImportDevice	Importe en masse des appareils dans un produit de passerelle MQTT.
BatchCheckImportDevice	Valide un lot d'appareils intégrés à un produit de passerelle MQTT.
QueryImportedDeviceByApplyId	Retrouve les appareils importés en lot grâce à l'identifiant de demande.
BatchImportVehicleDevice	Charge plusieurs appareils compatibles JT/T 808 dans un produit de passerelle dédié.
BatchCheckVehicleDevice	Contrôle la conformité d'un lot d'appareils véhiculaires JT/T 808 importés.
QueryVehicleDevice	Consulte les données d'un appareil connecté via une passerelle JT/T 808.

Distribution des appareils

API	Description
CreateDeviceDistributeJob	Lance une tâche de distribution d'appareils ; le produit parent est inclus par défaut.
CreateProductDistributeJob	Planifie le transfert d'un produit vers une instance cible.
QueryDeviceDistributeDetail	Expose le bilan d'exécution d'une tâche de distribution terminée.
QueryDeviceDistributeJob	Décrit les paramètres d'une tâche de distribution d'appareils.
ListDeviceDistributeJob	Énumère les tâches de distribution existantes.
DeleteDeviceDistributeJob	Annule et supprime une tâche de distribution.
ListDistributedDevice	Affiche le catalogue des appareils déjà distribués.
ListDistributedProduct	Recense les produits ayant fait l'objet d'une distribution.

Groupes d'appareils

API	Description
CreateDeviceGroup	Constitue un groupe d'appareils.
DeleteDeviceGroup	Dissout un groupe d'appareils.
UpdateDeviceGroup	Rectifie les métadonnées d'un groupe.
QueryDeviceGroupInfo	Affiche le profil complet d'un groupe.
QueryDeviceGroupList	Parcourt l'ensemble des groupes d'appareils.
BatchAddDeviceGroupRelations	Intègre plusieurs appareils dans un groupe.
BatchDeleteDeviceGroupRelations	Exclut des appareils ciblés d'un groupe.
SetDeviceGroupTags	Applique ou rafraîchit les tags d'un groupe.
QueryDeviceGroupTagList	Lit les tags affectés à un groupe.
QueryDeviceGroupByDevice	Localise les groupes contenant un appareil précis.
QuerySuperDeviceGroup	Remonte au groupe parent à partir de l'ID d'un sous-groupe.
QueryDeviceListByDeviceGroup	Explore le contenu d'un groupe d'appareils.
QueryDeviceGroupByTags	Filtre les groupes d'appareils selon leurs tags.

Modèles Thing Specification Language (TSL)

API	Description
CreateThingModel	Ajoute des fonctionnalités ou des informations étendues au modèle TSL d'un produit.
UpdateThingModel	Modifie une fonctionnalité ou les informations étendues du modèle TSL d'un produit.
QueryThingModel	Interroge les détails du modèle TSL d'un produit.
CopyThingModel	Copie le modèle TSL d'un produit vers un produit de destination.
PublishThingModel	Publie le modèle TSL d'un produit.
DeleteThingModel	Supprime une fonctionnalité du modèle TSL d'un produit.
ListThingTemplates	Récupère toutes les catégories de produits prédéfinies dans IoT Platform.
GetThingTemplate	Interroge les informations du modèle TSL standard d'une catégorie.
ListThingModelVersion	Liste les versions du modèle TSL d'un produit.
GetThingModelTsl	Récupère le modèle TSL d'un produit.
ImportThingModelTsl	Importe un modèle TSL pour un produit. Les informations étendues ne peuvent pas être importées.
QueryThingModelPublished	Consulte les détails d'un modèle TSL publié pour un produit.
GetThingModelTslPublished	Récupère les informations de base d'un modèle TSL publié pour un produit.
QueryThingModelExtendConfig	Interroge les informations étendues du modèle TSL d'un produit.
QueryThingModelExtendConfigPublished	Récupère les informations étendues d'un modèle TSL publié.
CreateThingScript	Soumet un script d'analyse des données pour un produit.
UpdateThingScript	Modifie un script d'analyse des données pour un produit.
GetThingScript	Récupère un script d'analyse des données pour un produit.

Utilisation des modèles TSL

API	Description
SetDeviceProperty	Configure les propriétés d'un appareil.
SetDevicesProperty	Configure les propriétés de plusieurs appareils simultanément.
InvokeThingService	Appelle un service sur un appareil.
InvokeThingsService	Exécute un service sur plusieurs appareils à la fois.
QueryDevicePropertyData	Récupère l'historique des propriétés d'un appareil.
QueryDevicePropertiesData	Interroge l'historique de plusieurs propriétés d'un appareil.
QueryDeviceEventData	Consulte l'historique des événements d'un appareil.
QueryDeviceServiceData	Obtient l'historique des services d'un appareil.
SetDeviceDesiredProperty	Définit simultanément plusieurs valeurs de propriété souhaitées pour un appareil.
QueryDeviceDesiredProperty	Récupère les valeurs de propriété souhaitées d'un appareil.
QueryDevicePropertyStatus	Consulte les snapshots de propriétés d'un appareil.
QueryDeviceOriginalPropertyStatus	Interroge les snapshots de propriétés brutes d'un appareil.
QueryDeviceOriginalPropertyData	Récupère l'historique des propriétés brutes d'un appareil.
QueryDeviceOriginalEventData	Consulte l'historique des événements bruts d'un appareil.
QueryDeviceOriginalServiceData	Obtient l'historique des services bruts d'un appareil.
ClearDeviceDesiredProperty	Supprime les valeurs souhaitées des propriétés d'un appareil.

Transfert de données (ancienne version)

API	Description
ListRule	Liste les règles.
CreateRule	Crée une règle.
GetRule	Récupère les détails d'une règle.
UpdateRule	Modifie une règle.
DeleteRule	Supprime une règle.
ListDataSourceItem	Récupère les Topics d'une source de données dans le moteur de règles.
ListRuleActions	Liste les actions de règle.
GetRuleAction	Consulte les détails d'une action de règle.
CreateRuleAction	Crée une action de règle.
UpdateRuleAction	Modifie une action de règle.
DeleteRuleAction	Supprime une action de règle.
StartRule	Active une règle.
StopRule	Désactive une règle.

Transfert de données (nouvelle version)

API	Description
CreateParser	Crée un analyseur.
UpdateParser	Met à jour le nom et la description d'un analyseur.
ListParser	Récupère les détails des analyseurs, y compris les informations de base, l'état, la date de création et la date de modification.
GetParser	Consulte les détails d'un analyseur : informations de base, script d'analyse, état et source de données associée.
DeleteParser	Supprime un analyseur.
CreateParserDataSource	Crée une source de données pour le transfert de données.
UpdateParserDataSource	Modifie le nom et la description d'une source de données.
ListParserDataSource	Liste toutes les sources de données.
GetParserDataSource	Récupère les détails d'une source de données.
DeleteParserDataSource	Supprime une source de données.
CreateDataSourceItem	Ajoute un Topic à une source de données.
ListDataSourceItem	Récupère les Topics d'une source de données.
DeleteDataSourceItem	Dissocie un Topic d'une source de données.
CreateDestination	Crée une destination de données pour le transfert.
UpdateDestination	Met à jour le nom, le type et la description d'une destination de données.
ListDestination	Liste les destinations de données.
GetDestination	Consulte les détails d'une destination de données.
DeleteDestination	Supprime une destination de données.
AttachParserDataSource	Associe un analyseur à une source de données.
ListParserDestination	Liste les destinations de données associées à un analyseur.
DetachParserDataSource	Dissocie un analyseur d'une source de données.
AttachDestination	Associe un analyseur à une destination de données.
DetachDestination	Dissocie un analyseur d'une destination de données.
SaveScript	Modifie et enregistre le brouillon d'un script d'analyseur.
PublishScript	Publie le script d'un analyseur.
StartParser	Active un analyseur.
StopParser	Désactive un analyseur.

Rubriques

API	Description
CreateProductTopic	Crée une catégorie de Topic personnalisée pour un produit.
UpdateProductTopic	Modifie une catégorie de Topic personnalisée.
QueryProductTopic	Interroge les catégories de Topic personnalisées d'un produit.
DeleteProductTopic	Supprime une catégorie de Topic personnalisée.
CreateTopicRouteTable	Crée une table de routage pour un Topic.
QueryTopicRouteTable	Interroge la table de routage d'un Topic.
QueryTopicReverseRouteTable	Interroge la table de routage inverse d'un Topic.
DeleteTopicRouteTable	Supprime la table de routage d'un Topic.

Abonnement côté serveur

API	Description
CreateSubscribeRelation	Crée un abonnement côté serveur Message Service (MNS) ou Advanced Message Queuing Protocol (AMQP).
UpdateSubscribeRelation	Modifie un abonnement côté serveur MNS ou AMQP.
QuerySubscribeRelation	Interroge les détails d'un abonnement côté serveur MNS ou AMQP.
DeleteSubscribeRelation	Supprime un abonnement côté serveur MNS ou AMQP.
CreateConsumerGroup	Crée un groupe de consommateurs pour mettre en place un abonnement côté serveur AMQP.
UpdateConsumerGroup	Modifie le nom d'un groupe de consommateurs.
QueryConsumerGroupByGroupId	Récupère les détails d'un groupe de consommateurs via son ID.
QueryConsumerGroupList	Liste l'ensemble des groupes de consommateurs d'un compte ou effectue une recherche floue par nom.
QueryConsumerGroupStatus	Lorsque l'abonnement côté serveur AMQP est actif, interroge l'état d'un groupe de consommateurs (clients en ligne, débit de consommation, volume de messages accumulés et horodatage de la dernière consommation).
ResetConsumerGroupPosition	Purge les messages accumulés d'un groupe de consommateurs lorsque l'abonnement côté serveur AMQP est activé.
DeleteConsumerGroup	Supprime un groupe de consommateurs.
CreateConsumerGroupSubscribeRelation	Associe un groupe de consommateurs à un abonnement côté serveur AMQP.
DeleteConsumerGroupSubscribeRelation	Dissocie un groupe de consommateurs d'un abonnement côté serveur AMQP.

Messagerie

API	Description
RRpc	Envoie une requête à un appareil et reçoit sa réponse de façon synchrone.
PubBroadcast	Diffuse un message broadcast à l'ensemble des appareils d'un produit ou à tous ceux abonnés à un Topic.
Pub	Publie un message sur un appareil via un Topic personnalisé. Cette opération permet aussi de diffuser des broadcasts aux appareils en ligne d'un produit qui sont abonnés à ce Topic.
BatchPub	Publie un message à destination de plusieurs appareils d'un produit en utilisant un Topic personnalisé.
SubscribeTopic	Abonne un appareil à un Topic.
QueryDeviceSubTopic	Liste les Topics auxquels un appareil est abonné.

Shadows d'appareils

API	Description
GetDeviceShadow	Interroge les informations de shadow d'un appareil.
UpdateDeviceShadow	Modifie les informations de shadow d'un appareil.

Mises à jour OTA

API	Description
GenerateOTAUploadURL	Génère l'URL ainsi que les détails requis pour uploader un package de mise à jour vers OSS.
GenerateDeviceNameListURL	Génère l'URL et les détails pour uploader un fichier contenant la liste des appareils vers OSS. Lors de la création d'un lot statique, ce fichier permet de cibler les appareils à mettre à jour.
CreateOTAFirmware	Ajoute un package de mise à jour.
DeleteOTAFirmware	Supprime un package de mise à jour.
ListOTAFirmware	Liste les packages de mise à jour.
QueryOTAFirmware	Obtient les détails d'un package de mise à jour.
CreateOTAVerifyJob	Crée un lot de vérification pour valider un package de mise à jour.
CreateOTAStaticUpgradeJob	Crée un lot de mise à jour statique.
CreateOTADynamicUpgradeJob	Crée un lot de mise à jour dynamique.
ListOTAJobByFirmware	Liste les lots de mise à jour associés à un package.
ListOTAJobByDevice	Liste les lots de mise à jour concernant un appareil spécifique.
ListOTATaskByJob	Liste les tâches de mise à jour d'un appareil par lot de mise à jour.
QueryOTAJob	Consulte les détails d'un lot de mise à jour.
CancelOTAStrategyByJob	Annule la politique de mise à jour associée à un lot dynamique.
CancelOTATaskByDevice	Annule les tâches de mise à jour en attente d'un appareil pour un package donné.
CancelOTATaskByJob	Annule les tâches de mise à jour des appareils appartenant à un lot.
CreateOTAModule	Crée un module OTA pour un produit.
UpdateOTAModule	Modifie l'alias et la description d'un module OTA.
DeleteOTAModule	Supprime un module OTA personnalisé.
ListOTAModuleByProduct	Liste les modules OTA d'un produit.
ConfirmOTATask	Confirme les tâches de mise à jour d'appareils dont le statut est en attente de confirmation.
ListOTAUnfinishedTaskByDevice	Liste les tâches de mise à jour inachevées pour un appareil.