开发指南

服务端 API 文档

有奖征文|投稿上云技术实践,赢取价值5000元大奖> HOT

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

修改用户自定义水印模板,水印类型不允许修改。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyWatermarkTemplate。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,本接口不需要传递此参数。
Definition Integer 水印模板唯一标识。
SubAppId Integer 点播子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。
Name String 水印模板名称,长度限制:64 个字符。
Comment String 模板描述信息,长度限制:256 个字符。
CoordinateOrigin String 原点位置,可选值:
  • TopLeft:表示坐标原点位于视频图像左上角,水印原点为图片或文字的左上角;
  • TopRight:表示坐标原点位于视频图像的右上角,水印原点为图片或文字的右上角;
  • BottomLeft:表示坐标原点位于视频图像的左下角,水印原点为图片或文字的左下角;
  • BottomRight:表示坐标原点位于视频图像的右下角,水印原点为图片或文字的右下角。
  • XPos String 水印原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示水印 XPos 为视频宽度指定百分比,如 10% 表示 XPos 为视频宽度的 10%;
  • 当字符串以 px 结尾,表示水印 XPos 为指定像素,如 100px 表示 XPos 为 100 像素。
  • YPos String 水印原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式:
  • 当字符串以 % 结尾,表示水印 YPos 为视频高度指定百分比,如 10% 表示 YPos 为视频高度的 10%;
  • 当字符串以 px 结尾,表示水印 YPos 为指定像素,如 100px 表示 YPos 为 100 像素。
  • ImageTemplate ImageWatermarkInputForUpdate 图片水印模板,该字段仅对图片水印模板有效。
    TextTemplate TextWatermarkTemplateInputForUpdate 文字水印模板,该字段仅对文字水印模板有效。
    SvgTemplate SvgWatermarkInputForUpdate SVG 水印模板,该字段仅对 SVG 水印模板有效。

    3. 输出参数

    参数名称 类型 描述
    ImageUrl String 图片水印地址,仅当 ImageTemplate.ImageContent 非空,该字段有值。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 修改水印模板

    输入示例

    https://vod.tencentcloudapi.com/?Action=ModifyWatermarkTemplate
    &Definition=1001
    &Name=模板2
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "ImageUrl": null,
            "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation 操作失败。
    FailedOperation.InvalidVodUser 没有开通点播业务。
    InternalError 内部错误。
    InternalError.UploadWatermarkError 内部错误:上传水印图片失败。
    InvalidParameterValue.Comment 参数错误:对该模板的描述。
    InvalidParameterValue.CoordinateOrigin 参数值错误:CoordinateOrigin。
    InvalidParameterValue.Height 参数错误:高度。
    InvalidParameterValue.ImageContent ImageContent参数值无效。
    InvalidParameterValue.Name 参数值错误:Name 超过长度限制。
    InvalidParameterValue.RepeatType 参数错误:RepeatType 无效。
    InvalidParameterValue.SvgTemplateHeight 参数值错误:SVG 高度。
    InvalidParameterValue.SvgTemplateWidth 参数值错误:SVG 宽度。
    InvalidParameterValue.TextAlpha 参数错误:文字透明度。
    InvalidParameterValue.Type Type 参数值错误。
    InvalidParameterValue.Width 参数错误:宽度。
    InvalidParameterValue.XPos 水印原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式。
    InvalidParameterValue.YPos 水印原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式。
    ResourceNotFound.TemplateNotExist 资源不存在:模板不存在。
    UnauthorizedOperation 未授权操作。
    目录