调用UpdateWatermark更新水印数据。
说明 目前仅支持水印名称、水印配置的更新。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UpdateWatermark |
系统规定参数。取值:UpdateWatermark。 |
| Name | String | 是 | test |
水印名称。只支持中英文、数字。
|
| WatermarkId | String | 是 | af2afe4761992c*****bd947dae97337 |
水印ID。 |
| WatermarkConfig | String | 是 | {"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft","Type":"Image"} |
水印显示位置、效果等配置(JSON字符串):文字水印、图片水印。 说明 不同的水印类型对应不同的WatermarkConfig内容。参数结构详情,请参见WatermarkConfig。
|
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 25818875-5F78-4A*****F6-D7393642CA58 |
请求ID。 |
| WatermarkInfo | Object |
水印信息。 |
|
| CreationTime | String | 2018-11-06T08:03:17Z |
水印创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
| Type | String | Text |
水印类型。
|
| IsDefault | String | NotDefault |
是否是默认水印。
|
| FileUrl | String | https://outin-32****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW**** |
水印文件的URL(OSS地址或CDN地址),文字水印没有文件地址信息。 |
| WatermarkConfig | String | {"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft","Type":"Image"} |
水印显示位置、效果等配置(JSON字符串):文字水印、图片水印。 说明 不同的水印类型对应不同的WatermarkConfig内容。参数结构详情,请参见WatermarkConfig。
|
| Name | String | 图片水印测试 |
水印名称。 |
| WatermarkId | String | 505e2e287ea*****ecfddd386d384 |
水印ID。 |
示例
请求示例
https://vod.{ApiRegion}.aliyuncs.com/?Action=UpdateWatermark
&Name=test
&WatermarkConfig={"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft","Type":"Image"}
&WatermarkId=af2afe4761992c*****bd947dae97337
&<公共请求参数>
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<UpdateWatermarkResponse>
<RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
<WatermarkInfo>
<Name>图片水印测试</Name>
<CreationTime>2018-11-06T08:03:17Z</CreationTime>
<WatermarkId>505e2e287ea*****ecfddd386d384</WatermarkId>
<FileUrl>https://outin-32****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****</FileUrl>
<IsDefault>NotDefault</IsDefault>
<Type>Image</Type>
<WatermarkConfig>
<ReferPos>BottomRight</ReferPos>
<Height>55</Height>
<Width>55</Width>
<Dx>8</Dx>
<Dy>8</Dy>
</WatermarkConfig>
</WatermarkInfo>
</UpdateWatermarkResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "25818875-5F78-4A*****F6-D7393642CA58",
"WatermarkInfo" : {
"Name" : "图片水印测试",
"CreationTime" : "2018-11-06T08:03:17Z",
"WatermarkId" : "505e2e287ea*****ecfddd386d384",
"FileUrl" : "https://outin-32****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
"IsDefault" : "NotDefault",
"Type" : "Image",
"WatermarkConfig" : {
"ReferPos" : "BottomRight",
"Height" : "55",
"Width" : "55",
"Dx" : "8",
"Dy" : "8"
}
}
}
错误码
访问错误中心查看更多错误码。
SDK示例
建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: