ImportDevice - IoT Platform

使用說明

調用該介面前，請先添加MQTT雲網關並成功建立雲網關產品，擷取產品的Productkey。具體操作，請參見建立雲網關產品（MQTT）。

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ImportDevice	系統規定參數。取值：ImportDevice。
ProductKey	String	是	a1BwAGV****	裝置所屬雲網關產品的ProductKey。
DeviceName	String	是	light	裝置的名稱。裝置名稱支援英文字母、數字、短劃線（-）、底線（_）、at（@）、英文句號（.）和英文冒號（:），長度限制為4~32個字元。裝置名稱在產品維度下不可重複。
DeviceSecret	String	是	b4d43f7******10ba5e5	裝置的密鑰。裝置密鑰支援英文字母、數字、短劃線（-）、底線（_）、at（@）、英文句號（.）和英文冒號（:），長度限制為1~32個字元。
Nickname	String	否	園區燈	裝置的備忘名稱。備忘名稱支援英文字母、數字和底線（_），長度限制為1~64個字元。說明如果不傳入該參數，系統不會為裝置產生備忘名稱。
Sn	String	否	QC4******001	裝置的序號。序號支援英文字母、數字和底線（_），長度限制為1~64個字元。說明如果不傳入該參數，系統不會為裝置產生序號。
IotInstanceId	String	否	iot-1n8t****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回匯入的裝置資訊。
DeviceName	String	light	裝置名稱。重要請妥善保管，勿泄露。
DeviceSecret	String	b4d43f7******10ba5e5	裝置密鑰。重要請妥善保管，勿泄露。
IotId	String	1O4YPNtRqB2anumz2Canp4GB7*****	物聯網平台為該裝置頒發的裝置ID，作為該裝置的唯一識別碼。重要請妥善保管，勿泄露。
Nickname	String	園區燈	裝置的備忘名稱。說明若您沒有為該裝置傳入備忘名稱，則該參數返回為空白。
ProductKey	String	a1BwAGV****	裝置所屬產品的ProductKey。
Sn	String	QC4******001	裝置序號。說明若您沒有為裝置傳入序號，則該參數返回為空白。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ImportDevice
&DeviceName=device1
&DeviceSecret=b4d43f7******10ba5e5
&ProductKey=a1BwAGV****
&IotInstanceId=iot-1n8t****
&<公用請求參數>

正常返回樣本

XML格式

<ImportDeviceResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Data>
        <IotId>1O4YPNtRqB2anumz2Canp4GB7*****</IotId>
        <DeviceSecret>b4d43f7******10ba5e5</DeviceSecret>
        <Sn>QC4******001</Sn>
        <ProductKey>a1BwAGV****</ProductKey>
        <Nickname>園區燈</Nickname>
        <DeviceName>light</DeviceName>
  </Data>
  <Success>true</Success>
</ImportDeviceResponse>

JSON格式

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Data": {
        "IotId": "1O4YPNtRqB2anumz2Canp4GB7*****",
        "DeviceSecret": "b4d43f7******10ba5e5",
        "Sn": "QC4******001",
        "ProductKey": "a1BwAGV****",
        "Nickname": "園區燈",
        "DeviceName": "light"
    },
    "Success": true
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
200	iot.device.CreateDeviceFailed	An error occurred while creating the device.	建立裝置失敗。
200	iot.device.AlreadyExistedDeviceName	The DeviceName already exists.	裝置名稱已經存在。

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