文档

AddWatermark - 添加水印

调用AddWatermark添加水印数据。

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:AddWatermarkWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Typestring

水印类型:

  • Image(默认):图片。
  • Text:文字。
Text
Namestring

水印名称。仅支持中英文、数字。

  • 长度不超过 128 个字节。
  • UTF-8 编码。
水印
WatermarkConfigstring

水印显示位置、效果等配置信息(JSON 字符串):文字水印、图片水印。

说明 不同的水印类型对应不同的 WatermarkConfig 内容。参数结构详情,请参见 WatermarkConfig
{ "Width": "55", "Height": "55", "Dx": "9", "Dy": "9", "ReferPos": "BottomLeft", "Type": "Image" }
FileUrlstring

水印文件的 OSS 地址。图片水印必传。

http://outin-326268*****63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345*****E7FDEC-6-2.png
AppIdstring

应用 ID。默认取值:app-1000000。使用说明,请参见多应用

app-****
说明 水印文件上传,请参见 CreateUploadAttachedMedia

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

25818875-5F78-4A*****F6-D7393642CA58
WatermarkInfoobject

水印信息。

CreationTimestring

水印创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2018-11-07T09:05:52Z
Typestring

水印类型。

  • Image(默认):图片。
  • Text:文字。
Text
IsDefaultstring

是否是默认水印:

  • Default:默认水印。
  • NotDefault:非默认水印。
NotDefault
FileUrlstring

水印文件 URL(OSS 地址或 CDN 地址),文字水印没有文件地址信息。

https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****
WatermarkConfigstring

水印显示位置、效果等配置信息(JSON 字符串):文字水印、图片水印。

说明 不同的水印类型对应不同的 WatermarkConfig 内容。参数结构详情,请参见 WatermarkConfig
{"FontColor": "Blue","FontSize": 80, "Content": "水印测试" }
Namestring

水印名称。

文字水印测试
WatermarkIdstring

水印 ID。

9bcc8bfadb84*****109a2671d0df97

示例

正常返回示例

JSON格式

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

错误码

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

接口错误码

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

错误代码错误信息HTTP 状态码说明
NoSuchResourceThe specified resource %s does not exist.404用户相关的资源数据不存在,%s 表示具体资源信息。
  • 本页导读 (1)
文档反馈