QueryThingModelExtendConfigPublished - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les paramètres étendus d'un modèle Thing Specification Language (TSL) publié.

Limites

Chaque compte Alibaba Cloud peut exécuter un maximum de 20 requêtes par seconde (QPS).

Remarque

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

Débogage

Alibaba Cloud met à disposition OpenAPI Explorer pour simplifier l'utilisation des API. OpenAPI Explorer calcule automatiquement la valeur de la signature. Pour votre confort, 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 la requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryThingModelExtendConfigPublished	L'opération que vous souhaitez effectuer. Définissez la valeur sur QueryThingModelExtendConfigPublished.
ProductKey	String	Oui	a1BwAGV****	La ProductKey du produit. Vous pouvez consulter la ProductKey sur la page des détails du produit dans la console IoT Platform. Vous pouvez également obtenir la ProductKey en appelant l'opération QueryProductList.
IotInstanceId	String	Non	iot-cn-0pp1n8t****	L'ID de l'instance. Vous pouvez consulter l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez configurer ce paramètre. Si vous ne définissez pas ce paramètre, l'appel échouera. Si votre instance ne dispose pas de page Overview ou d'ID, vous n'avez pas besoin de définir ce paramètre. Pour plus d'informations, consultez la rubrique Overview.
ModelVersion	String	Non	v1.0.0	Le numéro de version du modèle TSL. Si vous ne spécifiez pas ce paramètre, le dernier modèle TSL publié est renvoyé.
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 ci-dessus, vous devez spécifier les paramètres de requête communs lors de l'appel à cette opération. Pour plus d'informations, consultez la rubrique Paramètres de requête communs.

Paramètres de la réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez la rubrique Codes d'erreur.
Data	Struct		Les données renvoyées en cas de succès de l'appel.
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}]}	Les informations relatives aux paramètres TSL étendus. Pour plus d'informations sur la définition des paramètres étendus, consultez la rubrique CreateThingModel. Pour plus d'informations, consultez la rubrique Structure de données de ThingModelJson.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	L'ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemple de requête

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryThingModelExtendConfigPublished
&ProductKey=a1BwAGV****
&<Common request parameters>

Exemple de réponse en cas de succès

XML format

<QueryThingModelExtendConfigPublishedResponse>
  <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>
</QueryThingModelExtendConfigPublishedResponse>

JSON format

{
   "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, visitez le Centre d'erreurs API.