全部產品
Search
文件中心

IoT Platform:PublishThingModel

更新時間:Feb 13, 2025

調用該介面發布指定產品的物模型。

使用說明

如果指定產品發行,需先調用介面CancelReleaseProduct取消該產品發布,才能調用本介面發布物模型。

QPS限制

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

說明 單個阿里雲帳號下的所有RAM使用者共用該阿里雲帳號的配額。

調試

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

請求參數

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

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

ProductKey String a1BwAGV****

產品的ProductKey。

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

IotInstanceId String iot_instc_pu****_c*-v64********

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

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

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

ResourceGroupId String rg-acfm4l5tcwd****

資源群組ID。

重要 目前,物聯網平台僅支援執行個體維度資源群組管理。請求參數ResourceGroupId配置已無效,無需再傳入。
ModelVersion String v1.0.0

設定物模型的版本號碼。

版本號碼支援英文大、小字母、數字和英文句號(.),長度範圍不超過16個字元。

Description String 第二版

物模型版本的描述。

調用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=PublishThingModel
&ProductKeySource=a1rYuVF****
&ModelVersion=V1.0.0
&<公用請求參數>

正常返回樣本

XML格式

<PublishThingModelResponse>
  <RequestId>5252CC6E-9E4B-4DB1-B1D8-7EEA190A5B3E</RequestId>
  <Success>true</Success>
</PublishThingModelResponse>

JSON格式

{
  "RequestId": "5252CC6E-9E4B-4DB1-B1D8-7EEA190A5B3E",
  "Success": true
}

錯誤碼

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