CreateProduct
调用该接口创建产品
服务地址：
华东2（上海）
输入参数
只看必填
IotInstanceId实例ID
ProductName为新建产品命名
NodeType产品的节点类型
DataFormat数据格式
Description为新建产品添加描述信息
AliyunCommodityCode产品版本类型
Id2是否使用ID²认证
请选择布尔值
ProtocolType设备接入网关的协议类型
NetType连网方式
JoinPermissionIdLoRaWAN入网凭证ID
ResourceGroupId资源组ID
AuthType产品下的设备接入物联网平台的认证方式
CategoryKey产品品类的标识符
PublishAuto是否在产品创建后自动发布物模型
请选择布尔值
ValidateType数据校验级别
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

使用说明

  • 若产品需要使用物模型功能，必选传入请求参数 AliyunCommodityCode 和 DataFormat，且 AliyunCommodityCode 值为iothub_senior。详细说明，请参见下文请求参数表。
  • 在 MQTT 型实例下仅支持创建一个产品。

QPS 限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为 50。

说明 单个阿里云账号下的所有 RAM 用户共享该阿里云账号的配额。

请求参数

字段名称字段详情
IotInstanceIdstring

实例 ID。您可在物联网平台控制台的实例概览页面，查看当前实例的 ID。展开详情

示例值:iot-***-v64***
ProductNamestring

为新建产品命名。展开详情

示例值:Light参考取值来源:
    QueryProduct
    ListProductByTags
NodeTypeinteger<int32>

产品的节点类型，取值：展开详情

示例值:0
DataFormatinteger<int32>

数据格式。可选值：展开详情

示例值:1
Descriptionstring

为新建产品添加描述信息。长度不超过 100 个字符。

示例值:Product test
AliyunCommodityCodestring

产品版本类型。 展开详情

示例值:iothub_senior
Id2boolean

是否使用 ID²认证。可选值：展开详情

示例值:false
ProtocolTypestring

设备接入网关的协议类型。展开详情

示例值:modbus
NetTypestring

连网方式。展开详情

示例值:WIFI
JoinPermissionIdstring

LoRaWAN 入网凭证 ID。连网方式 NetType 选择为 LORA 时，该参数必需。展开详情

示例值:8***参考取值来源:
    QueryLoRaJoinPermissions
ResourceGroupIdstring

资源组 ID。展开详情

示例值:rg-acfmxazb4ph***
AuthTypestring

产品下的设备接入物联网平台的认证方式。展开详情

示例值:secret
CategoryKeystring

产品品类的标识符。如果传入此参数，创建的产品将使用指定品类的物模型；不传入，则不使用任何品类的标准物模型。展开详情

示例值:Lighting
PublishAutoboolean

是否在产品创建后自动发布物模型。展开详情

示例值:false
ValidateTypeinteger<int32>

数据校验级别。不传入此参数时，默认为弱校验。可取值：展开详情

示例值:1

请求说明

调用 API 时，除了本文介绍的该 API 的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回参数

字段名称字段详情
Codestring

调用失败时，返回的错误码。更多信息，请参见错误码。

示例值:200
ProductKeystring

产品的 ProductKey，物联网平台为产品颁发的唯一标识符。

示例值:a1FlqIQ****
ErrorMessagestring

调用失败时，返回的出错信息。

示例值:系统异常
RequestIdstring

阿里云为该请求生成的唯一标识符。

示例值:E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565
Successboolean

是否调用成功。展开详情

示例值:true
Dataobject

调用成功时，返回的新建产品信息。

变更历史
暂无变更历史