调用RegisterDevice API注册设备-云市场-阿里云

RegisterDevice

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

接口说明

注册设备指在物联网平台产品下添加设备。在指定产品下成功注册设备后，物联网平台为设备颁发全局唯一的设备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个字符。

重要

‼️ 注意：调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数。

返回数据

名称	类型	示例值	描述
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：调用失败。

重要

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数。

示例

返回数据

名称	类型	示例值	描述
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：调用失败。

请求示例

curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=RegisterDevice&SignatureNonce=cf9296d6d10c4321b04e4892832a00c7&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T08%3A17%3A36Z&ProductKey=k1ymv1DuLfE&DeviceName=myTestDevice&Signature=tAQmvJO7ENOiN19F6uxytYCvRvQ%3D'

正常返回示例

{
    "Data": {
        "DeviceName": "myTestDevice",
        "DeviceSecret": "740a73fad9103a6856a94ed4cae7713b",
        "IotId": "ca460d99dfc7981f383f58yrcs",
        "ProductKey": "k1ymv1DuLfE"
        "Nickname": "detectors_in_beijing"
    },
    "RequestId": "7e97e0ce-ef74-42dc-bb67-b54feb0af493",
    "Code": "",
    "Success": true
}