使用UpdateWatermark接口修改图文水印模板-视频点播-阿里云-视频点播(VOD)-阿里云帮助中心

接口说明

调用 AddWatermark 添加图文水印模板后，可以调用本接口修改图文水印模板的名称和水印配置。
调用本接口暂不支持替换图片水印模板中的图片，也不支持跨模板类型（例如将图片水印模板改为文字水印模板）的修改。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

vod:UpdateWatermark

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Name	string	否	修改的水印模板名称。只支持中英文、数字。长度不超过 128 个字节。 UTF-8 编码。	test
WatermarkId	string	是	需要修改的图文水印模板 ID，仅支持传入单个水印模板 ID。可通过如下方式获取：调用 AddWatermark 接口添加图文水印模板后会返回。调用 ListWatermark 接口查询图文水印模板列表后会返回。	af2afe4761992c*****bd947dae97337
WatermarkConfig	string	是	图文水印的配置信息（JSON 字符串），包括水印显示位置、水印效果等配置。图片水印和文字水印的配置参数不同，参数结构详情，请参见 WatermarkConfig 。说明暂不支持跨模板类型修改，您可以调用 GetWatermark 接口查询水印模板所属类型后，再进行修改配置。	{"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottomLeft"}

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	25818875-5F78-4A*****F6-D7393642CA58
WatermarkInfo	object	水印模板信息。
CreationTime	string	水印模板的创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2018-11-06T08:03:17Z
Type	string	水印模板的类型。 Image：图片水印模板。 Text：文字水印模板。	Image
IsDefault	string	是否是默认图文水印模板： Default：默认图文水印模板。 NotDefault：非默认图文水印模板。	NotDefault
FileUrl	string	水印文件 URL（OSS 地址或 CDN 地址）。说明仅图片水印模板会返回此参数。	https://outin-32**9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=&Signature=gmf1eYMoDVg%2BHQCb4UGozBW**
WatermarkConfig	string	图文水印的配置信息（JSON 字符串），包括水印显示位置、水印效果等配置。图片水印和文字水印的配置参数不同，参数结构详情，请参见 WatermarkConfig 。	{"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottomLeft"}
Name	string	水印模板名称。	test
WatermarkId	string	水印模板 ID。	505e2e287ea*****ecfddd386d384

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfo": {
    "CreationTime": "2018-11-06T08:03:17Z",
    "Type": "Image",
    "IsDefault": "NotDefault",
    "FileUrl": "https://outin-32****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
    "WatermarkConfig": "{\"Width\":\"55\",\"Height\":\"55\",\"Dx\":\"9\",\"Dy\":\"9\",\"ReferPos\":\"BottomLeft\"}",
    "Name": "test",
    "WatermarkId": "505e2e287ea*****ecfddd386d384"
  }
}

错误码

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

变更历史

更多信息，参考变更详情。