調用該接口創建產品。
使用說明
- 若產品需要使用物模型功能,必選傳入請求參數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 | 是否使用ID2認證。可選值:
不傳入此參數,則默認為false,不開通ID2認證。 說明 僅華東2(上海)地域支持ID2認證方式。如果此參數值設置為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 | 是否使用ID2認證。
|
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
}