方舟物联网使用手册

# CreateProduct

调用该接口创建产品。

# 使用说明

  • 在实例下创建一个产品。

# 请求参数

参数名称 类型 是否必选 示例值 描述
Action String 是 CreateProduct 系统规定参数。取值：CreateProduct。
NodeType Integer 是 0 产品的节点类型，取值：
0：设备，可以直连物联网平台。
ProductName String 是 Light 为新建产品命名。
产品名称长度为4~30个字符，可以包含中文、英文字母、数字和下划线（_）。一个中文算2个字符。
IotInstanceId String 是 6912917943269**** 实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。
DataFormat Integer 否 1 数据格式。可选值：
1：Alink协议（ALINK_FORMAT）。
2：透传/自定义格式（CUSTOM_FORMAT）。
Description String 否 Product test 为新建产品添加描述信息。长度不超过100个字符。
AuthType String 否 secret 产品下的设备接入物联网平台的认证方式。
secret：
若不传入此参数，默认值为secret。
ValidateType Integer 否 1 数据校验级别。不传入此参数时，默认为弱校验。可取值：
1：弱校验。只校验设备数据的idetifier和dataType字段，不校验其他字段，可流转全量数据。
校验通过的数据展示在物联网平台控制台对应设备的设备详情页物模型数据页签。校验不通过的数据则不展示。
通过流转数据中的参数checkFailedData，可查看校验不通过的数据。更多信息，请参见数据格式。
2：免校验。对上报的数据不进行校验，流转全量数据。
数据不展示在物联网平台控制台对应设备的设备详情页物模型数据页签。

# 返回数据

名称 类型 示例值 描述
Code String 200 调用失败时，返回的错误码。
Data Struct 调用成功时，返回的新建产品信息。
AuthType String secret 产品下的设备接入物联网平台的认证方式。
secret：使用设备密钥进行设备身份认证。
DataFormat Integer 1 产品类型数据格式。
1：Alink协议（ALINK_FORMAT）。
2：透传/自定义格式（CUSTOM_FORMAT）。
Description String Product test 产品描述信息。
NodeType Integer 0 产品的节点类型，取值：
0：设备，可以直连物联网平台。
ProductKey String a1FlqIQ**** 物联网平台为新建产品颁发的全局唯一标识。
说明
请妥善保管新建产品的ProductKey。在其他操作中会用到该信息。
ProductName String Test 产品的名称。
ProductSecret String U5tW7i44uilc**** 产品密钥。
ErrorMessage String 系统异常 调用失败时，返回的出错信息。
ProductKey String a1FlqIQ**** 产品的ProductKey，物联网平台为产品颁发的唯一标识符。
RequestId String OhnyBeVnLzqs4wpM3Y9IicbXysrqrG4T 平台为该请求生成的唯一标识符。
Success Boolean true 是否调用成功。
true：调用成功。
false：调用失败。

# 示例

请求示例

http://open.${区域}.fenydata.com/fenydata-java-open/?Action=CreateProduct
&NodeType=0
&ProductName=Test
&IotInstanceId=70255861902711****
&DataFormat=1
&AuthType=secret
&Description=Product test
&ValidateType=1
&<公共请求参数>

正常返回示例

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xml>
    <Data>
        <AuthType>secret</AuthType>
        <DataFormat>1</DataFormat>
        <Description>Product test</Description>
        <NodeType>0</NodeType>
        <ProductKey>a1FlqIQ****</ProductKey>
        <ProductName>Test</ProductName>
        <ProductSecret>U5tW7i44uilc****</ProductSecret>
    </Data>
    <ProductKey>a1FlqIQ****</ProductKey>
    <RequestId>OhnyBeVnLzqs4wpM3Y9IicbXysrqrG4T</RequestId>
    <Success>true</Success>
</xml>

JSON格式

{
  "Data": {
    "AuthType": "secret",
    "DataFormat": 1,
    "Description": "Product test",
    "NodeType": 0,
    "ProductKey": "a1FlqIQ****",
    "ProductName": "Test",
    "ProductSecret": "U5tW7i44uilc****"
  },
  "ProductKey": "a1FlqIQ****",
  "RequestId": "OhnyBeVnLzqs4wpM3Y9IicbXysrqrG4T",
  "Success": true
}

← 删除产品 →