Interroge les définitions de fonctionnalités dans le modèle Thing Specification Language (TSL) publié d'un produit spécifié.
Limites QPS
Vous pouvez appeler cette opération jusqu'à 10 fois par seconde par compte.
Les utilisateurs Resource Access Management (RAM) d'un compte Alibaba Cloud partagent le quota du compte.
Débogage
Paramètres de requête
|
Paramètre |
Type |
Obligatoire |
Exemple |
Description |
|
Action |
String |
Oui |
QueryThingModelPublished |
L'opération que vous souhaitez effectuer. Définissez la valeur sur QueryThingModelPublished. |
|
ProductKey |
String |
Oui |
a1BwAGV**** |
La ProductKey du produit. |
|
IotInstanceId |
String |
Non |
iot-cn-0pp1n8t**** |
L'ID d'instance. Vous pouvez trouver l'ID d'instance sur la page Overview de la console IoT Platform. Important
Pour plus d'informations, consultez Overview. |
|
ResourceGroupId |
String |
Non |
rg-acfm4l5tcwd*** |
L'ID du groupe de ressources. Important
IoT Platform prend en charge la gestion des ressources uniquement par instance. Le paramètre ResourceGroupId ne prend pas effet dans cette requête. Vous n'avez pas besoin de spécifier ce paramètre. |
|
ModelVersion |
String |
Non |
v1.0.0 |
Le numéro de version du modèle TSL. Vous pouvez appeler l'opération ListThingModelVersion pour consulter le numéro de version du modèle TSL d'un produit. Si vous ne spécifiez pas ce paramètre, la dernière version publiée du modèle TSL est renvoyée. |
|
FunctionBlockId |
String |
Non |
BatteryModule |
L'identifiant du module TSL personnalisé. Chaque identifiant est unique au sein d'un produit. Si vous ne spécifiez pas ce paramètre, le module par défaut est interrogé. |
En plus des paramètres de requête spécifiques à l'opération, vous devez spécifier les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez Paramètres communs.
Paramètres de réponse
|
Paramètre |
Type |
Exemple |
Description |
|
Code |
String |
iot.system.SystemException |
Le code d'erreur renvoyé si la requête échoue. Pour plus d'informations, consultez Codes d'erreur. |
|
Data |
Struct |
Les données renvoyées. |
|
|
ThingModelJson |
String |
{\"_ppk\":{\"version\":\"1594253010934\"},\"events\":[],\"productKey\":\"a1BwAGV****\",\"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\":[]} |
Les définitions de fonctionnalités dans le modèle TSL. Pour plus d'informations sur le format de données de ThingModelJson, consultez Structure de données de ThingModelJson. |
|
ErrorMessage |
String |
A system exception occurred. |
Le message d'erreur renvoyé si la requête échoue. |
|
ProductKey |
String |
a1BwAGV**** |
La ProductKey du produit. |
|
RequestId |
String |
E4C0FF92-2A86-41DB-92D3-73B60310D25E |
L'ID de la requête. |
|
Success |
Boolean |
true |
Indique si la requête a réussi. Valeurs possibles :
|
Exemples
Exemples de requêtes
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryThingModelPublished
&ProductKey=a1BwAGV****
&<Common request parameters>
Exemples de réponses réussies
XML format
<QueryThingModelPublishedResponse>
<RequestId>1F9041A2-ED5B-4A5A-9C44-598E28C0B434</RequestId>
<Data>
<ThingModelJson>{"_ppk":{"version":"1594253010934"},"events":[],"productKey":"a1BwAGV****","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":"a114xeJ****","required":false,"rwFlag":"READ_ONLY","std":false}],"services":[]}</ThingModelJson>
</Data>
<Success>true</Success>
</QueryThingModelPublishedResponse>
JSON format
{
"RequestId": "1F9041A2-ED5B-4A5A-9C44-598E28C0B434",
"Data": {
"ThingModelJson": "{\"_ppk\":{\"version\":\"1594253010934\"},\"events\":[],\"productKey\":\"a1BwAGV****\",\"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\":[]}"
},
"Success": true
}
Codes d'erreur
Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.