1. 接口描述
接口请求域名: vod.tencentcloudapi.com 。
用于发起提取视频数字水印任务,提取结果可以通过DescribeTaskDetail查询。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ExtractBlindWatermark。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-17。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Type | 是 | String | 数字水印类型,可选值: 示例值:blind-basic |
| InputInfo | 是 | ExtractBlindWatermarkInputInfo | 媒体处理的文件输入信息。 |
| SubAppId | 是 | Integer | 添加水印时的点播应用 ID。注意不管是传入FILEID还是URL,都必须与添加水印时的SubAppId吻合才能提取到水印。 示例值:1490012345 |
| ExtractBlindWatermarkConfig | 否 | ExtractBlindWatermarkTaskConfig | 提取数字水印任务配置 |
| SessionContext | 否 | String | 标识来源上下文,用于透传用户请求信息,在 ExtractBlindWatermarkComplete 回调和任务流状态变更回调将返回该字段值,最长 1000 个字符。 示例值:202410011900***tmsd |
| SessionId | 否 | String | 用于任务去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。 示例值:6bb56a09278740bc80c5dc6dab783eff |
| TasksPriority | 否 | Integer | 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务 ID。 示例值:125xxx65-ExtractBlindWatermark-bffb15f07530b57bc1aabb01fac74bca |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 发起提取视频数字水印任务
发起提取视频数字水印任务
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExtractBlindWatermark
<公共请求参数>
{
"Type": "blind-basic",
"InputInfo": {
"Type": "URL",
"Url": "http://test.cos.com/video.mp4"
},
"ExtractBlindWatermarkConfig": {
"SegmentDuration": 5000
}
}
输出示例
{
"Response": {
"RequestId": "2134541-fdc5-4b08-bf2d-97f7d6678b44",
"TaskId": "24000105-ExtractBlindWatermark-xxxxxx"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.SrcFile | 源文件错误。 |