调用UpdateWaterMarkTemplate接口更新指定水印模板的名称、配置。

说明 如果有状态为“已提交”的作业引用该水印模板,则相应的水印模板不能被更新。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateWaterMarkTemplate

操作接口名,系统规定参数,取值:UpdateWaterMarkTemplate

WaterMarkTemplateId String 3780bd69b2b74540bc7b1096f564****

水印模板ID。

Name String example-watermark

模板名称。最大长度128字节。

Config String {"Width":"10px","Height":"30px","Dx":"10px","Dy":"5px","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}

水印模板配置。JSON对象,请参见附录-水印模板配置详情

返回数据

名称 类型 示例值 描述
WaterMarkTemplate Object

水印模板。

Type String Image

水印类型。取值:Image(图片)、Text(水印)。

说明 目前仅支持 Image
RatioRefer Object

返回参数。

Dx String 200

水平偏移量。

  • 取值范围:[-4096,4096]
  • 单位:px。
Width String 8

宽。

  • 取值范围:[8,4096]
  • 单位:px。
Height String 8

高。

  • 取值范围:[8,4096]
  • 单位:px。
Dy String 200

垂直偏移量。

  • 取值范围:[-4096,4096]
  • 单位:px。
ReferPos String TopRight

水印的位置。取值:TopRight、TopLeft、BottomRight、BottomLeft。

State String Normal

水印模板的状态。取值:

  • Normal:正常。
  • Deleted:已删除。
Dx String 200

水平偏移量。

  • 取值范围:[-4096,4096]
  • 单位:px。
Width String 8

宽。

  • 取值范围:[8,4096]
  • 单位:px。
Height String 8

高。

  • 取值范围:[8,4096]
  • 单位:px。
Timeline Object

动态水印。

Start String 0

水印开始出现时间。

  • 单位:秒。
  • 取值范围:数字
  • 默认值:0
Duration String ToEND

水印持续时间。

  • 取值范围:[数字,ToEND]
  • 默认值:ToEND
Name String example-watermark

水印模板名称。

Dy String 200

垂直偏移量。

  • 取值范围:[-4096,4096]
  • 单位:px。
Id String 3780bd69b2b74540bc7b1096f564****

水印模板ID。

RequestId String F8815A13-8B0A-4447-818C-D9A3B01F****

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateWaterMarkTemplate
&WaterMarkTemplateId=3780bd69b2b74540bc7b1096f564****
&Name=example-watermark
&Config={"Width":"10px","Height":"30px","Dx":"10px","Dy":"5px","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateWaterMarkTemplateResponse>
    <WaterMarkTemplate>
        <Type>Image</Type>
        <RatioRefer>
            <Dx>200</Dx>
            <Width>8</Width>
            <Height>8</Height>
            <Dy>200</Dy>
        </RatioRefer>
        <ReferPos>TopRight</ReferPos>
        <State>Normal</State>
        <Dx>200</Dx>
        <Width>8</Width>
        <Height>8</Height>
        <Timeline>
            <Start>0</Start>
            <Duration>ToEND</Duration>
        </Timeline>
        <Name>example-watermark</Name>
        <Dy>200</Dy>
        <Id>3780bd69b2b74540bc7b1096f564****</Id>
    </WaterMarkTemplate>
    <RequestId>F8815A13-8B0A-4447-818C-D9A3B01F****</RequestId>
</UpdateWaterMarkTemplateResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "WaterMarkTemplate" : {
    "Type" : "Image",
    "RatioRefer" : {
      "Dx" : "200",
      "Width" : "8",
      "Height" : "8",
      "Dy" : "200"
    },
    "ReferPos" : "TopRight",
    "State" : "Normal",
    "Dx" : "200",
    "Width" : "8",
    "Height" : "8",
    "Timeline" : {
      "Start" : "0",
      "Duration" : "ToEND"
    },
    "Name" : "example-watermark",
    "Dy" : "200",
    "Id" : "3780bd69b2b74540bc7b1096f564****"
  },
  "RequestId" : "F8815A13-8B0A-4447-818C-D9A3B01F****"
}

错误码

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