全部產品
Search
文件中心

IoT Platform:QueryThingModelExtendConfigPublished

更新時間:Feb 14, 2025

調用該介面擷取發行物模型的擴充描述配置。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為20。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱 類型 是否必選 樣本值 描述
Action String QueryThingModelExtendConfigPublished

系統規定參數。取值:QueryThingModelExtendConfigPublished。

ProductKey String a1BwAGV****

產品的ProductKey

可以在物聯網平台控制台產品頁查看,或調用QueryProductList查看ProductKey的取值。

IotInstanceId String iot-cn-0pp1n8t****

執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID

重要
  • 若有ID值,必須傳入該ID值,否則調用會失敗。
  • 若無執行個體概覽頁面或ID值,則無需傳入。

執行個體的更多資訊,請參見執行個體概述

ModelVersion String v1.0.0

要擷取的物模型版本號碼。不傳入此參數,則返回發行的最新版本。

FunctionBlockId String BatteryModule

物模型自訂模組標識符,在產品中具有唯一性。

不傳入此參數時,匯出預設模組資料。

調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔

返回資料

名稱 類型 樣本值 描述
Code String iot.system.SystemException

調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼

Data Struct

調用成功時,返回的資料。

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}]}

物模型擴充描述配置。參數含義請參見CreateThingModel的extendConfig說明。

更多資訊,請參見ThingModelJson資料說明

ErrorMessage String 系統異常

調用失敗時,返回的出錯資訊。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里雲為該請求產生的唯一識別碼。

Success Boolean true

是否調用成功。

  • true:調用成功。
  • false:調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryThingModelExtendConfigPublished
&ProductKey=a1BwAGV****
&<公用請求參數>

正常返回樣本

XML格式

<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格式

{
   "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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。