QueryThingModelExtendConfig - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les informations relatives aux paramètres étendus du langage de spécification des objets (TSL) d'un produit.

Limites de QPS

Vous pouvez appeler cette opération API jusqu'à 20 fois par seconde et par compte.

Remarque

Les utilisateurs Resource Access Management (RAM) d'un compte Alibaba Cloud partagent le quota de ce compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryThingModelExtendConfig	Opération à effectuer. Définissez la valeur sur QueryThingModelExtendConfig.
ProductKey	String	Oui	a1T27vz****	ProductKey du produit.
IotInstanceId	String	Non	iot-cn-0pp1n8t****	ID de l'instance. Vous pouvez consulter l'ID de l'instance dans l'onglet Overview de la console IoT Platform. Important Si l'instance possède un ID, vous devez spécifier ce paramètre, sinon la requête échouera. Si l'onglet Overview ou l'ID de l'instance n'apparaît pas dans la console IoT Platform, il n'est pas nécessaire de spécifier ce paramètre. Pour en savoir plus sur les instances, consultez la rubrique Vue d'ensemble.
ResourceGroupId	String	Non	123***	ID du groupe de ressources. Important IoT Platform ne prend en charge la gestion des groupes de ressources qu'au niveau de l'instance. Le paramètre ResourceGroupId est ignoré. Il n'est pas nécessaire de le spécifier.
ModelVersion	String	Non	v1.0.0	Numéro de version du modèle TSL. Appelez l'opération ListThingModelVersion pour consulter les numéros de version du modèle TSL d'un produit. Si vous ne spécifiez pas ce paramètre, la dernière version publiée est renvoyée.
FunctionBlockId	String	Non	BatteryModule	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é.

Outre les paramètres de requête spécifiques à l'opération présentés ci-dessus, vous devez spécifier les paramètres de requête communs lors de l'appel de cette opération. Pour en savoir plus sur les paramètres de requête communs, consultez la rubrique Paramètres communs.

Paramètres de réponse

Paramètre	Type	Exemple	Description
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de la requête.
Data	Struct		Données renvoyées en cas de réussite de la requête.
Configuration	String	{\"profile\":{\"productKey\":\"a114x\"},\"properties\":[{\"originalDataType\":{\"specs\":{\"registerCount\":1,\"reverseRegister\":0,\"swap16\":0},\"type\":\"bool\"},\"identifier\":\"WakeUpData\",\"registerAddress\":\"0x04\",\"scaling\":1,\"writeFunctionCode\":0,\"operateType\":\"inputStatus\",\"pollingTime\":1000,\"trigger\":1}]}	Informations relatives aux paramètres TSL étendus. Pour en savoir plus sur la définition des paramètres étendus, consultez la description de extendConfig dans la rubrique CreateThingModel.
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de la requête. Pour en savoir plus sur les codes d'erreur, consultez la rubrique Codes d'erreur.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la requête.
Success	Boolean	true	Indique si la requête a abouti. Valeurs possibles : true false

Exemples

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryThingModelExtendConfig
&ProductKey=a1T27vz****
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

<QueryThingModelExtendConfigResponse>
    <Data>
        <Configuration>{"profile":{"productKey":"a114x******"},"properties":[{"originalDataType":{"specs":{"registerCount":1,"reverseRegister":0,"swap16":0},"type":"bool"},"identifier":"WakeUpData","registerAddress":"0x04","scaling":1,"writeFunctionCode":0,"operateType":"inputStatus","pollingTime":1000,"trigger":1}]}</Configuration>
    </Data>
    <RequestId>6DDF9D04-24C3-40D8-B490-2A528E59EA67</RequestId>
    <Success>true</Success>
</QueryThingModelExtendConfigResponse>

Format JSON

{
   "Data": {
      "Configuration": "{\"profile\":{\"productKey\":\"a114x******\"},\"properties\":[{\"originalDataType\":{\"specs\":{\"registerCount\":1,\"reverseRegister\":0,\"swap16\":0},\"type\":\"bool\"},\"identifier\":\"WakeUpData\",\"registerAddress\":\"0x04\",\"scaling\":1,\"writeFunctionCode\":0,\"operateType\":\"inputStatus\",\"pollingTime\":1000,\"trigger\":1}]}"
   },
   "RequestId": "6DDF9D04-24C3-40D8-B490-2A528E59EA67",
   "Success": true
}

Codes d'erreur

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