# RegisterDevice

调用该接口在指定产品下注册设备。

# 接口说明

注册设备指在物联网平台产品下添加设备。在指定产品下成功注册设备后，物联网平台为设备颁发全局唯一的设备ID（IotId），用来标识该设备。在进行与设备相关的操作时，您可能需要提供目标设备的IotId。

您也可以使用ProductKey和DeviceName组合来标识一个设备。其中ProductKey是新建产品时，物联网平台为产品颁发的ProductKey，DeviceName是注册设备时，由您指定或由系统随机生成的设备名称。IotId的优先级高于ProductKey和DeviceName组合。

# 请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	RegisterDevice	系统规定参数。取值：RegisterDevice。
ProductKey	String	是	a1BwAGV****	待注册设备所隶属的产品的ProductKey。ProductKey是物联网平台为新建产品颁发的产品Key，作为其全局唯一标识符。
IotInstanceId	String	是	70255861902711****	实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。
DeviceName	String	否	light	为待注册的设备命名。设备名称长度为4~32个字符，可以包含英文字母、数字和特殊字符：短划线（-）、下划线（_）、at（@）、半角句号（.）、半角冒号（:）。DeviceName通常与ProductKey组合使用，用作设备标识。说明如果不传入该参数，则由系统随机生成设备名称。
Nickname	String	否	园区灯	为待注册的设备设置备注名称。备注名称长度为2~64个字符，可包含中文汉字、英文字母、数字和下划线（_）。说明如果不传入该参数，系统不会为设备生成备注名称。

# 返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。
Data	Struct		调用成功时，返回注册的设备信息。
DeviceName	String	light	设备名称。注意请妥善保管，勿泄露。
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	设备密钥。注意请妥善保管，勿泄露。
IotId	String	70290207599388****	物联网平台为该设备颁发的设备ID，作为该设备的唯一标识符。注意请妥善保管，勿泄露。
Nickname	String	园区灯	设备的备注名称。若您没有为该设备设置备注名称，则该参数返回为空。
ProductKey	String	a1BwAGV****	设备所属产品的ProductKey。
ErrorMessage	String	系统异常	调用失败时，返回的错误信息。
RequestId	String	AmlS9XiJLrRrC7YtPNDWNODrb1t6xinc	物联网平台为该请求生成的唯一标识符。
Success	Boolean	true	表示是否调用成功。true：调用成功。false：调用失败。

# 示例

请求示例

http://open.${区域}.fenydata.com/fenydata-java-open/?Action=RegisterDevice
&ProductKey=a1rYuVF****
&IotInstanceId=70255861902711****
&DeviceName=device1
&Nickname=detectors_in_beijing
&<公共请求参数>

正常返回示例

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xml>
    <RequestId>AmlS9XiJLrRrC7YtPNDWNODrb1t6xinc</RequestId>
    <Success>true</Success>
    <Data>
        <DeviceName>device1</DeviceName>
        <ProductKey>a1rYuVF****</ProductKey>
        <DeviceSecret>tXHf4ezGEHcwdyMwoCDHGBmk9avi****</DeviceSecret>
        <IotId>70290207599388****</IotId>
        <Nickname>detectors_in_beijing</Nickname>
    </Data>
</xml>

JSON格式

{
  "RequestId": "AmlS9XiJLrRrC7YtPNDWNODrb1t6xinc",
  "Success": true,
  "Data": {
    "DeviceName": "device1",
    "ProductKey": "a1rYuVF****",
    "DeviceSecret": "tXHf4ezGEHcwdyMwoCDHGBmk9avi****",
    "IotId": "70290207599388****",
    "Nickname": "detectors_in_beijing"
  }
}