调用该接口在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. 设备名称已经存在。

访问错误中心查看更多错误码。