创建云端物联网设备
功能介绍
应用服务器可调用此接口创建云端物联网设备。
URI
POST /v1/iotfm/devices
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数说明:用户Token。通过调用 生成Token 接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 | 
| X-Instance-Id | 是 | String | 参数说明:实例ID。通过访问智能设施云平台界面后获取,智能设施云平台资源均为实例级隔离,所有业务接口必须填写正确的实例ID才能被成功调用。 取值范围:长度8-36,只允许大小写字母、数字和-字符的组合。 | 
| X-Root-Zone-Id | 否 | String | 参数说明:项目ID。 取值范围:长度不超过24,只允许字母、数字的组合。 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| device_name | 是 | String | 参数说明:设备名称。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-字符的组合。 | 
| device_description | 否 | String | 参数说明:设备描述。 取值范围:长度不超过256,只允许中文、字母、数字、以及_-字符的组合。 | 
| node_id | 是 | String | 参数说明:设备标识码,通常使用IMEI、MAC地址或SN号作为node_id。 取值范围:长度不超过64,只允许字母、数字、以及_-字符的组合。 | 
| zone_id | 否 | String | 参数说明:区域ID。 取值范围:长度不超过24,只允许字母、数字字符的组合。 | 
| zone_code | 否 | String | 参数说明:空间编码。 取值范围:长度为1-32,只允许大小写字母、数字、#、_、.和-的组合。 | 
| product_id | 是 | String | 参数说明:产品ID。 取值范围:长度不超过36,只允许字母、数字、以及_-字符的组合。 | 
| brand_id | 否 | String | 参数说明:品牌ID。 取值范围:长度不超过36,只允许字母、数字、以及_-字符的组合。 | 
| device_id | 否 | String | 参数说明:设备ID。 取值范围:长度不超过128,只允许字母、数字、以及_-字符的组合。 | 
| parent_device_id | 否 | String | 参数说明:父设备ID。 取值范围:用于标识设备所属的父设备,即父设备的设备ID。 | 
| manufacturer_info | 否 | ManufacturerInfo object | 厂商信息。 | 
| extension_info | 否 | Map<String,String> | 参数说明:设备扩展信息。最多填写10个扩展字段。 取值范围: 总大小不能超过1KB。 key取值长度不超过36,只允许字母、数字、以及_-字符的组合。 value取值长度不超过256,只允许中文、字母、数字、点号、以及_-字符的组合。 | 
| spec_properties | 否 | Array of SpecProperty objects | 参数说明:设备规格属性列表。 取值范围:数组长度不超过100。 | 
| device_report_period | 否 | Integer | 参数说明:设备上报周期。 取值范围:只允许数字,单位:秒,范围:5-86400(24小时)。 | 
| access_info | 否 | AccessInfo object | 参数说明:设备的接入认证信息。 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| manufacturer_name | 否 | String | 参数说明:设备厂商。 取值范围:长度不超过32,只允许中文、字母、数字、以及_?'#().,&%@!-字符的组合。 | 
| manufacturer_code | 否 | String | 参数说明:设备厂商编码。 取值范围:长度不超过32,只允许字母、数字、以及_-字符的组合。 | 
| model | 否 | String | 参数说明:设备型号。 取值范围:长度不超过32,只允许中文、字母、数字、以及_?'#().,&%@!-字符的组合。 | 
响应参数
状态码:201
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| device_name | String | 参数说明:设备名称。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-字符的组合。 | 
| device_description | String | 参数说明:设备描述。 取值范围:长度不超过256,只允许中文、字母、数字、以及_-字符的组合。 | 
| node_id | String | 参数说明:设备标识码,通常使用IMEI、MAC地址或SN号作为node_id。 取值范围:长度不超过64,只允许字母、数字、以及_-字符的组合。 | 
| zone_id | String | 参数说明:区域ID。 取值范围:长度不超过24,只允许字母、数字字符的组合。 | 
| zone_code | String | 参数说明:空间编码。 取值范围:长度为1-32,只允许大小写字母、数字、#、_、.和-的组合。 | 
| product_id | String | 参数说明:产品ID。 取值范围:长度不超过36,只允许字母、数字、以及_-字符的组合。 | 
| brand_id | String | 参数说明:品牌ID。 取值范围:长度不超过36,只允许字母、数字、以及_-字符的组合。 | 
| device_id | String | 参数说明:设备ID。 取值范围:长度不超过128,只允许字母、数字、以及_-字符的组合。 | 
| parent_device_id | String | 参数说明:父设备ID。用于标识设备所属的父设备,即父设备的设备ID。 取值范围:长度不超过128,只允许字母、数字、以及_-字符的组合。 | 
| manufacturer_info | ManufacturerInfo object | 参数说明:厂商信息。 | 
| extension_info | Map<String,String> | 参数说明:设备扩展信息。最多填写10个扩展字段。 取值范围: 总大小不能超过1KB。 key取值长度不超过36,只允许字母、数字、以及_-字符的组合。 value取值长度不超过256,只允许中文、字母、数字、点号、以及_-字符的组合。 | 
| device_type | String | 参数说明:设备类型。 取值范围:VIDEO-摄像头类 SCREEN-智慧屏类 IOTDA-云端物联网类 IOTEDGE-边侧物联网类。 | 
| device_sub_type | String | 参数说明:设备子类型。 取值范围:仅当device_type为IOTEDGE时填写,GATEWAY表示网关类型,ELEC表示机电设备,HlinkG表示HlinkG设备,CONTROLLER表示控制器设备。 | 
| create_time | String | 参数说明:创建时间。 取值范围:"yyyy-MM-dd'T'HH:mm:ss.SSS'Z"。 | 
| spec_properties | Array of SpecProperty objects | 参数说明:设备规格属性列表。 取值范围:数组长度不超过100。 | 
| device_report_period | Integer | 参数说明:设备上报周期。 取值范围:只允许数字,单位:秒,范围:5-86400(24小时)。 | 
| access_info | AccessInfo object | 参数说明:设备的接入认证信息。 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| manufacturer_name | String | 参数说明:设备厂商。 取值范围:长度不超过32,只允许中文、字母、数字、以及_?'#().,&%@!-字符的组合。 | 
| manufacturer_code | String | 参数说明:设备厂商编码。 取值范围:长度不超过32,只允许字母、数字、以及_-字符的组合。 | 
| model | String | 参数说明:设备型号。 取值范围:长度不超过32,只允许中文、字母、数字、以及_?'#().,&%@!-字符的组合。 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| property_code | String | 参数说明:属性编码。 取值范围:长度不超过40,只允许英文字母大小写、数字、下划线的组合。 | 
| property_value | Object | 参数说明:属性值。 | 
状态码:400
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| error_code | String | 参数说明:错误码。 取值范围:长度8-36。 | 
| error_msg | String | 参数说明:错误描述。 取值范围:长度2-512。 | 
请求示例
创建设备
POST https://{endpoint}/v1/iotfm/devices
{
  "device_name" : "冷却机三号设备",
  "node_id" : "12345678900",
  "product_id" : "18c8a641b1f0c7182d25b8d8",
  "brand_id" : "18c8a641b1f0c7182d25b668",
  "zone_id" : "18c32987ffaa30cd3c21f388",
  "device_description" : "冷却机三号设备"
}
 响应示例
状态码:201
Created
{
  "device_id" : "18c8f85cd2a962d54cc6aba5",
  "device_name" : "冷却机三号设备",
  "device_description" : "冷却机三号设备",
  "device_type" : "IOTDA",
  "extension_info" : { },
  "node_id" : "12345678900",
  "product_id" : "18c8a641b1f0c7182d25b8d8",
  "brand_id" : "18c8a641b1f0c7182d25b668",
  "zone_id" : "18c32987ffaa30cd3c21f388",
  "spec_properties" : [ ],
  "create_time" : "2023-12-22T03:16:00.081Z",
  "access_info" : {
    "secret" : "c45a037da9310aaf4f283059fb2b901b"
  }
}
 状态码
| 状态码 | 描述 | 
|---|---|
| 201 | Created | 
| 400 | Bad Request | 
 
  