调用AddWaterMarkTemplate新增水印模版_媒体处理(MPS)-阿里云帮助中心

创建水印模板。

接口说明

通过本接口创建水印模板后，在提交转码作业时指定水印模板和水印素材，即可为输出视频添加水印信息。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
mts:AddWaterMarkTemplate	create	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Name	string	是	水印模板名称。支持中英文，数字等，最大长度 128 字节。	example-watermark-****
Config	string	是	水印模板配置。JSON 对象。更多信息请参见水印模板配置详情。说明如果水印文字不需要与分辨率变化正相关，可配置自适应，即在文字水印的 text 中添加选项`['adaptive']=true`。	{"Width":"10","Height":"30","Dx":"10","Dy":"5","ReferPos":"TopRight","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}

返回参数

名称	类型	描述	示例值
	object	返回参数。
WaterMarkTemplate	object	水印模板。
Type	string	水印类型。可取值： Image：图片水印。 Text：文字水印。	Image
RatioRefer	object	取值为百分比时参考的边。当 Height，Width，Dx，Dy 的取值处于（0,1）时，这个百分比是参考下列边得到的（按顺序）： Width：宽。 Height：高。 Long：长边。 Short：短边。
Dx	string	水印图片相对输出视频的水平偏移量。默认值：0（无偏移）。值有两种形式：整数型：代表偏移像素，绝对位置，单位：px。小数型：代表水平偏移量与输出分辨率宽的比率，相对比例，按照视频尺寸变化，支持 4 位小数，如 0.9999，超出部分系统自动丢弃。	0.51
Width	string	输出视频上水印图片宽。值有两种形式：整数型：代表水印图片宽的像素值，绝对位置，单位：px。小数型：代表相对输出视频分辨率宽的比率，相对比例，按照视频尺寸变动，支持 4 位小数，如 0.9999，超出部分系统自动丢弃。	0.36
Height	string	输出视频上水印图片高。值有两种形式：整数型：代表水印图片高的像素值，绝对位置，单位：px。小数型：代表相对输出视频分辨率高的比率，相对比例，按照视频尺寸变动，支持 4 位小数，如 0.9999，超出部分系统自动丢弃。	0.33
Dy	string	水印图片相对输出视频的垂直偏移量。默认值：0（无偏移）。值有两种形式：整数型：代表偏移像素，绝对位置，单位：px。小数型：代表垂直偏移量与输出分辨率高的比率，相对比例，按照视频尺寸变动，支持 4 位小数，如 0.9999，超出部分系统自动丢弃。	0.28
ReferPos	string	水印的位置。取值： TopRight：右上。 TopLeft：左上。 BottomRight：右下。 BottomLeft：左下。	TopRight
State	string	水印模板的状态。 Normal：正常。 Deleted：已删除。	Normal
Dx	string	水平偏移量。单位：px。	10
Width	string	水印图片宽。单位：px。	10
Height	string	水印图片高。单位：px。	30
Timeline	object	动态水印。
Start	string	水印开始出现时间。单位：秒。默认值：0。	0
Duration	string	水印持续时间。默认值：ToEND（直至视频结束）。	ToEND
Name	string	水印模板名称。	example-watermark-****
Dy	string	垂直偏移量。单位：px。	5
Id	string	水印模板 ID。建议您保存此 ID 便于后续调用相关接口时使用。	3780bd69b2b74540bc7b1096f564****
RequestId	string	请求 ID。	54BB917F-DD35-4F32-BABA-E60E31B21W63

示例

正常返回示例

JSON格式

{
  "WaterMarkTemplate": {
    "Type": "Image",
    "RatioRefer": {
      "Dx": "0.51",
      "Width": "0.36",
      "Height": "0.33",
      "Dy": "0.28"
    },
    "ReferPos": "TopRight",
    "State": "Normal",
    "Dx": "10",
    "Width": "10",
    "Height": "30",
    "Timeline": {
      "Start": "0",
      "Duration": "ToEND"
    },
    "Name": "example-watermark-****",
    "Dy": "5",
    "Id": "3780bd69b2b74540bc7b1096f564****"
  },
  "RequestId": "54BB917F-DD35-4F32-BABA-E60E31B21W63"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史