1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
对URL链接或COS中的视频发起入库任务。
可选在任务完成后向回调方发送任务完成状态信息。
默认接口请求频率限制:2次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateVideoDatabaseEntryTask。 |
Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-shanghai 。 |
InputInfo | 是 | MediaInputInfo | 待入库视频信息 |
TaskNotifyConfig | 否 | TaskNotifyConfig | 可选,入库任务完成后向指定的回调地址传递任务结果,目前仅支持URL |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:251xxx279-VideoDBEntryTask-327a6a4b840e40eab7819d394b583144 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 Url视频入库
使用视频url发起视频入库任务
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVideoDatabaseEntryTask
<公共请求参数>
{
"InputInfo": {
"Type": "URL",
"UrlInputInfo": {
"Url": "http://qq.com/test.mp4"
}
},
"TaskNotifyConfig": {
"NotifyType": "URL",
"NotifyUrl": "http://qq.com/callback"
}
}
输出示例
{
"Response": {
"TaskId": "251xxx279-VideoDBEntryTask-60e4ae3b23ff4fd3936eb6b7e8af25ec",
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
示例2 COS视频入库
使用视频COS地址发起视频入库任务
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVideoDatabaseEntryTask
<公共请求参数>
{
"InputInfo": {
"Type": "COS",
"CosInputInfo": {
"Bucket": "test-bucket",
"Region": "ap-nanjing",
"Object": "/movie/test.mp4"
}
},
"TaskNotifyConfig": {
"NotifyType": "URL",
"NotifyUrl": "http://qq.com/callback"
}
}
输出示例
{
"Response": {
"TaskId": "251xxx279-VideoDBEntryTask-60e4ae3b23ff4fd3936eb6b7e8af25ec",
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |