全部產品
Search

搜尋本產品

    IoT Platform：CreateThingModel

    文件中心

    IoT Platform：CreateThingModel

    更新時間：Feb 13, 2025

    調用該介面為指定產品的物模型新增功能，支援同時新增物模型擴充描述。

    使用說明

    • 如果指定產品發行，需先調用介面CancelReleaseProduct取消該產品發布，才能調用本介面新增物模型功能。
    • 調用介面前，您可通過json-schema對ThingModelJson中的入參進行預校正，請參見ThingModelJson資料說明中的“校正”。
    • 單次調用最多可新增10個功能，即新增屬性、服務和事件的數量總計不超過10。

    QPS限制

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

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

    調試

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

    請求參數

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

    系統規定參數。取值：CreateThingModel。
    ProductKey String 是 a1BwAGV****

    產品的ProductKey，物聯網平台為產品頒發的通用唯一識別碼。

    您可以在物聯網平台控制台或調用QueryProductList介面，查看當前帳號下所有產品的資訊。
    IotInstanceId String 否 iot-cn-0pp1n8t****

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

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

    執行個體的更多資訊，請參見執行個體概述。
    ThingModelJson String 否 { "properties":[ { "identifier": "SimCardType", "extendConfig":"{...}", "dataSpecs": { "max": "1", "dataType": "INT", "unit": "mmHg", "min": "0", "step": "1" }, "std": false, "custom": true, "dataType": "INT", "rwFlag": "READ_ONLY", "productKey": "a1bPo9p****", "required": false, "customFlag": true, "name": "sim卡類型" } ]， "services":[...], "events":[...] }

    新增的功能定義詳情。最多能包含10個功能的定義資訊。

    在ThingModelJson每個property結構中，可以使用extendConfig來描述擴充物模型的資料。更多資訊，請參見ThingModelJson資料說明。

    重要 此處參數ThingModelJson的值不可傳入完整的物模型TSL資料，只需傳入JSON格式的物模型properties、services和events欄位資料。

    以下樣本值為包含多種資料類型的屬性資料，例如STRUCT、ARRAY。

    
{
  "properties": [
    {
      "custom": true,
      "dataSpecsList": [
        {
          "childDataType": "TEXT",
          "childName": "裝置SIM卡的CCID",
          "dataSpecs": {
            "custom": true,
            "dataType": "TEXT",
            "length": 20
          },
          "dataType": "STRUCT",
          "identifier": "CCID",
          "name": "裝置SIM卡的CCID"
        },
        {
          "childDataType": "INT",
          "childName": "電池電量",
          "dataSpecs": {
            "custom": true,
            "dataType": "INT",
            "max": "60000",
            "min": "0",
            "step": "1"
          },
          "dataType": "STRUCT",
          "identifier": "battery",
          "name": "電池電量"
        },
        {
          "childDataType": "TEXT",
          "childName": "其他資訊",
          "dataSpecs": {
            "custom": true,
            "dataType": "TEXT",
            "length": 1024
          },
          "dataType": "STRUCT",
          "identifier": "other_info",
          "name": "其他資訊"
        }
      ],
      "dataType": "STRUCT",
      "identifier": "DEV_INFO",
      "name": "裝置資訊",
      "productKey": "a1T***",
      "propertyId": 18786548,
      "required": false,
      "rwFlag": "READ_ONLY"
    },
    {
      "custom": true,
      "dataSpecs": {
        "childDataType": "INT",
        "custom": true,
        "dataType": "ARRAY",
        "size": 1,
        "dataSpecs": {
          "custom": true,
          "dataType": "INT",
          "max": "65535",
          "min": "0",
          "step": "1",
          "unit": "ppm",
          "unitName": "百萬分率"
        }
      },
      "dataType": "ARRAY",
      "identifier": "airRH_SR",
      "name": "除濕機濕度",
      "productKey": "a1T***",
      "propertyId": 18786551,
      "required": false,
      "rwFlag": "READ_ONLY"
    }
  ],
  "services": [...],
  "events": [...]
}
    FunctionBlockId String 否 BatteryModule

    物模型自訂模組標識符，在產品中具有唯一性。支援英文大小寫字母、數字和底線（_），不超過30個字元。

    需與FunctionBlockName結合使用。不傳入此參數時，新增功能匯入預設模組。
    FunctionBlockName String 否 電池模組

    物模型的自訂模組名稱。支援中文、英文字母、日文、數字和底線（_），長度限制為4～30個字元，一個中文、一個日文算1個字元。

    需與FunctionBlockId結合使用。不傳入此參數時，新增功能匯入預設模組。

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

    返回資料

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

    調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
    ErrorMessage String 系統異常

    調用失敗時，返回的出錯資訊。
    RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

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

    是否調用成功。

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

    樣本

    請求樣本

    https://iot.cn-shanghai.aliyuncs.com/?Action=CreateThingModel
&ProductKey=a1bPo9p****
&ThingModelJson={"properties":[{"identifier": "SimCardType","dataSpecs": {"max": "1", "dataType": "INT","unit": "mmHg","min": "0","step": "1"},"std": false,"custom": true,"dataType": "INT","rwFlag": "READ_ONLY","productKey": "a1bPo9p****","required": false,"customFlag": true, "name": "sim卡類型"}]}
&<公用請求參數>

    正常返回樣本

    XML格式

    <CreateThingModelResponse>
  <RequestId>9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E</RequestId>
  <Success>true</Success>
</CreateThingModelResponse>

    JSON格式

    {
  "RequestId": "9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E",
  "Success": true
}

    錯誤碼

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