获取设备列表信息

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

我的收藏

1. 接口描述

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

获取设备列表信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeIotDevices。
Version String 公共参数,本接口取值:2021-09-14。
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 页偏移
示例值:0
Limit Integer 每页数量
示例值:10
ProductId String 产品id
示例值:xxx
NamePattern String 设备名称模糊查找
示例值:xxx
Versions.N Array of String 版本列表
示例值:xxx
Order String ASC 或 DESC

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合查找条件的总数量
示例值:100
DeviceSet Array of IotDevicesInfo 设备列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeIotDevices

输入示例

POST / HTTP/1.1
Host: iecp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIotDevices
<公共请求参数>

{
    "Offset": 0,
    "NamePattern": "01",
    "ProductId": "SA4RZ3NLIM",
    "Limit": 10,
    "Versions": [
        "xx",
        "yy"
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "bd51b03d-e10e-4c8f-a3f9-e773fd9e4a18",
        "DeviceSet": [
            {
                "Status": 0,
                "LastOnlineTime": "-",
                "Description": "测试",
                "IsBound": true,
                "Region": "ap-guangzhou",
                "UnitName": "ccccx",
                "Id": 0,
                "Disabled": true,
                "Version": "",
                "UnitID": 100067,
                "CreateTime": "2022-04-12 18:51:34",
                "Name": "link01"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码