Tags d'appareil - IoT Platform - Centre de documentation Alibaba Cloud

Certaines informations relatives à un appareil, telles que le fournisseur et le modèle, peuvent être communiquées à IoT Platform sous forme de tags d'appareil. Vous pouvez également interroger et supprimer les tags d'un appareil. Cette rubrique décrit les topics et les formats de données utilisés pour envoyer, interroger et supprimer les tags d'appareil.

Envoyer des tags

Les topics suivants sont utilisés lorsqu'un appareil envoie des demandes à IoT Platform et qu'IoT Platform renvoie des réponses à l'appareil :

Topic de demande :/sys/${productKey}/${deviceName}/thing/deviceinfo/update
Topic de réponse :/sys/${productKey}/${deviceName}/thing/deviceinfo/update_reply

Exemple de demande au format JSON Alink :

{
    "id": "123",
    "version": "1.0",
    "sys":{
        "ack":0
    },
    "params":[
        {
            "attrKey": "Temperature",
            "attrValue": "36.8"
        }
    ],
    "method": "thing.deviceinfo.update"
}

Exemple de réponse au format JSON Alink :

{
    "id": "123",
    "code": 200,
    "data": {}
}

Paramètres

Paramètre	Type	Description
id	String	ID du message. Valeurs valides : de 0 à 4294967295. Chaque ID de message doit être unique pour l'appareil.
version	String	Numéro de version du protocole. Définissez la valeur sur 1.0.
sys	Object	Paramètres de fonctionnalité étendue. Remarque Si vous utilisez un SDK côté appareil sans configurer les fonctionnalités étendues, ce paramètre est omis et les valeurs par défaut s'appliquent.
ack	Integer	Indique si le cloud renvoie une réponse. Champ situé sous sys. 1 : Renvoie une réponse. 0 : Aucune réponse renvoyée. Important Exemples d'utilisation du modèle Thing Specification Language. S'il n'est pas configuré, ce paramètre est omis et une réponse est renvoyée par défaut.
params	Object	Paramètres de la demande. Le paramètre attrKey spécifie la clé du tag, et le paramètre attrValue spécifie la valeur du tag. Le paramètre params peut contenir jusqu'à 200 éléments dans un tableau.
method	String	Méthode de la demande. Définissez la valeur sur `thing.deviceinfo.update`.
attrKey	String	Clé du tag. La clé doit comporter entre 1 et 30 caractères et peut contenir des lettres, des chiffres, des traits de soulignement (_), des tirets (-), des signes dièse (#), des arrobas (@), des signes pourcentage (%), des esperluettes (&), des astérisques (*) et des points (.).
attrValue	String	Valeur du tag. La valeur doit comporter entre 1 et 128 caractères et peut contenir des caractères chinois, des lettres, des chiffres, des caractères japonais, des traits de soulignement (_), des tirets (-), des signes dièse (#), des arrobas (@), des signes pourcentage (%), des esperluettes (&), des deux-points (:) et des points (.). Chaque caractère chinois ou japonais compte pour deux caractères.
code	Integer	Code d'état HTTP dans la réponse. La valeur 200 indique que la demande a abouti.

Codes d'erreur

Code d'erreur	Message d'erreur	Description
460	request parameter error	Message d'erreur renvoyé car les paramètres de la demande ne sont pas valides.
6100	device not found	Message d'erreur renvoyé car l'appareil n'existe pas.

Interroger des tags

Important

Interrogez jusqu'à 10 tags à la fois.
Interrogez uniquement des tags personnalisés. Vous ne pouvez pas interroger les tags internes d'IoT Platform.
Spécifiez la clé du tag que vous souhaitez interroger. Si vous ne spécifiez aucune clé de tag, aucune donnée n'est renvoyée.

Les topics suivants sont utilisés lorsqu'un appareil envoie des demandes à IoT Platform et qu'IoT Platform renvoie des réponses à l'appareil :

Topic de demande :/sys/${productKey}/${deviceName}/thing/deviceinfo/get
Topic de réponse :/sys/${productKey}/${deviceName}/thing/deviceinfo/get_reply

Exemple de demande au format JSON Alink :

{
    "id": "123",
    "version": "1.0",
    "params":{ 
        "attrKeys":["attrKey1", "attrKey2", "attrKey3"]
    },
    "method": "thing.deviceinfo.get"
}

Exemple de réponse au format JSON Alink :

{
    "id": "123",
    "code": 200,
    "data": [
        {
            "attrKey1":"v1"
        },
        {
            "attrKey2":"v2"
        },
        {
            "attrKey3":"v3"
        }
    ]
}

Paramètres

Paramètre	Type	Description
id	String	ID du message. Valeurs valides : de 0 à 4294967295. Chaque ID de message doit être unique pour l'appareil.
version	String	Numéro de version du protocole. Définissez la valeur sur 1.0.
params	Object	Paramètres de la demande. Le paramètre attrKeys spécifie les clés des tags que vous souhaitez interroger.
attrKeys	JSONArray	Clés des tags que vous souhaitez interroger. Remarque Si une clé de tag n'est pas valide, par exemple en cas de doublon, une exception est renvoyée. Si une clé de tag n'existe pas, aucune donnée n'est renvoyée. Pour plus d'informations sur la manière de spécifier un tag au format clé-valeur pour un appareil, consultez Modifier les tags d'appareil.
method	String	Méthode de la demande. Définissez la valeur sur `thing.deviceinfo.get`.
data	JSONArray	Informations renvoyées sur les tags, incluant les clés et les valeurs des tags.
code	Integer	Code d'état HTTP dans la réponse. La valeur 200 indique que la demande a abouti.

Le tableau suivant décrit les codes d'erreur.

Code d'erreur	Message d'erreur	Description
460	request parameter error	Message d'erreur renvoyé car les paramètres de la demande ne sont pas valides. Par exemple, la valeur du paramètre attrKeys n'est pas un tableau JSON, aucune clé de tag n'est spécifiée, les clés de tag spécifiées sont en double ou le nombre de clés de tag spécifiées dépasse 10.
429	too many requests	Message d'erreur renvoyé car la limitation de débit est déclenchée en raison d'un nombre excessif de requêtes par seconde (QPS). Appelez cette opération d'API jusqu'à 50 fois par seconde par compte. Remarque Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota du compte.

Supprimer des tags

Les topics suivants sont utilisés lorsqu'un appareil envoie des demandes à IoT Platform et qu'IoT Platform renvoie des réponses à l'appareil :

Topic de demande :/sys/${productKey}/${deviceName}/thing/deviceinfo/delete
Topic de réponse :/sys/${productKey}/${deviceName}/thing/deviceinfo/delete_reply

Exemple de demande au format JSON Alink :

{
    "id": "123",
    "version": "1.0",
    "sys":{
        "ack":0
    },
    "params": [
        {
            "attrKey": "Temperature"
        }
    ],
    "method": "thing.deviceinfo.delete"
}

Exemple de réponse au format JSON Alink :

{
    "id": "123",
    "code": 200,
    "data": {}
}

Paramètres

Paramètre	Type	Description
id	String	ID du message. Valeurs valides : de 0 à 4294967295. Chaque ID de message doit être unique pour l'appareil.
version	String	Numéro de version du protocole. Définissez la valeur sur 1.0.
sys	Object	Paramètres de fonctionnalité étendue. Remarque Si vous utilisez un SDK côté appareil sans configurer les fonctionnalités étendues, ce paramètre est omis et les valeurs par défaut s'appliquent.
ack	Integer	Indique si le cloud renvoie une réponse. Champ situé sous sys. 1 : Renvoie une réponse. 0 : Aucune réponse renvoyée. Important Exemples d'utilisation du modèle Thing Specification Language. S'il n'est pas configuré, ce paramètre est omis et une réponse est renvoyée par défaut.
params	Object	Paramètres de la demande. Le paramètre attrKey spécifie les clés des tags que vous souhaitez supprimer.
method	String	Méthode de la demande. Définissez la valeur sur `thing.deviceinfo.delete`.
attrKey	String	Clés des tags que vous souhaitez supprimer.
code	Integer	Code d'état HTTP dans la réponse. La valeur 200 indique que la demande a abouti.

Codes d'erreur

Code d'erreur	Message d'erreur	Description
460	request parameter error	Message d'erreur renvoyé car les paramètres de la demande ne sont pas valides.
6100	device not found	Message d'erreur renvoyé car l'appareil n'existe pas.