错误码
4.3.4.1 注册设备(验证码方式)
典型场景
在设备接入物联网平台前,第三方应用需要调用此接口在物联网平台注册设备,并把 设备的唯一标识码(如IMEI)设置为设备接入平台的验证码。在设备接入物联网平台 时携带设备唯一标识,完成设备的接入认证。
接口功能
支持第三方应用在物联网平台注册设备,完成注册后设备方可接入物联网平台。
接口描述
def regDirectDevice(self, rddInDto, appId, accessToken)
接口所属类
DeviceManagement
参数说明
参数 必选/可
选
类型 位置 描述
rddInDto 必选 RegDirectD
eviceInDTO body 见下表RegDirectDeviceInDTO 的描述。
appId 可选 String query 如果是本应用的设备,此参数值 可以填写None,否则填写授权 应用的appId。
accessTok
en 必选 String header 填写鉴权接口获取的 accessToken。
RegDirectDeviceInDTO
参数 必选/可
选
类型 位置 描述
deviceInfo 可选
DeviceInfo
DTO
Body 设备信息。参数 必选/可 选
类型 位置 描述
endUserId 可选 String(256) Body 终端用户ID。
在NB-IoT方案中,endUserId设 置为设备的IMSI号。在
Smarthome解决方案中,
endUserId设置为App账号。
imsi 可选 String(1-64
) Body NB-IoT终端的IMSI。
isSecure 可选 Boolean Body 指定设备是否为安全设备,默认 值为“false”。
● “true”:安全设备
● “false”:非安全设备 说明
如果用户需要注册安全设备,
isSecure参数必须填写。
nodeId 必选 String(256) Body 设备的唯一标识,必须与设备上 报的设备标识一致。通常使用 MAC地址,Serial No或IMEI作 为nodeId。
说明使用IMEI作为nodeId时,根据不同 厂家的芯片有不同填写要求。
● 高通芯片设备的唯一标识为 urn:imei:xxxx,xxxx为IMEI号
● 海思芯片设备的唯一标识为IMEI 号
● 其他厂家芯片的设备唯一标识请 联系模组厂家确认。
psk 可选 String(8-32
) Body 请求中指定psk,则平台使用指
定的psk;请求中不指定psk,则 由平台生成psk。取值范围是
“a-f、A-F、0-9”组成的字符 串。
参数 必选/可 选
类型 位置 描述
timeout 可选 Integer(>=0
) Body 超时时间。当调用API接口对设
productId 可选 String(256) Body 设备所属的产品ID。
DeviceInfoDTO:
参数 必选/可
选
类型 位置 描述
manufact
urerId 可选 String(256
) Body 厂商ID,唯一标识一个厂商。
manufact urerNam e
可选 String(256
) Body 厂商名称。
deviceTy
pe 可选 String(256
) Body 设备类型,大驼峰命名方式,如
MultiSensor、ContactSensor、
CameraGateway。
model 必选 String(256
) Body 设备的型号。
Z-Wave:ProductType + ProductId,16 进制格式 XXXX-XXXX 补0对齐,如:001A-0A12,
其他协议的格式待定。
参数 必选/可 选
类型 位置 描述
protocolT
ype 可选 String(256
) Body 设备使用的协议类型,当前支持的
协议类型:CoAP,huaweiM2M,
Z-Wave,ONVIF,WPS,Hue,
WiFi,J808,Gateway,ZigBee,
LWM2M。
返回值
RegDirectDeviceOutDTO
参数 类型 描述
deviceId String(256) 设备ID,用于唯一标识一个设备。
verifyCode String(256) 验证码,设备可以通过验证码获取设备ID和密 码。若在请求中指定verifyCode,则响应中返 回请求中指定的verifyCode;若请求中不指定 verifyCode,则由物联网平台自动生成。
timeout Number 验证码有效时间,单位秒,设备需要在有效时 间内接入物联网平台。
psk String(32) 随机psk参数,若请求中携带了psk,则使用请 求中的psk,否则由平台生成随机psk参数。
错误码
Http状态 码
错误码 错误描述 说明
200 103028 The license
pool resources. License资源用尽。
400 100003 Invalid verify
code. 验证码无效。
处理建议:请检查接口请求中的 verifyCode是否有误。若请求参数中 未带verifyCode,请联系物联网平台 维护人员处理。
400 100007 Bad request
message. 参数不合法。
处理建议:deviceId未赋值,请参考 请求参数说明填写请求。
400 100416 The device has
already been 设备已经绑定。
处理建议:请检查设备是否已经注
Http状态 码
错误码 错误描述 说明
400 100426 The nodeId is
duplicated. nodeId重复。
处理建议:请检查接口请求中nodeId 是否有误。
400 50400 The input is
invalid. 输入参数无效。
处理建议:请检查接口调用请求中携 带参数的合法性。
401 100025 AppId for auth
not exist. 获取不到appId鉴权信息。
处理建议:
● 请检查请求结构体的Header头域 中是否给字段app_key赋值。
● 若通过HTTP调用,请联系物联网 平台维护人员确认Header头域中 放置appId的字段名是app_key还 是x-app-key。
403 100203 The
application is not existed.
应用不存在。
403 100217 The
application hasn't been authorized.
应用未被授权。
处理建议:若非应用授权场景,请确 认请求参数中的appId为空。
403 1010009 app throttle
exceed. 应用调用接口过于频繁,超过流控值
(默认值是100次/60s)。
处理建议:联系物联网平台维护人员 调大流控阈值或者控制接口的调用频 率。
403 1010005 Invalid access
token or appId. 错误的token信息。
处理建议:请检查接口请求中所携带 的accessToken是否有误。
403 600002 The product
not existed. 产品不存在。
处理建议:物联网平台未找到 productId对应的产品,请检查 productId是否有误。
500 100001 Internal server
error. 服务内部处理错误。
处理建议:物联网平台内部错误,请 联系物联网平台维护人员处理。
Http状态 码
错误码 错误描述 说明
500 100203 The
application is not existed.
授权应用不存在。
500 100412 The amount of device has reached the limit.
当前应用下设备数量达到上限。
处理建议:请检查当前应用下的设备 数量是否已达到所申请资源的上限。
500 100441 The amount of nonSecure device has reached the limit.
非安全设备数量已达到上限。
处理建议:
● 请注册安全设备(“isSecure”参 数设置为“true”),即设备使 用安全协议方式接入。
● 请联系物联网平台维护人员处 理。
500 103026 The license is
not exist. License不存在。
处理建议:物联网平台内部License 问题,请联系物联网平台维护人员处 理。
500 50252 Internal server
error. 服务器运行内部错误。