調用該接口在MQTT云網關產品下單個導入設備。

使用說明

調用該接口前，請先添加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. 設備名稱已經存在。

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