RegisterDevice

更新时间：2025-09-19 00:28:44LLM 副本以 Markdown 格式查看

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

接口说明

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

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

请求参数

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

返回数据

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

示例

请求示例

https://iot.****.tuya.com.com/?Action=RegisterDevice
&ProductKey=a1rYuVF****
&DeviceName=device1
&Nickname=detectors_in_beijing
&<公共请求参数>

正常返回示例

JSON格式

{
    "RequestId": "57b144cf-09fc-4916-a272-a62902d5b207", 
    "Success": true, 
    "Data": {
        "DeviceName": "device1", 
        "ProductKey": "a1rYuVF****", 
        "DeviceSecret": "tXHf4ezGEHcwdyMwoCDHGBmk9avi****", 
        "IotId": "CqXL5h5ysRTA4NxjABjj0010fa****", 
        "Nickname": "detectors_in_beijing"
    }
}

上一篇设备管理

下一篇BatchRegisterDevice