水印 · 金山云

文档中心 >

下载PDF文档

图片处理

水印

接口

imgWaterMarker

描述

金山云提供三种水印功能，包括文字水印、图片水印，以及多重水印。如果你拥有对图像文件的读权限，那么你可以对该图像添加水印。

通过添加水印，你可以制作个性的图片，或者标识图片来源以及版权信息。

权限

该接口操作需要具备GetObject权限，假如获取对象不存在，你可能存在以下两种返回：

假如用户具有该对象所在Bucket的ListBucket权限，会返回状态码404错误；
假如用户不具备该对象所在Bucket的ListBucket权限，会返回状态码403错误。

请求：

文字水印

语法

注意：接口格式不含任何空格与换行符，以下内容为了方便阅读做了格式化。

https://BucketName.kss.ksyun.com/object@base@
    tag=imgWaterMarker
    &type=2
    &text=<base64EncodeText>
    &font=<base64EncodeFont>
    &fontsize=<base64EncodeFontSize>
    &fill=<base64EncodeFill>
    &dissolve=<dissolve>
    &gravity=<gravity>
    &dx=<offsetX>
    &dy=<offsetY>   HTTP/1.1
Host: BucketName.kss.ksyun.com

请求参数

参数名称	必填	解释说明
tag	是	操作标志
type	是	type=2 文字水印
text	是	水印文字(base64EncodeText,经过URL安全的Base64编码)
font	否	文字水印字体(base64EncodeFont，经过URL安全的Base64编码)。默认为黑体
fontsize	否	字体大小(整形)，单位为缇(1缇=1/20磅),默认值500
fill	否	文字水印颜色(base64EncodeFill,经过URL安全的Base64编码)，可以是RGB格式，也可以是颜色名称(例如 black),还可以是十六进制(例如 ## FF0000),可以参考RGB对照表
dissolve		透明度。取值范围为1~100，默认值为100。100为完全不透明。
gravity		水印位置。可参考下面的水印锚点参数表，默认为SouthEast(右下方)。
dx		横轴(x轴)边距，单位为像素(px),默认值为10
dy		纵轴(y轴)边距，单位为像素(px),默认值为10
q	否	决定 jpg 图片的相对quality,对原图压缩。范围为0-100 , 0表示高压缩低质量，100表示低压缩，高质量。默认90

水印锚点参数列表

NorthWest	North	NorthEast
West	Center	East
SouthWest	South	SouthEast

请求头部

该请求不需要设置特殊的头部。

图像水印

语法

注意：接口格式不含任何空格与换行符，以下内容为了方便阅读做了格式化。

https://BucketName.kss.ksyun.com/object@base@
    tag=imgWaterMark  
    &type=1  
    &dissolve=<dissolve>  
    &gravity=<gravity>  
    &image=<base64EncodeImageURI>  
    &dx=<offsetX>  
    &dy=<offsetY>
    &wtw=<width>
    &wth=<height>   HTTP/1.1
Host: BucketName.kss.ksyun.com

请求参数

参数名称	必填	解释说明
tag	是	操作标志
type	是	type=1 为图片水印
image	是	水印源图片网址(base64EncodeImageURI,经过URL安全的Base64编码),必须保证此网址返回一张图片
dissolve		透明度。取值范围为1~100，默认值为100。100为完全不透明。
gravity		水印位置。可参考下面的水印锚点参数表，默认为SouthEast(右下方)。
dx		横轴(x轴)边距，单位为像素(px),默认值为10
dy		纵轴(y轴)边距，单位为像素(px),默认值为10
q	否	决定 jpg 图片的相对quality,对原图压缩。范围为0-100 , 0表示高压缩低质量，100表示低压缩，高质量。默认90
wtw	否	水印添加宽度阈值，小于该值将不进行图片水印操作，单位为像素(px)。范围为0以上的整数
wth	否	水印添加高度阈值，小于该值将不进行图片水印操作，单位为像素(px)。范围为0以上的整数

水印锚点参数列表

NorthWest	North	NorthEast
West	Center	East
SouthWest	South	SouthEast

请求头部

该请求不需要设置特殊的头部。

响应：

响应头部

头部名称	必填	说明
Content-Type	是	MIME类型，成功时为图片固定的MIME类型image/*，失败时为application/json

响应内容

如果请求处理成功，返回图片的二进制图片数据。

如果请求失败，则返回如下JSON格式的内容：

  {
      "errorCode": <HttpCode int>,
      "tipInfo": <ErrorTipInfo String>,
  }

特殊错误

HTTP状态码	含义
400	请求报文格式错误
404	资源不存在
403	访问拒绝
500	服务端操作失败。