1. 接口描述
接口请求域名： iotvideoindustry.tencentcloudapi.com 。
本接口(DescribeVideoListByChannel)用于查询指定通道的录制文件列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeVideoListByChannel。 |
| Version | 是 | String | 公共参数，本接口取值：2020-12-01。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DeviceId | 是 | String | 设备唯一标识 示例值：99870353841320000007_99870353841320000007 |
| ChannelId | 是 | String | 通道唯一标识 示例值：99870353841320000007_99870353841320000007 |
| Type | 是 | Integer | 1: 云端录制 2: 本地录制 示例值：1 |
| Date | 否 | String | 指定某天。取值【YYYY-MM-DD】 为空时默认查询最近一天的记录 示例值：2021-01-01 |
| Limit | 否 | Integer | 限制量，默认2000 示例值：100 |
| Offset | 否 | Integer | 偏移量，默认0 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| VideoList | Array of RecordTaskItem | 录像详情列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：null |
| TotalCount | Integer | 录像总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取录制文件列表
输入示例
POST / HTTP/1.1
Host: iotvideoindustry.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVideoListByChannel
<公共请求参数>
{
"Limit": "10",
"ChannelId": "99576636581320000330_99576636581320000330",
"Type": "1",
"DeviceId": "99576636581320000330_99576636581320000330",
"Offset": "0"
}输出示例
{
"Response": {
"RequestId": "5830fae4-3a4c-4d88-9b46-ce9f0c62f7d1",
"TotalCount": 94,
"VideoList": [
{
"RecordId": "",
"RecordTaskId": "20211214707e9bd48a3c443c922fce4fca3676ab",
"RecordPlanId": "plan-fyw1k9l5",
"StartTime": 1639467009,
"EndTime": 1639467609,
"EventId": 1,
"VideoUrl": "https://1304886180.vod2.myqcloud.com/cac4da69vodcq1304886180/af1a6a2b387702292619211604/f0.mp4",
"RecordStatus": 0,
"SceneId": 0,
"WarnId": 0
},
{
"RecordId": "",
"RecordTaskId": "20211214707e9bd48a3c443c922fce4fca3676ab",
"RecordPlanId": "plan-fyw1k9l5",
"StartTime": 1639466409,
"EndTime": 1639467009,
"EventId": 1,
"VideoUrl": "https://1304886180.vod2.myqcloud.com/cac4da69vodcq1304886180/e6c89beb387702292620245731/f0.mp4",
"RecordStatus": 0,
"SceneId": 0,
"WarnId": 0
},
{
"RecordId": "",
"RecordTaskId": "20211214707e9bd48a3c443c922fce4fca3676ab",
"RecordPlanId": "plan-fyw1k9l5",
"StartTime": 1639465809,
"EndTime": 1639466409,
"EventId": 1,
"VideoUrl": "https://1304886180.vod2.myqcloud.com/cac4da69vodcq1304886180/af0c9fad387702292619209122/f0.mp4",
"RecordStatus": 0,
"SceneId": 0,
"WarnId": 0
},
{
"RecordId": "",
"RecordTaskId": "20211214707e9bd48a3c443c922fce4fca3676ab",
"RecordPlanId": "plan-fyw1k9l5",
"StartTime": 1639465209,
"EndTime": 1639465809,
"EventId": 1,
"VideoUrl": "https://1304886180.vod2.myqcloud.com/cac4da69vodcq1304886180/66ca6a0c387702292618411154/f0.mp4",
"RecordStatus": 0,
"SceneId": 0,
"WarnId": 0
},
{
"RecordId": "",
"RecordTaskId": "20211214707e9bd48a3c443c922fce4fca3676ab",
"RecordPlanId": "plan-fyw1k9l5",
"StartTime": 1639464609,
"EndTime": 1639465209,
"EventId": 1,
"VideoUrl": "https://1304886180.vod2.myqcloud.com/cac4da69vodcq1304886180/70b296fd387702292618896352/f0.mp4",
"RecordStatus": 0,
"SceneId": 0,
"WarnId": 0
},
{
"RecordId": "",
"RecordTaskId": "20211214707e9bd48a3c443c922fce4fca3676ab",
"RecordPlanId": "plan-fyw1k9l5",
"StartTime": 1639464009,
"EndTime": 1639464609,
"EventId": 1,
"VideoUrl": "https://1304886180.vod2.myqcloud.com/cac4da69vodcq1304886180/25676513387702292617900591/f0.mp4",
"RecordStatus": 0,
"SceneId": 0,
"WarnId": 0
},
{
"RecordId": "",
"RecordTaskId": "20211214707e9bd48a3c443c922fce4fca3676ab",
"RecordPlanId": "plan-fyw1k9l5",
"StartTime": 1639463409,
"EndTime": 1639464009,
"EventId": 1,
"VideoUrl": "https://1304886180.vod2.myqcloud.com/cac4da69vodcq1304886180/5fbc368f387702292618107605/f0.mp4",
"RecordStatus": 0,
"SceneId": 0,
"WarnId": 0
},
{
"RecordId": "",
"RecordTaskId": "20211214707e9bd48a3c443c922fce4fca3676ab",
"RecordPlanId": "plan-fyw1k9l5",
"StartTime": 1639462809,
"EndTime": 1639463409,
"EventId": 1,
"VideoUrl": "https://1304886180.vod2.myqcloud.com/cac4da69vodcq1304886180/5fbb9e94387702292618106395/f0.mp4",
"RecordStatus": 0,
"SceneId": 0,
"WarnId": 0
},
{
"RecordId": "",
"RecordTaskId": "20211214707e9bd48a3c443c922fce4fca3676ab",
"RecordPlanId": "plan-fyw1k9l5",
"StartTime": 1639462209,
"EndTime": 1639462809,
"EventId": 1,
"VideoUrl": "https://1304886180.vod2.myqcloud.com/cac4da69vodcq1304886180/5fbb090a387702292618105143/f0.mp4",
"RecordStatus": 0,
"SceneId": 0,
"WarnId": 0
},
{
"RecordId": "",
"RecordTaskId": "20211214707e9bd48a3c443c922fce4fca3676ab",
"RecordPlanId": "plan-fyw1k9l5",
"StartTime": 1639461609,
"EndTime": 1639462209,
"EventId": 1,
"VideoUrl": "https://1304886180.vod2.myqcloud.com/cac4da69vodcq1304886180/8b748b6b387702292615903411/f0.mp4",
"RecordStatus": 0,
"SceneId": 0,
"WarnId": 0
}
]
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.DeviceNotExist | 设备未创建或是已删除。 |
| ResourceUnavailable.GBProtocolExecException | 国标信令异常。 |
| UnsupportedOperation.DeviceSipCommandFail | 设备信令不通。 |
| UnsupportedOperation.UserIsIsolate | 处于隔离中的资源不能进行此操作。 |