创建设备

最近更新时间:2019-07-24 15:21:27

1. 接口描述

接口请求域名: iotcloud.tencentcloudapi.com 。

本接口(CreateDevice)用于新建一个物联网通信设备。

默认接口请求频率限制:100次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateDevice
Version String 公共参数,本接口取值:2018-06-14
Region String 公共参数,本接口不需要传递此参数。
ProductId String 产品 ID 。创建产品时腾讯云为用户分配全局唯一的 ID
DeviceName String 设备名称。命名规则:[a-zA-Z0-9:_-]{1,48}。
Attribute Attribute 设备属性
DefinedPsk String 是否使用自定义PSK,默认不使用
Isp Integer 运营商类型,当产品是NB-IoT产品时,此字段必填。1表示中国电信,2表示中国移动,3表示中国联通
Imei String IMEI,当产品是NB-IoT产品时,此字段必填
LoraDevEui String LoRa设备的DevEui,当创建LoRa时,此字段必填
LoraMoteType Integer LoRa设备的MoteType
Skey String 创建LoRa设备需要skey
LoraAppKey String LoRa设备的AppKey

3. 输出参数

参数名称 类型 描述
DeviceName String 设备名称
DevicePsk String 对称加密密钥,base64编码。采用对称加密时返回该参数
DeviceCert String 设备证书,用于 TLS 建立链接时校验客户端身份。采用非对称加密时返回该参数
DevicePrivateKey String 设备私钥,用于 TLS 建立链接时校验客户端身份,腾讯云后台不保存,请妥善保管。采用非对称加密时返回该参数
LoraDevEui String LoRa设备的DevEui,当设备是LoRa设备时,会返回该字段
LoraMoteType Integer LoRa设备的MoteType,当设备是LoRa设备时,会返回该字段
LoraAppKey String LoRa设备的AppKey,当设备是LoRa设备时,会返回该字段
LoraNwkKey String LoRa设备的NwkKey,当设备是LoRa设备时,会返回该字段
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建设备(采用非对称加密)

输入示例

https://iotcloud.tencentcloudapi.com/?Action=CreateDevice
&ProductId=ABCDE12345
&DeviceName=test_device
&Attribute.Tags.0.Tag=note
&Attribute.Tags.0.Type=2
&Attribute.Tags.0.Value=test_note
&<公共请求参数>

输出示例

{
  "Response": {
    "DeviceName": "test_device",
    "DevicePsk": "",
    "DeviceCert": "xxxxxxxxxxxxxxxxxxxx",
    "DevicePrivateKey": "xxxxxxxxxxxxxxxxxxxxxxx",
    "LoraDevEui": "",
    "LoraMoteType": "",
    "RequestId": "54f75f05-a87c-45fc-9520-6b59e251e91c"
  }
}

示例2 创建设备(采用对称加密)

输入示例

https://iotcloud.tencentcloudapi.com/?Action=CreateDevice
&ProductId=ABCDE12345
&DeviceName=test_device
&Attribute.Tags.0.Tag=note
&Attribute.Tags.0.Type=2
&Attribute.Tags.0.Value=test_note
&<公共请求参数>

输出示例

{
  "Response": {
    "DeviceName": "test_device",
    "DevicePsk": "xxxxxxxxxxxxx",
    "DeviceCert": "",
    "DevicePrivateKey": "",
    "LoraDevEui": "",
    "LoraMoteType": "",
    "RequestId": "54f75f05-a87c-45fc-9520-6b59e251e91c"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误
InvalidParameterValue 参数取值错误
InvalidParameterValue.DeviceAlreadyExist 创建的设备名已存在。
LimitExceeded.DeviceExceedLimit 设备数量超过限制。
ResourceNotFound.ProductNotExist 产品不存在。
UnauthorizedOperation.ProductCantHaveLoRaDevice 该产品类型不能创建LoRa设备。
UnauthorizedOperation.ProductCantHaveNotLoRaDevice 该产品类型只能创建LoRa设备。
UnauthorizedOperation.ProductNotSupportPSK 产品不支持密钥认证。
UnsupportedOperation.SuiteTokenNoCreate 产品为Suite token类型,无法创建新设备。