# 创建水印模板 - CreateWatermarkTemplate #### 功能介绍 创建水印模板。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/VOD/doc?api=CreateWatermarkTemplate)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vod/vod_04_0012.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | vod:watermarkTemplate:create | Write | - | - | - | - | #### URI POST /v1.0/{project_id}/template/watermark 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-vod/vod_04_0211.html) | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token，使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | | Authorization | 否 | String | 使用AK/SK方式认证时必选，携带的鉴权信息。 | | X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选，请求的发生时间。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | 水印模板名称。 | | watermark_type | 否 | String | 水印类型，当前只支持IMAGE（图片水印）。 | | image_process | 否 | String | watermark_type设置为IMAGE时有效。 目前包括： - ORIGINAL：只做简单缩放，不做其他处理 - TRANSPARENT：图片底色透明 - GRAYED：彩色图片变灰 | | dx | 否 | String | 水印图片相对输出视频的水平偏移量，默认值是0。 设置方法有两种，建议小数型，整数型可能导致控制台图片无法预览，但不影响转码： - 整数型：表示图片起点水平偏移视频顶点的像素值，单位px。取值范围：\[0，4096\] - 小数型：表示图片起点相对于视频分辨率宽的水平偏移比率。取值范围：(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 | | dy | 否 | String | 水印图片相对输出视频的垂直偏移量，默认值是0。 设置方法有两种，建议小数型，整数型可能导致控制台图片无法预览，但不影响转码： - 整数型：表示图片起点垂直偏移视频顶点的像素值，单位px。取值范围：\[0，4096\] - 小数型：表示图片起点相对于视频分辨率高的垂直偏移比率。取值范围：(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 | | position | 否 | String | 水印的位置，默认TOPRIGHT。 目前包括： - TOPRIGHT：右上位置 - TOPLEFT：左上位置 - BOTTOMRIGHT：右下位置 - BOTTOMLEFT：左下位置 | | width | 否 | String | 水印图片宽，建议小数型，整数型可能导致控制台图片无法预览，但不影响转码。 值有两种形式： - 整数型代水印图片宽的像素值，范围\[8，4096\]，单位px。 - 小数型代表相对输出视频分辨率宽的比率，范围(0,1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 | | height | 否 | String | 水印图片高，建议小数型，整数型可能导致控制台图片无法预览，但不影响转码。 值有两种形式： - 整数型代表水印图片高的像素值，范围\[8，4096\]，单位px。 - 小数型代表相对输出视频分辨率高的比率，范围(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。 | | timeline_start | 否 | String | 水印开始时间，与"timeline_duration"配合使用。 取值范围:\[0, END)。"END"表示视频结束时间。 单位:秒。 | | timeline_duration | 否 | String | 水印持续时间，与"timeline_start"配合使用。 取值范围:(0,END-开始时间\]。"END"表示视频结束时间。 单位:秒。 默认:END。 | | type | 是 | String | 水印图片格式类型。仅支持png、jpg和jpeg格式的图片作为水印模板，传值仅支持JPG、JPEG和PNG三种字符串。 | | md5 | 否 | String | 水印图片MD5值。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 水印配置模板id | | upload_url | String | 水印图片上传地址 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 创建水印模板 ``` POST https://{endpoint}/v1.0/{project_id}/template/watermark Content-Type: application/json { "name": "test", "type": "PNG" } ``` #### 响应示例 **状态码：200** 处理成功返回 ``` { "id" : "a52ba84366abebb4c4614e1b16973549", "upload_url" : "https://vod-bucket-26-cn-north-4.obs.cn-north-4.myhuaweicloud.com:443/05ab5cef408026f22f62c018de60cf2e/a52ba84366abebb4c4614e1b16973549/watermark.png?AWSAccessKeyId=CBN2J**********0RCSN&Expires=1625479312&Signature=kZYh0hEos2V**********AHGyXA%3D" } ``` **状态码：400** 处理失败返回 ``` { "error_code" : "VOD.10053", "error_msg" : "The request parameter is illegal, illegal field: {xx}." } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 处理成功返回 | | 400 | 处理失败返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-vod/ErrorCode.html)。