获取设备列表

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

我的收藏

1. 接口描述

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

本接口(DescribeDeviceList) 用于获取设备列表,支持模糊搜索

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDeviceList。
Version String 公共参数,本接口取值:2020-12-01。
Region String 公共参数,详见产品支持的 地域列表
Offset Integer 偏移量,默认0
示例值:0
Limit Integer 限制,默认200
示例值:10
NickName String 设备名前缀
示例值:myDevice
DeviceTypes.N Array of Integer 设备类型,1:国标VMS设备(公有云不支持此类型),2:国标IPC设备,3:国标NVR设备,9:智能告警设备(公有云不支持此类型)
示例值:2,3

3. 输出参数

参数名称 类型 描述
TotalCount Integer 设备总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Devices Array of AllDeviceInfo 设备详细信息列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设备列表

输入示例

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

{
    "Limit": "10",
    "NickName": "btest",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "Devices": [
            {
                "DeviceId": "99576636581320000270_99576636581320000270",
                "DeviceType": 2,
                "Status": 3,
                "ExtraInformation": "",
                "DeviceCode": "99576636581320000270",
                "Protocol": "GB28181",
                "GroupId": "group_root",
                "GroupName": "全部",
                "GroupPath": ""
            },
            {
                "DeviceId": "99576636581320000271_99576636581320000271",
                "DeviceType": 2,
                "Status": 3,
                "ExtraInformation": "",
                "DeviceCode": "99576636581320000271",
                "Protocol": "GB28181",
                "GroupId": "group_root",
                "GroupName": "全部",
                "GroupPath": ""
            },
            {
                "DeviceId": "99576636581320000272_99576636581320000272",
                "DeviceType": 2,
                "Status": 3,
                "ExtraInformation": "",
                "DeviceCode": "99576636581320000272",
                "Protocol": "GB28181",
                "GroupId": "group_root",
                "GroupName": "全部",
                "GroupPath": ""
            }
        ],
        "RequestId": "5aa3fe4f-72c3-4c77-a48d-a418addff8c9",
        "TotalCount": 3
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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