获取创建多设备结果

最近更新时间:2019-05-09 19:52:54

1. 接口描述

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMultiDevices
Version String 公共参数,本接口取值:2018-06-14
Region String 公共参数,本接口不需要传递此参数。
ProductId String 产品 ID,创建产品时腾讯云为用户分配全局唯一的 ID
TaskId String 任务 ID,由批量创建设备接口返回
Offset Integer 分页偏移
Limit Integer 分页大小,每页返回的设备个数

3. 输出参数

参数名称 类型 描述
TaskId String 任务 ID,由批量创建设备接口返回
DevicesInfo Array of MultiDevicesInfo 设备详细信息列表
TotalDevNum Integer 该任务创建设备的总数
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取创建多设备结果

输入示例

https://iotcloud.tencentcloudapi.com/?Action=DescribeMultiDevices
&ProductId=ABCDE12345
&TaskId=abcdefghijklmn
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
  "Response": {
    "TaskId": "abcdedf123456789",
    "TotalDevNum": 2,
    "DevicesInfo": [
      {
        "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
      }
    ],
    "RequestId": "xxxxxxxxxxxxxxxxxxxxxxx"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.TaskIDNotMatch 用户或产品不匹配任务ID。
InternalError 内部错误
InvalidParameterValue 参数取值错误
InvalidParameterValue.DeviceAlreadyExist 创建的设备名已存在。
LimitExceeded.DeviceExceedLimit 设备数量超过限制。
ResourceNotFound.TaskNotExist 任务不存在。