物联网开发平台获取产品的设备列表-API 文档-文档中心-腾讯云

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GetDeviceList。
Version	是	String	公共参数，本接口取值：2019-04-23。
Region	是	String	公共参数，详见产品支持的地域列表。
ProductId	是	String	需要查看设备列表的产品ID, -1代表ProjectId来筛选示例值：ABCDE12345
Offset	否	Integer	分页偏移示例值：0
Limit	否	Integer	分页的大小，数值范围 10-100 示例值：10
FirmwareVersion	否	String	设备固件版本号，若不带此参数会返回所有固件版本的设备。传"None-FirmwareVersion"查询无版本号的设备示例值：1
DeviceName	否	String	需要过滤的设备名称示例值：1
ProjectId	否	String	项目ID。产品 ID 为 -1 时，该参数必填示例值：test
Filters.N	否	Array of Filter	每次请求的Filters的上限为10，Filter.Values的上限为1。示例值：NA

3. 输出参数

参数名称	类型	描述
Devices	Array of DeviceInfo	返回的设备列表, 注意列表设备的 DevicePsk 为空, 要获取设备的 DevicePsk 请使用 DescribeDevice 注意：此字段可能返回 null，表示取不到有效值。
Total	Integer	产品下的设备总数注意：此字段可能返回 null，表示取不到有效值。示例值：3
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设备列表

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

输入示例

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

输出示例

{
    "Response": {
        "Devices": [
            {
                "DeviceName": "test",
                "Status": 0,
                "DevicePsk": "",
                "CreateTime": 0,
                "FirstOnlineTime": 0,
                "LoginTime": 0,
                "LogLevel": 0,
                "Version": "",
                "DeviceCert": "",
                "DevEUI": "",
                "AppKey": "",
                "DevAddr": "",
                "AppSKey": "",
                "NwkSKey": "",
                "CreatorNickName": "",
                "CreateUserId": 0,
                "EnableState": 0,
                "ProductId": "PR***TA",
                "DeviceType": "设备",
                "ProductName": "产品名称",
                "IsLora": false
            }
        ],
        "RequestId": "219a59ba-fdd0-4214-8db-71da9fe28",
        "Total": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InternalError.DBOpertaionError	DB操作错误。
InternalError.InternalRPCError	内部RPC错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.GetProductsListError	拉取产品列表失败。
ResourceNotFound.DeviceNotExist	设备不存在。
ResourceNotFound.ProductNotExist	产品不存在。
ResourceNotFound.ProjectNotExist	项目不存在。
ResourceNotFound.StudioProductNotExist	产品不存在。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.NoPermissionToProject	项目ACL错误。
UnauthorizedOperation.NoPermissionToStudioProduct	产品ACL错误。
UnsupportedOperation.InstanceIsolated	由于实例到期已被禁用，请续费后使用。

获取产品的设备列表

本页目录：