更新时间:2022-05-05 GMT+08:00
分享

添加设备

功能介绍

添加设备

调试

您可以在API Explorer中调试该接口。

URI

POST /v2/{project_id}/edge-nodes/{edge_node_id}/devices

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见 获取项目ID

最小长度:1

最大长度:64

edge_node_id

String

边缘节点ID

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

最小长度:0

最大长度:20000

表3 请求Body参数

参数

是否必选

参数类型

描述

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,用于标识设备所属的父设备。创建网关直连设备时,不携带该参数;在网关直连设备下创建子设备时,携带该参数,参数值为父设备ID。

space_id

String

资源空间Id。此参数为非必选参数,用于兼容平台老用户存在多应用的场景。存在多应用的用户需要使用该接口时,必须携带该参数指定注册的设备归属到哪个应用下,否则接口会提示错误。如果用户存在多应用,同时又不想携带该参数,可以联系华为技术支持对用户数据做应用合并。

extension_info

Object

设备扩展信息。用户可以自定义任何想要的扩展信息,如果在创建设备时为子设备指定该字段,将会通过MQTT接口“平台通知网关子设备新增“将该信息通知给网关。字段值大小上限为1K。 追加:如果通过EdgeHub, EdgeAccess进行设备接入,不需要携带extension_info;如果通过用户自定义的应用进行边缘设备接入,则携带模块id参数作为extension_info, 例如:{"module_id":"user_xxx"}

config

Object

设备初始配置。用户使用该字段可以为设备指定初始配置,指定后将会根据service_id和desired设置的属性值与产品中对应属性的默认值比对,如果不同,则将以设置的属性值为准写入到设备配置中。 例如连接MQTT设备,配置接入平台密码,携带该参数{"password":"xxxxxxxx"}

表4 EdgeDeviceAuthInfo

参数

是否必选

参数类型

描述

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:通过安全协议方式接入。

  • false:通过非安全协议方式接入。

缺省值:true

timeout

Integer

设备验证码的有效时间,单位:秒,默认值:0 若设备在有效时间内未接入物联网平台并激活,则平台会删除该设备的注册信息。若设置为“0”,则表示设备验证码不会失效(建议填写为“0”)。注意:只有注册设备接口或者修改设备接口修改timeout时返回该参数。

最小值:0

最大值:2147483647

缺省值:0

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

device_id

String

设备ID

最小长度:1

最大长度:256

password

String

设备密钥,认证类型使用密钥认证接入(SECRET)可填写该字段。注意:NB设备密钥由于协议特殊性,只支持十六进制密钥接入;修改设备、查询设备及查询设备列表接口不返回该参数。

最小长度:1

最大长度:256

请求示例

POST https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/devices

响应示例

状态码

状态码

描述

200

OK

401

Bad Request

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

close