RegisterDevice - IoT Platform

介面說明

註冊裝置指在物聯網平台產品下添加裝置。在指定產品下成功註冊裝置後，阿里雲物聯網平台為裝置頒發全域唯一的裝置ID（IotId），用來標識該裝置。在進行與裝置相關的操作時，您可能需要提供目標裝置的IotId。

您也可以使用ProductKey和DeviceName組合來標識一個裝置。其中ProductKey是建立產品時，物聯網平台為產品頒發的ProductKey，DeviceName是註冊裝置時，由您指定或由系統隨機產生的裝置名稱。IotId的優先順序高於ProductKey和DeviceName組合。

如需在同一產品下，大量註冊多個裝置，請參見BatchRegisterDeviceWithApplyId介面的使用說明。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為30。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	RegisterDevice	系統規定參數。取值：RegisterDevice。
ProductKey	String	是	a1BwAGV****	待註冊裝置所隸屬的產品的ProductKey。ProductKey是物聯網平台為建立產品頒發的產品Key，作為其通用唯一識別碼。您可以在物聯網平台控制台查看或調用QueryProductList查看當前帳號下所有產品的資訊。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
DeviceName	String	否	light	為待註冊的裝置命名。裝置名稱長度為4~32個字元，可以包含英文字母、數字和特殊字元：短劃線（-）、底線（_）、at（@）、半形句號（.）、半形冒號（:）。 DeviceName通常與ProductKey組合使用，用作裝置標識。說明如果不傳入該參數，則由系統隨機產生裝置名稱。
DevEui	String	否	e8SDdgeIlk3nED****	LoRaWAN裝置的DevEUI。建立LoRaWAN裝置時，該參數必傳。
Nickname	String	否	園區燈	為待註冊的裝置設定備忘名稱。備忘名稱長度為4~64個字元，可包含中文漢字、英文字母、數字和底線（_）。一個中文漢字算2個字元。說明如果不傳入該參數，系統不會為裝置產生備忘名稱。
PinCode	String	否	DIe80dfeg*****	LoRaWAN裝置的PIN Code，用於校正DevEUI的合法性。建立LoRaWAN裝置時，LoraNodeType為ALIYUNDEFINED，該參數必傳。
JoinEui	String	否	Ede4tde8erth****	LoRaWAN裝置的入網憑證JoinEui。建立LoRaWAN裝置時，LoraNodeType為USERDEFINED，該參數必傳。
AppKey	String	否	674f***	LoRaWAN裝置的AppKey。建立LoRaWAN裝置時，LoraNodeType為USERDEFINED，該參數必傳。
LoraNodeType	String	否	ALIYUNDEFINED	LoRaWAN裝置類型。可取值： ALIYUNDEFINED：阿里雲頒發類型，需同時傳入DevEui和PinCode。 USERDEFINED：使用者自訂類型，需同時傳入DevEui、JoinEui和AppKey。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回註冊的裝置資訊。
DevEui	String	e8SDdgeIlk3nED****	LoRaWAN裝置的DevEUI。僅LoRaWAN裝置才會返回該參數。
DeviceName	String	light	裝置名稱。重要請妥善保管，勿泄露。
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	裝置密鑰。重要請妥善保管，勿泄露。
IotId	String	1O4YPNtRqB2anumz2Canp4GB7q****	物聯網平台為該裝置頒發的裝置ID，作為該裝置的唯一識別碼。重要請妥善保管，勿泄露。
JoinEui	String	Ede4tde8erth****	LoRaWAN裝置的入網憑證 JoinEUI。僅LoRaWAN裝置才會返回該參數。
Nickname	String	園區燈	裝置的備忘名稱。若您沒有為該裝置設定備忘名稱，則該參數返回為空白。
ProductKey	String	a1BwAGV****	裝置所屬產品的ProductKey。
ErrorMessage	String	系統異常	調用失敗時，返回的錯誤資訊。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=RegisterDevice
&ProductKey=a1rYuVF****
&DeviceName=device1
&Nickname=detectors_in_beijing
&<公用請求參數>

正常返回樣本

XML格式

<RegisterDeviceResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
  <Data>
        <DeviceName>device1</DeviceName>
        <ProductKey>a1rYuVF****</ProductKey>
        <DeviceSecret>tXHf4ezGEHcwdyMwoCDHGBmk9avi****</DeviceSecret>
        <IotId>CqXL5h5ysRTA4NxjABjj0010fa****</IotId>
        <Nickname>detectors_in_beijing</Nickname>
  </Data>
</RegisterDeviceResponse>

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。