获取设备列表

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

1. 接口描述

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

本接口(DescribeDevices)用于查询物联网通信设备的设备列表。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDevices
Version String 公共参数,本接口取值:2018-06-14
Region String 公共参数,本接口不需要传递此参数。
ProductId String 需要查看设备列表的产品 ID
Offset Integer 分页偏移
Limit Integer 分页的大小,数值范围 10-100
FirmwareVersion String 设备固件版本号,若不带此参数会返回所有固件版本的设备

3. 输出参数

参数名称 类型 描述
TotalCount Integer 设备总数
Devices Array of DeviceInfo 设备详细信息列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设备列表

输入示例

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

输出示例

{
  "Response": {
    "Devices": [
      {
        "Tags": [
          {
            "Tag": "category",
            "Type": 2,
            "Value": "hello"
          },
          {
            "Tag": "note",
            "Type": 2,
            "Value": ""
          }
        ],
        "DeviceName": "test",
        "DeviceCert": "",
        "Online": 0,
        "ConnIP": 0,
        "LoginTime": 0,
        "Version": "1.0.0",
        "LastUpdateTime": 0,
        "DevicePsk": "",
        "DeviceType": 0,
        "Imei": "",
        "Isp": 0,
        "NbiotDeviceID": ""
      }
    ],
    "TotalCount": 1,
    "RequestId": "c81cf0fd-18bd-4f7a-845e-4f852645de2b"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误
InvalidParameterValue 参数取值错误