创建设备

最近更新时间:2019-04-30 15:13:46

1. 接口描述

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

接口请求域名:iotcloud.api.qcloud.com

  • 同一开发商账户下设备名称需保持唯一
  • 创建设备时,需要指定产品,这样便于管理
  • 设备创建后,会自动创建关联的证书,同时和产品默认的权限进行绑定
  • 普通类型产品下只能创建普通设备,NB-IoT类型产品下只能创建NB-IoT设备。

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

参数名称 必选 类型 描述
deviceName String 设备名称。命名规则:[a-zA-Z0-9:_-]{1,48}。
productID String 产品 ID 。创建产品时腾讯云为用户分配全局唯一的 ID
definedPsk String 用户自定义的对称加密密钥,base64编码。4-64个字符
isp Int 运营商类型,1为电信,2为移动,3为联通。目前支持电信设备。非NB-IoT产品时此字段无效,NB-IoT产品时此字段必填
imei String NB-IoT设备的IMEI( 国际移动设备识别码 )。非NB-IoT产品时此字段无效,NB-IoT产品时此字段必填

3. 输出参数

参数名称 类型 描述
code Int 公共错误码。0 表示成功,其他值表示失败,详见 公共错误码 页面
message String 模块错误信息描述,格式为 "(模块错误码)模块错误信息" ,详见本页面的 模块错误码
codeDesc String 模块错误码的英文描述
deviceName String 设备名称
deviceCert String 设备证书,用于 TLS 建立链接时校验客户端身份。采用非对称加密时返回该参数
devicePrivateKey String 设备私钥,用于 TLS 建立链接时校验客户端身份,腾讯云后台不保存,请妥善保管。采用非对称加密时返回该参数
devicePsk String 对称加密密钥,base64编码。采用对称加密时返回该参数

4. 示例

输入

  https://iotcloud.api.qcloud.com/v2/index.php?Action=CreateDevice
  &deviceName=apple
  &productID=ABCDE12345
  &<公共请求参数>

输出

(1)采用非对称加密:

{
    "deviceName": "apple",
    "deviceCert":"{publickey}",
    "devicePrivateKey":"{privatekey}",
    "message": "",
    "codeDesc": "Success",
    "code": 0
}

(2)采用对称加密:

{
    "deviceName": "apple",
    "devicePsk": "s/GiL8XZ7f/bWvQIuKjMoQ==",
    "message": "",
    "codeDesc": "Success",
    "code": 0
}

5. 模块错误码

模块错误码 描述
2000 设备数量超过限制
2001 创建的设备名已存在
2008 产品不存在,请检查ProductID
2100 内部服务器错误,请联系技术人员
2101 请求参数非法