1. 接口描述
接口请求域名： iss.tencentcloudapi.com 。
创建本地录像下载任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateVideoDownloadTask。 |
| Version | 是 | String | 公共参数，本接口取值：2023-05-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ChannelId | 是 | String | 通道ID 示例值：uuid |
| BeginTime | 是 | Integer | 开始时间 示例值：1728124673 |
| EndTime | 是 | Integer | 结束时间 示例值：1728124773 |
| Scale | 否 | Integer | 默认1倍速，支持（1,2,4,8）倍速 示例值：1 |
| Expire | 否 | Integer | 转码后的mp4文件过期时间（支持7,15,30,60,90,180,365） 示例值：7 |
| FileType | 否 | Integer | 下载文件格式，当前仅支持（1：mp4） 示例值：1 |
| CompletionPolicy | 否 | Integer | 完成策略（0：拉流失败但是录像不完整则认为任务失败，不生成 MP4；1：拉流失败但是录像不完整则认为任务成功，生成 mp4） 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | VideoDownloadTaskData | 下载任务返回结果 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVideoDownloadTask
<公共请求参数>
{
"ChannelId": "***********",
"BeginTime": 1729288800,
"EndTime": 1729292400,
"Scale": 1,
"Expire": 7,
"FileType": 1
}输出示例
{
"Response": {
"Data": {
"DownloadTaskId": "**********"
},
"RequestId": "cd92416f-bc75-4d17-91f3-93d7c94d1cf5"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
