物联网通信
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 物联网通信 > API 文档 > 设备相关接口 > 获取设备列表

获取设备列表

最近更新时间：2024-03-12 01:33:47

我的收藏

本页目录：

1. 接口描述

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDevices。
Version 是 String 公共参数，本接口取值：2021-04-08。
Region 是 String 公共参数，详见产品支持的 地域列表。
ProductId 是 String 需要查看设备列表的产品 ID
示例值：ABCDE12345
Offset 是 Integer 偏移量，Offset从0开始
示例值：0
Limit 是 Integer 分页的大小，数值范围 10-250
示例值：10
FirmwareVersion 否 String 设备固件版本号，若不带此参数会返回所有固件版本的设备。传"None-FirmwareVersion"查询无版本号的设备
示例值：1.0.0
DeviceName 否 String 需要过滤的设备名称
示例值：ABCD
EnableState 否 Integer 设备是否启用，0禁用状态1启用状态，默认不区分
示例值：1

3. 输出参数

参数名称 类型 描述
TotalCount Integer 设备总数
示例值：1
Devices Array of DeviceInfo 设备详细信息列表
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设备列表

输入示例

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

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "xx",
        "Devices": [
            {
                "EnableState": 1,
                "LastOfflineTime": 1,
                "Version": "xx",
                "CertState": 1,
                "Online": 1,
                "FirmwareUpdateTime": 1,
                "DeviceName": "xx",
                "Tags": [
                    {
                        "Tag": "xx",
                        "Type": 1,
                        "Name": "xx",
                        "Value": "xx"
                    },
                    {
                        "Tag": "xx",
                        "Type": 1,
                        "Name": "xx",
                        "Value": "xx"
                    }
                ],
                "LogLevel": 1,
                "FirstOnlineTime": 1,
                "DeviceCert": "xx",
                "Imei": "xx",
                "ClientIP": "xx",
                "DevicePsk": "xx",
                "Isp": 1,
                "NbiotDeviceID": "xx",
                "LoraDevEui": "xx",
                "DeviceType": 1,
                "LoginTime": 1,
                "ConnIP": 1,
                "LastUpdateTime": 1,
                "Labels": [
                    {
                        "Value": "xx",
                        "Key": "xx"
                    }
                ],
                "CreateTime": 1,
                "LoraMoteType": 1
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.DBOperationError 数据库内部错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound.ProductNotExist 产品不存在。
中国站