1. 接口描述
接口请求域名: iss.tencentcloudapi.com 。
查询本店里录像下载任务列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ListVideoDownloadTask。 |
Version | 是 | String | 公共参数,本接口取值:2023-05-17。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
DeviceName | 否 | String | 设备名称,用于模糊搜索 示例值:设备 1 |
ChannelName | 否 | String | 通道名称,用于模糊搜索 示例值:通道 1 |
Status | 否 | Integer | 任务状态(0:准备中,1:执行中,2:已完成,3:失败) 示例值:1 |
SortRule | 否 | String | 排序规则(仅支持 StartTime,EndTime,倒序为-StartTime,-EndTime) 示例值:StartTime,-EndTIme |
WithPreviewUrl | 否 | Integer | 响应是否携带预览地址(0:不携带;1:携带) 示例值:1 |
PageNumber | 否 | Integer | 分页页数 示例值:1 |
PageSize | 否 | Integer | 分页大小 示例值:20 |
DownloadTaskId | 否 | String | 下载任务 ID 示例值:ec72e1e1-fd18-407d-b537-**** |
UrlExpires | 否 | Integer | 下载地址过期时间,单位秒,最大为 1 天, 86400秒 示例值:3600 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | ListVideoDownloadTaskData | 本地录像下载任务列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListVideoDownloadTask
<公共请求参数>
{}
输出示例
{
"Response": {
"Data": {
"List": [
{
"ChannelCode": "310****00001320000001",
"ChannelId": "21098feb-57a4-4fbc-9435-************",
"ChannelName": "11",
"DeviceCode": "610*****01180000159",
"DeviceName": "NVR",
"DownloadTaskId": "e6651293-b5fa-4dbb-bfe0-************",
"DownloadTime": 7200,
"EndTime": "2024-10-22 12:29:02",
"Expire": 7,
"FailedReason": "",
"FileDownloadUrl": "https://*********.demo.cn/vds/lr/video.mp4?source=localrecord%2F7%2F21098feb-57a4-4fbc-9435-************%2F20241021%2Fe6651293-b5fa-4dbb-bfe0-************.mp4%3Bivc-test-new-251228313-ap-shanghai-1258344699%3Bap-shanghai%3B21098feb-57a4-4fbc-9435-*********%3B251228313%3B7000003*****9&intranet=0&expires=3600&signtime=1729675136&sign=1f9f2d21eb5e18b088f70f81*********",
"Scale": 2,
"StartTime": "2024-10-22 11:28:36",
"Status": 2,
"VideoSize": 967309246,
"VideoTimeSection": "2024-10-21 08:00:00-2024-10-21 10:00:00"
}
],
"TotalCount": 15
},
"RequestId": "f5447c9b-a7a6-42d5-b831-9e666bfbe261"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。