Tous les produits
Search
Centre de documentation

IoT Platform:Format JSON du Device Shadow

Dernière mise à jour :Aug 09, 2026

Découvrez les propriétés et la structure JSON des Device Shadows dans IoT Platform.

Exemple de document JSON pour un Device Shadow :

{
    "state": {
        "desired": {
            "color": "RED", 
            "sequence": [
                "RED", 
                "GREEN", 
                "BLUE"
            ]
        }, 
        "reported": {
            "color": "GREEN"
        }
    }, 
    "metadata": {
        "desired": {
            "color": {
                "timestamp": 1469564492
            }, 
            "sequence": {
                "timestamp": 1469564492
            }
        }, 
        "reported": {
            "color": {
                "timestamp": 1469564492
            }
        }
    }, 
    "timestamp": 1469564492, 
    "version": 1
}

Le tableau Description des propriétés JSON répertorie les propriétés JSON.

Tableau 1. Description des propriétés JSON
Propriété Description
desired État souhaité de l'appareil. La section desired n'apparaît que si le Device Shadow possède un état souhaité.

Les applications écrivent dans la section desired pour mettre à jour l'état d'un objet sans connexion directe avec l'appareil.

reported État signalé par l'appareil. Les appareils écrivent dans la section reported pour signaler leur dernier état.

Les applications lisent cette section pour obtenir l'état de l'appareil.

La section reported est facultative. Un Device Shadow reste valide même sans la section reported.

metadata Lorsqu'un utilisateur met à jour le document d'état de l'appareil, le service Device Shadow met automatiquement à jour les metadata.

Chaque propriété de l'état de l'appareil comporte un horodatage au format Epoch, indiquant la date de sa dernière mise à jour.

timestamp Date de la dernière mise à jour du document Shadow.
version Lorsqu'un utilisateur met activement à jour le numéro de version, le service Device Shadow vérifie si la valeur de version dans la requête dépasse la version actuelle.

Si c'est le cas, le service met à jour le Device Shadow et définit version sur la valeur demandée. Sinon, la requête est rejetée.

Le numéro de version s'incrémente à chaque mise à jour, garantissant que vous modifiez toujours la dernière version du document.

Le paramètre version est de type long. Pour éviter les débordements, transmettez -1 afin de réinitialiser la version à 0.

Remarque

Les Device Shadows prennent en charge les tableaux, mais ceux-ci doivent être mis à jour dans leur intégralité.

Exemple de mise à jour de données sous forme de tableau :

  • État initial :

    {
        "reported" : { 
            "colors" : [
                "RED", 
                "GREEN",
                "BLUE" 
            ]
        }
    }
  • Mise à jour :

    {
        "reported" : {
            "colors" : [
                "RED"
            ] 
        }
    }
  • État final :

    {
        "reported" : {
            "colors" : [
                "RED"
            ] 
        }
    }