UpdateWaterMarkTemplate - 更新水印模版_媒体处理-阿里云帮助中心

更新指定水印模板的名称、配置。

接口说明

本接口通过指定水印模板ID对水印模板的名称、配置等信息进行更行。
如果有状态为“已提交”的作业指定使用该水印模板，则相应的水印模板不能被更新。

QPS限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
WaterMarkTemplateId	string	是	需要更新的水印模板ID，可以通过MPS控制台>全局设置>水印模板获取。	3780bd69b2b74540bc7b1096f564****
Name	string	是	更新后的模板名称。支持中英文、数字等，最大长度128字节。	example-watermark-****
Config	string	是	更新后的水印模板配置。JSON对象，更多信息请参见水印模板配置详情。	{"Width":"10","Height":"30","Dx":"10","Dy":"5","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}

返回参数

名称	类型	描述	示例值
	object	返回参数。
WaterMarkTemplate	object	水印模板详细信息。
Type	string	水印类型。取值： Image：图片。 Text：文字。说明目前仅支持Image类型。	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（正常）。	Normal
Dx	string	水平偏移量。单位：px。	10
Width	string	水印图片宽度。单位：px。	10
Height	string	水印图片高度。单位：px。	30
Timeline	object	动态水印。
Start	string	水印开始出现时间。单位：秒（s）。默认值：0。	0
Duration	string	水印持续时间。默认值：ToEND（直至视频结束）。	10
Name	string	水印模板名称。	example-watermark-****
Dy	string	垂直偏移量。单位：px。	5
Id	string	水印模板ID。建议您保存此ID便于后续调用相关接口时使用。	3780bd69b2b74540bc7b1096f564****
RequestId	string	请求ID。	E558894E-40D9-57C6-B5CC-0F5CDF23614E

示例

正常返回示例

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": "10"
    },
    "Name": "example-watermark-****",
    "Dy": "5",
    "Id": "3780bd69b2b74540bc7b1096f564****"
  },
  "RequestId": "E558894E-40D9-57C6-B5CC-0F5CDF23614E"
}

错误码

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