获取设备列表

最近更新时间:2019-08-29 20:37:41

1. 接口描述

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

用于查询某个产品下的设备列表

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetDeviceList
Version String 公共参数,本接口取值:2019-04-23
Region String 公共参数,详见产品支持的 地域列表
ProductId String 需要查看设备列表的产品 ID
Offset Integer 分页偏移
Limit Integer 分页的大小,数值范围 10-100

3. 输出参数

参数名称 类型 描述
Devices Array of DeviceInfo 返回的设备列表, 注意列表设备的 DevicePsk 为空, 要获取设备的 DevicePsk 请使用 DescribeDevice
注意:此字段可能返回 null,表示取不到有效值。
Total Integer 产品下的设备总数
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设备列表

根据某个产品ID获取对应的设备列表

输入示例

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

输出示例

{
  "Response": {
    "Devices": [
      {
        "DeviceName": "wifi_test",
        "Status": 0,
        "DevicePsk": "",
        "FirstOnlineTime": 1557397755,
        "LoginTime": 1559744044
      },
      {
        "DeviceName": "dev_hu",
        "Status": 0,
        "DevicePsk": "",
        "FirstOnlineTime": 1557235894,
        "LoginTime": 1560328893
      },
      {
        "DeviceName": "dev01",
        "Status": 0,
        "DevicePsk": "",
        "FirstOnlineTime": 1557229181,
        "LoginTime": 1557470791
      }
    ],
    "RequestId": "4ccc27e9-4525-4396-9db3-369b2cd3d28a",
    "Total": 3
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound.ProductNotExist 产品不存在。
ResourceNotFound.StudioProductNotExist 产品不存在。
UnauthorizedOperation 未授权操作。