物联网智能视频服务（行业版）获取设备下属通道列表-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口（DescribeChannels）用于获取设备下属通道列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeChannels。
Version	是	String	公共参数，本接口取值：2020-12-01。
Region	是	String	公共参数，详见产品支持的地域列表。
DeviceId	是	String	设备Id 示例值：34020000001180000036_34020000001320000092
Limit	否	Integer	限制，默认0 示例值：100
Offset	否	Integer	偏移量，默认0 示例值：0
ChannelTypes.N	否	Array of Integer	通道类型 0: 未知类型 1: 视频通道 2: 音频通道 3: 告警通道示例值：[0]
PlanId	否	String	录制计划ID，当为"null"值时未绑定录制计划示例值：1624204800
SceneId	否	Integer	告警联动场景ID，当为 -1 值时未绑定场景示例值：243

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	通道总数注意：此字段可能返回 null，表示取不到有效值。示例值：1
Channels	Array of ChannelDetail	通道详情列表注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设备下属通道列表

输入示例

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

{
    "DeviceId": "99576636581180000329_99576636581180000329"
}

输出示例

{
    "Response": {
        "Channels": [
            {
                "ChannelName": "小枪机",
                "ChannelId": "99576636581180000329_34020000001320000094",
                "ChannelType": 1,
                "ChannelCode": "34020000001320000094",
                "ExtraInformation": "{\"Manufacturer\":\"Manufacturer\",\"Model\":\"Camera\"}",
                "Status": 3,
                "IsRecord": 1,
                "DeviceId": "99576636581180000329_99576636581180000329",
                "BusinessGroupId": "99576636581180000329_99576636581180000329"
            }
        ],
        "RequestId": "2d38b437-935b-4593-8e69-36e0945767e0",
        "TotalCount": 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. 错误码

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

错误码	描述
ResourceNotFound.DeviceNotExist	设备未创建或是已删除。

获取设备下属通道列表

本页目录：