QueryThingModel - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

Les fonctionnalités TSL comprennent les propriétés, les services et les événements.

Si des modules personnalisés sont ajoutés au modèle TSL d'un produit, laissez le paramètre FunctionBlockId vide pour récupérer les fonctionnalités TSL de tous les modules personnalisés, ou indiquez-le pour récupérer celles d'un module personnalisé spécifique.

Pour plus d'informations sur le format de données du paramètre de réponse ThingModelJson, consultez la rubrique Structure de données de ThingModelJson .

Limites de QPS

Vous pouvez appeler cette opération jusqu'à 10 fois par seconde par compte.

Remarque

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

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour votre commodité, 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 requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryThingModel	Opération à effectuer. Définissez la valeur sur QueryThingModel.
IotInstanceId	String	Non	iot_instc_pu*_c-v64	ID de l'instance. Vous pouvez consulter l'ID de l'instance sous l'onglet Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez spécifier ce paramètre. À défaut, la requête échoue. Si l'onglet Overview ou l'ID de l'instance n'apparaît pas dans la console IoT Platform, inutile de spécifier ce paramètre. Pour plus d'informations sur les instances, consultez la rubrique Présentation.
ResourceGroupId	String	Non	rg-acfm4l5tcwd****	ID du groupe de ressources. Important IoT Platform prend en charge la gestion des groupes de ressources uniquement par instance. Le paramètre ResourceGroupId est ignoré. Inutile de le spécifier.
ProductKey	String	Non	a1BwAGV****	ProductKey du produit.
ModelVersion	String	Non	v1.0.0	Numéro de version du modèle TSL. Appelez l'opération ListThingModelVersion pour afficher les numéros de version du modèle TSL d'un produit. Si vous omettez ce paramètre, le brouillon du modèle TSL est interrogé. Si vous le spécifiez, le modèle TSL de la version indiquée est interrogé.
FunctionBlockId	String	Non	BatteryModule	Identifiant du module TSL personnalisé. Chaque identifiant est unique au sein d'un produit. Si vous omettez ce paramètre, le module par défaut est interrogé.

Outre les paramètres de requête spécifiques à l'opération, vous devez également spécifier les paramètres de requête communs. Pour plus d'informations, consultez la rubrique Paramètres 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 la requête. Pour plus d'informations, consultez la rubrique Codes d'erreur.
Data	Struct		Données renvoyées en cas de succès de la requête.
ThingModelJson	String	{ "productKey":"a1Jw4id***", "_ppk":{ "version":"1.1", "description":"xxx" }, "properties":[ { "identifier": "SimCardType", "dataSpecs": { "max": "1", "dataType": "INT", "unit": "mmHg", "min": "0", "step": "1" }, "std": false, "custom": true, "dataType": "INT", "rwFlag": "READ_ONLY", "productKey": "a1Jw4idFWHX", "required": false, "customFlag": true, "name": "SIM card type" } ], "services":[], "events":[] }	Fonctionnalités du modèle TSL. Le format de données diffère entre le module par défaut et les modules personnalisés. Pour plus d'informations sur le format de données du paramètre ThingModelJson, consultez la rubrique Structure de données de ThingModelJson.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de la requête.
ProductKey	String	a1BwAGV****	ProductKey du produit.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la requête.
Success	Boolean	true	Indique si la requête a abouti. true false

Exemples

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryThingModel
&ProductKey=a1bPo9p****
&ModelVersion=v1.0.0
&<Common request parameters>

Exemple de réponse réussie

Format XML

<QueryThingModelResponse>
    <RequestId>1F9041A2-ED5B-4A5A-9C44-598E28C0B434</RequestId>
    <Data>
        <ThingModelJson>{"_ppk":{"version":"1594253010934"},"events":[],"productKey":"a114xeJ****","properties":[{"configCode":"8C03F0EEC63D4897BF2637F89AE36B011594227294067","custom":true,"customFlag":true,"dataSpecs":{"custom":true,"dataType":"INT","max":"1","min":"0","step":"1","unit":"ppb"},"dataType":"INT","description":"1","extendConfig":"{\"originalDataType\":{\"specs\":{\"registerCount\":1,\"reverseRegister\":0,\"swap16\":0},\"type\":\"bool\"},\"identifier\":\"WakeUpData\",\"registerAddress\":\"0x04\",\"scaling\":1,\"writeFunctionCode\":0,\"operateType\":\"inputStatus\",\"pollingTime\":1000,\"trigger\":1}","identifier":"WakeUpData","name":"Wakeup_Data","productKey":"a114xeJGj2p","required":false,"rwFlag":"READ_ONLY","std":false}],"services":[]}</ThingModelJson>
    </Data>
    <Success>true</Success>
</QueryThingModelResponse>

Format JSON

{
   "RequestId": "1F9041A2-ED5B-4A5A-9C44-598E28C0B434",
   "Data": {
      "ThingModelJson": "{\"_ppk\":{\"version\":\"1594253010934\"},\"events\":[],\"productKey\":\"a114xeJ****\",\"properties\":[{\"configCode\":\"8C03F0EEC63D4897BF2637F89AE36B011594227294067\",\"custom\":true,\"customFlag\":true,\"dataSpecs\":{\"custom\":true,\"dataType\":\"INT\",\"max\":\"1\",\"min\":\"0\",\"step\":\"1\",\"unit\":\"ppb\"},\"dataType\":\"INT\",\"description\":\"1\",\"extendConfig\":\"{\\\"originalDataType\\\":{\\\"specs\\\":{\\\"registerCount\\\":1,\\\"reverseRegister\\\":0,\\\"swap16\\\":0},\\\"type\\\":\\\"bool\\\"},\\\"identifier\\\":\\\"WakeUpData\\\",\\\"registerAddress\\\":\\\"0x04\\\",\\\"scaling\\\":1,\\\"writeFunctionCode\\\":0,\\\"operateType\\\":\\\"inputStatus\\\",\\\"pollingTime\\\":1000,\\\"trigger\\\":1}\",\"identifier\":\"WakeUpData\",\"name\":\"Wakeup_Data\",\"productKey\":\"a114xeJGj2p\",\"required\":false,\"rwFlag\":\"READ_ONLY\",\"std\":false}],\"services\":[]}"
   },
   "Code": "",
   "Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez la rubrique Codes d'erreur de service .