AddWatermark - 添加水印 - 视频点播

调用AddWatermark添加水印数据。

接口说明

说明目前支持的图片水印格式包括*静态（PNG）、动态（GIF、APNG、MOV）。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Type	string	是	水印类型： Image（默认）：图片。 Text：文字。	Text
Name	string	是	水印名称。仅支持中英文、数字。长度不超过128个字节。 UTF-8编码。	水印
WatermarkConfig	string	是	水印显示位置、效果等配置信息（JSON字符串）：文字水印、图片水印。说明不同的水印类型对应不同的WatermarkConfig内容。参数结构详情，请参见WatermarkConfig 。	{"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft","Type":"Image"}
FileUrl	string	否	水印文件的OSS地址。图片水印必传。	http://outin-326268***63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345***E7FDEC-6-2.png
AppId	string	否	应用ID。默认取值：app-1000000。使用说明，请参见多应用。	app-****

说明水印文件上传，请参见CreateUploadAttachedMedia。

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求ID。	25818875-5F78-4A*****F6-D7393642CA58
WatermarkInfo	object	水印信息。
CreationTime	string	水印创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。	2018-11-07T09:05:52Z
Type	string	水印类型。 Image（默认）：图片。 Text：文字。	Text
IsDefault	string	是否是默认水印： Default：默认水印。 NotDefault：非默认水印。	NotDefault
FileUrl	string	水印文件URL（OSS地址或CDN地址），文字水印没有文件地址信息。	https://outin-3262***9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=&Signature=gmf1eYMoDVg%2BHQCb4UGozBW**
WatermarkConfig	string	水印显示位置、效果等配置信息（JSON字符串）：文字水印、图片水印。说明不同的水印类型对应不同的WatermarkConfig内容。参数结构详情，请参见WatermarkConfig 。	{"FontColor": "Blue","FontSize": 80, "Content": "水印测试" }
Name	string	水印名称。	文字水印测试
WatermarkId	string	水印ID。	9bcc8bfadb84*****109a2671d0df97

示例

请求示例

https://vod.{ApiRegion}.aliyuncs.com/?Action=AddWatermark
&Name=水印
&Type=Text
&WatermarkConfig={"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft","Type":"Image"}
&<公共请求参数>

正常返回示例

JSON格式

{
	"RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
	"WatermarkInfo": {
		"IsDefault": "NotDefault",
		"FileUrl": "https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
		"Type": "Text",
		"WatermarkId": "9bcc8bfadb84*****109a2671d0df97",
		"CreationTime": "2018-11-07T09:05:52Z",
		"WatermarkConfig": "{\"FontColor\": \"Blue\",\"FontSize\": 80, \"Content\": \"水印测试\" }",
		"Name": "文字水印测试"
	}
}

XML格式

<AddWatermarkResponse>
<RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
<WatermarkInfo>
    <IsDefault>NotDefault</IsDefault>
    <FileUrl>https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&amp;OSSAccessKeyId=****&amp;Signature=gmf1eYMoDVg%2BHQCb4UGozBW****</FileUrl>
    <Type>Text</Type>
    <WatermarkId>9bcc8bfadb84*****109a2671d0df97</WatermarkId>
    <CreationTime>2018-11-07T09:05:52Z</CreationTime>
    <WatermarkConfig>{"FontColor": "Blue","FontSize": 80, "Content": "水印测试" }</WatermarkConfig>
    <Name>文字水印测试</Name>
</WatermarkInfo>
</AddWatermarkResponse>

错误码

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

接口错误码

下表列举了本接口特有的错误码。

错误代码	错误信息	HTTP 状态码	说明
NoSuchResource	The specified resource %s does not exist.	404	用户相关的资源数据不存在，%s表示具体资源信息。