1. 接口描述
接口请求域名: iotvideoindustry.tencentcloudapi.com 。
根据时间获取云端录制文件列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeVideoList。 |
Version | 是 | String | 公共参数,本接口取值:2020-12-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Offset | 是 | Integer | 偏移 示例值:0 |
Limit | 是 | Integer | 限制 示例值:10 |
StartTime | 否 | Integer | 开始时间戳,秒级 示例值:1616660711 |
EndTime | 否 | Integer | 结束时间戳,秒级 示例值:1616661017 |
DeviceId | 否 | String | 设备Id 示例值:99870353841320000007_99870353841320000007 |
StartRecordTime | 否 | Integer | 开始录制范围 开始 示例值:1624204800 |
EndRecordTime | 否 | Integer | 开始录制范围 结束 示例值:1624204800 |
StartExpireTime | 否 | Integer | 过期时间范围 开始 示例值:1624204800 |
EndExpireTime | 否 | Integer | 过期时间范围 结束 示例值:1624204800 |
StartFileSize | 否 | Integer | 文件大小范围 开始 单位byte 示例值:20 |
EndFileSize | 否 | Integer | 文件大小范围 结束 单位byte 示例值:50 |
IsRecording | 否 | Integer | 录制状态 99: 录制方已经回写状态 1: 开始录制了,等待回写 2: 已经到了时间模板的停止时间,在等待录制方回写 示例值:99 |
ChannelId | 否 | String | 通道ID默认必传 示例值:99576636581320000310_99782261871320000002 |
PlanId | 否 | String | 录制计划ID 示例值:planidyyysssdd |
SceneId | 否 | Integer | 场景ID 示例值:3445 |
WarnId | 否 | Integer | 告警ID 示例值:34455 |
RecordType.N | 否 | Array of Integer | 录制类型 1: 联动计划录制 2: 告警录制 示例值:[1] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总数 示例值:1 |
VideoList | RecordTaskItem | 已废弃 |
RecordList | Array of RecordTaskItem | 录像详情列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询录像文件列表
输入示例
POST / HTTP/1.1
Host: iotvideoindustry.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVideoList
<公共请求参数>
{
"ChannelId": "99576636581320000330_99576636581320000330",
"Limit": "2",
"DeviceId": "99576636581320000330_99576636581320000330",
"Offset": "0"
}
输出示例
{
"Response": {
"VideoList": {
"EventId": 0,
"VideoUrl": "xx",
"RecordTaskId": "xx",
"RecordId": "xx",
"SceneId": 0,
"StartTime": 0,
"RecordStatus": 0,
"RecordPlanId": "xx",
"EndTime": 0,
"WarnId": 0
},
"TotalCount": 1752,
"RequestId": "xx",
"RecordList": [
{
"EventId": 1,
"VideoUrl": "xx",
"RecordTaskId": "xx",
"RecordId": "xx",
"SceneId": 0,
"StartTime": 1639470612,
"RecordStatus": 1,
"RecordPlanId": "xx",
"EndTime": 0,
"WarnId": 0
},
{
"EventId": 1,
"VideoUrl": "xx",
"RecordTaskId": "xx",
"RecordId": "xx",
"SceneId": 0,
"StartTime": 1639470009,
"RecordPlanId": "xx",
"RecordStatus": 0,
"EndTime": 1639470609,
"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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
UnsupportedOperation.DeviceMissMatch | 设备和通道不匹配,请检查。 |
UnsupportedOperation.UserIsIsolate | 处于隔离中的资源不能进行此操作。 |