媒体处理创建水印模板

1. 接口描述

接口请求域名： mps.tencentcloudapi.com 。

创建用户自定义水印模板，数量上限：1000。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateWatermarkTemplate。
Version	是	String	公共参数，本接口取值：2019-06-12。
Region	否	String	公共参数，本接口不需要传递此参数。
Type	是	String	水印类型，可选值： image：图片水印； text：文字水印； svg：SVG 水印。示例值：text
Name	否	String	水印模板名称，长度限制：64 个字符。示例值：水印模板1
Comment	否	String	模板描述信息，长度限制：256 个字符。示例值：文字水印
CoordinateOrigin	否	String	原点位置，可选值： TopLeft：表示坐标原点位于视频图像左上角，水印原点为图片或文字的左上角； TopRight：表示坐标原点位于视频图像的右上角，水印原点为图片或文字的右上角； BottomLeft：表示坐标原点位于视频图像的左下角，水印原点为图片或文字的左下角； BottomRight：表示坐标原点位于视频图像的右下角，水印原点为图片或文字的右下角。默认值：TopLeft。示例值：TopLeft
XPos	否	String	水印原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式：当字符串以 % 结尾，表示水印 XPos 为视频宽度指定百分比，如 10% 表示 XPos 为视频宽度的 10%；当字符串以 px 结尾，表示水印 XPos 为指定像素，如 100px 表示 XPos 为 100 像素。默认值：0px。示例值：5%
YPos	否	String	水印原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式：当字符串以 % 结尾，表示水印 YPos 为视频高度指定百分比，如 10% 表示 YPos 为视频高度的 10%；当字符串以 px 结尾，表示水印 YPos 为指定像素，如 100px 表示 YPos 为 100 像素。默认值：0px。示例值：5%
ImageTemplate	否	ImageWatermarkInput	图片水印模板，仅当 Type 为 image，该字段必填且有效。
TextTemplate	否	TextWatermarkTemplateInput	文字水印模板，仅当 Type 为 text，该字段必填且有效。
SvgTemplate	否	SvgWatermarkInput	SVG 水印模板，仅当 Type 为 svg，该字段必填且有效。

3. 输出参数

参数名称	类型	描述
Definition	Integer	水印模板唯一标识。示例值：10
ImageUrl	String	水印图片地址，仅当 Type 为 image，该字段有效。示例值：http://12561267.vts2.myqcloud.com/8b0dd2b5vtscq125768367/4d27b39f5/t.jpeg
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建水印模板

输入示例

POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWatermarkTemplate
<公共请求参数>

{
    "Name": "水印模板1",
    "Comment": "svg水印",
    "Type": "svg",
    "CoordinateOrigin": "TopRight",
    "XPos": "5%",
    "YPos": "5%",
    "ImageTemplate": {
        "ImageContent": "",
        "Width": "10%",
        "Height": "0px",
        "RepeatType": "once"
    },
    "TextTemplate": {
        "FontType": "arial.ttf",
        "FontSize": "10px",
        "FontColor": "#ffffff",
        "FontAlpha": 0.5
    },
    "SvgTemplate": {
        "Width": "10%",
        "Height": "0px"
    }
}

输出示例

{
    "Response": {
        "Definition": 123,
        "ImageUrl": "",
        "RequestId": "93dda61a-c2c5-465d-a78c-0860997fb01b"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.InvalidMpsUser	操作失败：非法 mps 用户。
InternalError	内部错误。
InternalError.GenDefinition	内部错误：生成模板 ID 失败。
InternalError.UploadWatermarkError	内部错误：上传水印图片失败。
InvalidParameterValue.Comment	参数错误：对该模板的描述。
InvalidParameterValue.CoordinateOrigin	参数值错误：CoordinateOrigin。
InvalidParameterValue.Height	参数错误：高度。
InvalidParameterValue.ImageContent	ImageContent参数值无效。
InvalidParameterValue.ImageTemplate	参数错误：图片水印模板。
InvalidParameterValue.Name	参数值错误：Name 超过长度限制。
InvalidParameterValue.RepeatType	参数错误：RepeatType 无效。
InvalidParameterValue.SvgTemplate	参数值错误：SVG 为空。
InvalidParameterValue.SvgTemplateHeight	参数值错误：SVG 高度。
InvalidParameterValue.SvgTemplateWidth	参数值错误：SVG 宽度。
InvalidParameterValue.TextAlpha	参数错误：文字透明度。
InvalidParameterValue.TextTemplate	参数错误：文字模板。
InvalidParameterValue.Type	参数错误：Type 参数值错误。
InvalidParameterValue.Width	参数错误：宽度。
InvalidParameterValue.XPos	水印原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式。
InvalidParameterValue.YPos	水印原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式。
LimitExceeded.TooMuchTemplate	超过限制值：模板数超限。

创建水印模板

本页目录：