IOT边缘 IOTEDGE-添加设备:请求参数
下载IOT边缘 IOTEDGE用户手册完整版
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
node_id |
是 |
String |
设备标识码，通常使用IMEI、MAC地址或Serial No作为node_id。（注意:NB设备由于模组烧录信息后无法配置，所以NB设备会校验node_id全局唯一。） 最小长度：1 最大长度：64 |
device_name |
否 |
String |
设备名称。 最小长度：1 最大长度：256 |
product_id |
是 |
String |
设备关联的产品ID，用于唯一标识一个产品模型，在管理门户导入产品模型后由平台分配获得。 |
auth_info |
否 |
EdgeDeviceAuthInfo object |
设备的接入认证信息。 |
description |
否 |
String |
设备的描述信息。 最大长度：2048 |
gateway_id |
否 |
String |
父设备ID，用于标识设备所属的父设备。携带该参数时，表示在该父设备下创建一个子设备，这个子设备不与平台直连，此时必须保证这个父设备在平台已存在，创建成功后子设备的gateway_id等于该参数值；不携带该参数时，表示创建一个和平台直连的设备，创建成功后设备的device_id和gateway_id一致。 |
space_id |
否 |
String |
资源空间Id。此参数为非必选参数，用于兼容平台老用户存在多应用的场景。存在多应用的用户需要使用该接口时，必须携带该参数指定注册的设备归属到哪个应用下，否则接口会提示错误。如果用户存在多应用，同时又不想携带该参数，可以联系华为技术支持对用户数据做应用合并。 |
extension_info |
否 |
Object |
设备扩展信息。用户可以自定义任何想要的扩展信息，如果在创建设备时为子设备指定该字段，将会通过MQTT接口“平台通知网关子设备新增“将该信息通知给网关。字段值大小上限为1K。 |
config |
否 |
Object |
设备初始配置。用户使用该字段可以为设备指定初始配置，指定后将会根据service_id和desired设置的属性值与产品中对应属性的默认值比对，如果不同，则将以设置的属性值为准写入到设备配置中。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
auth_type |
否 |
String |
鉴权类型。支持密钥认证接入(SECRET)和证书认证接入(CERTIFICATES)两种方式。使用密钥认证接入方式(SECRET)填写secret字段，使用证书认证接入方式(CERTIFICATES)填写fingerprint字段，不填写auth_type默认为密钥认证接入方式(SECRET) |
secret |
否 |
String |
设备密钥，认证类型使用密钥认证接入(SECRET)可填写该字段。注意：NB设备密钥由于协议特殊性，只支持十六进制密钥接入；修改设备、查询设备及查询设备列表接口不返回该参数。 最小长度：8 最大长度：32 |
fingerprint |
否 |
String |
证书指纹，认证类型使用证书认证接入(CERTIFICATES)可填写该字段，注册设备时不填写该字段则取第一次设备接入时的证书指纹。注意：指纹只能为40位十六进制字符串或者64位十六进制字符串；修改设备、查询设备及查询设备列表接口不返回该参数。 |
secure_access |
否 |
Boolean |
指设备是否通过安全协议方式接入，默认值为true。
缺省值：true |
timeout |
否 |
Integer |
设备验证码的有效时间，单位：秒，默认值：0 若设备在有效时间内未接入 物联网平台 并激活，则平台会删除该设备的注册信息。若设置为“0”，则表示设备验证码不会失效（建议填写为“0”）。注意：只有注册设备接口或者修改设备接口修改timeout时返回该参数。 最小值：0 最大值：2147483647 缺省值：0 |
