调用该接口创建产品。
使用说明
- 若产品需要使用物模型功能,必选传入请求参数AliyunCommodityCode和DataFormat,且AliyunCommodityCode值为iothub_senior。详细说明,请参见下文请求参数表。
- 在MQTT型实例下仅支持创建一个产品。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为50。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
| Action | String | 是 | CreateProduct | 系统规定参数。取值:CreateProduct。 | 
| NodeType | Integer | 是 | 0 | 产品的节点类型,取值: 
 重要 MQTT型实例下,设备需作为直连设备接入物联网平台,NodeType必须传入0.。
 | 
| ProductName | String | 是 | Light | 为新建产品命名。 产品名称长度为4~30个字符,可以包含中文、英文字母、数字和下划线(_)。一个中文算2个字符。 重要  产品名称在当前实例下需保持唯一。
 | 
| IotInstanceId | String | 否 | iot-***-v64*** | 实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 重要 
 
 实例的更多信息,请参见实例概述。 | 
| DataFormat | Integer | 否 | 1 | 数据格式。可选值: 
 重要 MQTT型实例下,设备通信的数据格式为原始自定义格式,DataFormat必须传入0。
 | 
| Description | String | 否 | Product test | 为新建产品添加描述信息。长度不超过100个字符。 | 
| AliyunCommodityCode | String | 否 | iothub_senior | 产品版本类型。 
 重要 
 
 | 
| Id2 | Boolean | 否 | false | 是否使用ID²认证。可选值: 
 不传入此参数,则默认为false,不开通ID²认证。 说明 仅华东2(上海)地域支持ID²认证方式。如果此参数值设置为true,但传入的AuthType参数值不是id2,系统将以AuthType参数值为准。 | 
| ProtocolType | String | 否 | modbus | 设备接入网关的协议类型。 使用物模型的产品(AliyunCommodityCode=iothub_senior),且产品下的设备需通过网关接入物联网平台,需传入此参数。 可选值: 
 | 
| NetType | String | 否 | WIFI | 连网方式。 产品下的设备为网关设备或直连设备时,需传入此参数。 可选值: 
 若不传入此参数,则默认为Wi-Fi。 重要 MQTT型实例下,NetType不支持传入LORA。
 | 
| JoinPermissionId | String | 否 | 8*** | LoRaWAN入网凭证ID。连网方式NetType选择为LORA时,该参数必需。 请调用QueryLoRaJoinPermissions查询您账号下的LoRaWAN入网凭证的JoinPermissionId。 如果您还没有LoRaWAN入网凭证,请访问物联网络管理平台创建。 | 
| ResourceGroupId | String | 否 | rg-acfmxazb4ph*** | 资源组ID。 重要 
 
 | 
| AuthType | String | 否 | secret | 产品下的设备接入物联网平台的认证方式。 
 若不传入此参数,默认值为secret。 | 
| CategoryKey | String | 否 | Lighting | 产品品类的标识符。如果传入此参数,创建的产品将使用指定品类的物模型;不传入,则不使用任何品类的标准物模型。 调用ListThingTemplates,从返回结果中查看物联网平台预定义的品类信息,获取CategoryKey的取值。 | 
| PublishAuto | Boolean | 否 | false | 是否在产品创建后自动发布物模型。 
 不传入此参数,取默认值为true。 | 
| ValidateType | Integer | 否 | 1 | 数据校验级别。不传入此参数时,默认为弱校验。可取值: 
 | 
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
| 名称 | 类型 | 示例值 | 描述 | 
| Code | String | 200 | 调用失败时,返回的错误码。更多信息,请参见错误码。 | 
| Data | Struct | 调用成功时,返回的新建产品信息。 | |
| AliyunCommodityCode | String | iothub_senior | 产品类型。 
 | 
| AuthType | String | secret | 产品下的设备接入物联网平台的认证方式。 
 | 
| DataFormat | Integer | 1 | 产品类型数据格式。 
 说明 此参数为使用物模型的产品(AliyunCommodityCode=iothub_senior)特有参数。 | 
| Description | String | Product test | 产品描述信息。 | 
| Id2 | Boolean | false | 是否使用ID²认证。 
 | 
| NodeType | Integer | 0 | 产品的节点类型,取值: 
 说明 此参数为使用物模型的产品(AliyunCommodityCode=iothub_senior)特有参数。 | 
| ProductKey | String | a1FlqIQ**** | 物联网平台为新建产品颁发的全局唯一标识。 说明 请妥善保管新建产品的ProductKey。在其他操作中会用到该信息。 | 
| ProductName | String | Test | 产品的名称。 | 
| ProductSecret | String | U5tW7i44uilc**** | 产品密钥。 | 
| ProtocolType | String | modbus | 设备接入网关协议类型。 说明 此参数为使用物模型的产品(AliyunCommodityCode=iothub_senior)特有参数。 | 
| ErrorMessage | String | 系统异常 | 调用失败时,返回的出错信息。 | 
| ProductKey | String | a1FlqIQ**** | 产品的ProductKey,物联网平台为产品颁发的唯一标识符。 | 
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里云为该请求生成的唯一标识符。 | 
| Success | Boolean | true | 是否调用成功。 
 | 
示例
请求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=CreateProduct
&AliyunCommodityCode=iothub_senior
&AuthType=secret
&DataFormat=1
&Description=Product test
&NodeType=0
&ResourceGroupId=rg-acfmxazb4ph****
&ProductName=Test
&ProtocolType=modbus
&CategoryKey=Lighting
&PublishAuto=false
&<公共请求参数>正常返回示例
XML格式
<CreateProductResponse>
      <Data>
            <Description>Product test</Description>
            <DataFormat>1</DataFormat>
            <ProtocolType>modbus</ProtocolType>
            <ProductKey>a1FlqIQ****</ProductKey>
            <ProductSecret>U5tW7i44uilc****</ProductSecret>
            <NodeType>0</NodeType>
            <ProductName>Test</ProductName>
            <AliyunCommodityCode>iothub_senior</AliyunCommodityCode>
            <AuthType>secret</AuthType>
            <ResourceGroupId>rg-acfmxazb4ph****</ResourceGroupId>
      </Data>
      <ProductKey>a1FlqIQ****</ProductKey>
      <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
      <Success>true</Success>
</CreateProductResponse>JSON格式
{
  "Data": {
    "Description": "Product test",
    "DataFormat": 1,
    "ProtocolType": "modbus",
    "ProductKey": "a1FlqIQ****",
    "ProductSecret": "U5tW7i44uilc****",
    "NodeType": 0,
    "ProductName": "Test",
    "AliyunCommodityCode": "iothub_senior",
    "AuthType": "secret",
    "ResourceGroupId": "rg-acfmxazb4ph****"
  },
  "ProductKey": "a1FlqIQ****",
  "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
  "Success": true
}