获取创建多设备结果

最近更新时间:2019-04-30 15:22:24

1. 接口描述

本接口(GetMultiDevices)用于查询批量创建设备的执行结果。

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

2. 输入参数

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

参数名称 必选 类型 描述
productID String 产品 ID,创建产品时腾讯云为用户分配全局唯一的 ID
taskID String 任务 ID,由批量创建设备接口返回
pageNum Int 分页页数
pageSize Int 分页大小,每页返回设备个数

3. 输出参数

参数名称 类型 描述
code Int 公共错误码。0 表示成功,其他值表示失败,详见 公共错误码 页面
message String 模块错误信息描述,格式为 "(模块错误码)模块错误信息" ,详见本页面的 模块错误码
codeDesc String 模块错误码的英文描述
totalDevNum Int 此任务要创建的总设备个数
listCreateDeviceInfo Array of Object 设备详细信息

其中listCreateDeviceInfo的定义如下:

参数名称 类型 描述
deviceName String 设备名称
deviceCert String 设备证书,采用非对称加密时返回该参数
devicePrivateKey String 设备私钥,采用非对称加密时返回该参数,腾讯云为用户缓存起来,其生命周期与任务生命周期一致
devicePsk String 对称加密密钥,base64 编码,采用对称加密时返回该参数
result Int 执行结果,参考 CreateDevice 接口的返回码定义
errMsg String 错误信息

4. 示例

输入

  https://iotcloud.qcloud.com/v2/index.php?Action=GetMultiDevices
  &productID=ABCED12345&taskID=abcdedf123456789&pageNum=1&pageSize=10
  &<公共请求参数>

输出

(1)采用非对称加密:

{       
    "message": "",
    "codeDesc": "Success",
    "code": 0,
    "taskID":"abcdedf123456789",
    "totalDevNum":2,
    "listCreateDeviceInfo":[
      {
        "deviceName":"test_device1",
        "deviceCert":"-----BEGIN CERTIFICATE-----\n-----END CERTIFICATE-----",
        "devicePrivateKey":"-----BEGIN PRIVATE KEY-----\n-----END PRIVATE KEY-----\n",
        "result":0
      },
      {
        "deviceName":"test_device2",
        "result":2001
      }
    ]
}

(2)采用对称加密:

{       
    "message": "",
    "codeDesc": "Success",
    "code": 0,
    "taskID":"abcdedf123456789",
    "totalDevNum":2,
    "listCreateDeviceInfo":[
      {
        "deviceName":"test_device1",
        "devicePsk": "s/GiL8XZ7f/bWvQIuKjMoQ==",
        "result":0
      },
      {
        "deviceName":"test_device2",
        "result":2001
      }
    ]
}

5. 模块错误码

模块错误码 描述
2000 设备数量超过限制
2001 创建的设备名已存在
2006 任务不存在
2012 用户或产品不匹配任务ID
2100 内部服务器错误,请联系技术人员
2101 请求参数非法