全部产品
Search
文档中心

阿里云物联网平台:PublishThingModel

更新时间:Sep 15, 2023

调用该接口发布指定产品的物模型。

使用说明

如果指定产品已发布,需先调用接口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
}

错误码

访问错误中心查看更多错误码。