文档首页> 数据安全中心 DSC> API参考> API说明> 图片水印> 图片嵌入暗水印(文件地址版本)
更新时间:2024-03-29 GMT+08:00

图片嵌入暗水印(文件地址版本)

功能介绍

对指定存储地址信息(目前支持OBS)的图片嵌入文字暗水印或者图片暗水印,已嵌入的水印的图片将存放在用户指定的位置(目前支持OBS),支持的图片格式为:*.jpg, *.jpeg, *.jpe, *.png, *.bmp, *.dib, *.rle, *.tiff, *.tif, *.ppm, *.webp, *.tga, *.tpic, *.gif。

URI

POST /v1/{project_id}/image-address/watermark/embed

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务“获取用户Token接口”获取(响应消息头中X-Subject-Token的值)

表3 请求Body参数

参数

是否必选

参数类型

描述

region_id

String

当前项目所在region的id,如:xx-xx-1。

src_file

String

待加暗水印的图片地址,当前只支持OBS文件,格式为 obs://bucket/object ,其中bucket为和当前项目处于同一区域的OBS桶名称,object为对象全路径名。例如:obs://hwbucket/hwinfo/hw.png,其中obs://表示OBS存储,hwbucket为桶名,hwinfo/hw.png为对象全路径名。

blind_watermark

String

待嵌入的文字暗水印内容,长度不超过32个字符。当前仅支持数字及英文大小写。与图片暗水印image_watermark二选一。

image_watermark

String

待嵌入的图片暗水印地址,格式要求同src_file字段,与文字暗水印 blind_watermark 二选一,都填写时,生效image_watermark。

dst_file

String

添加水印后的图片存放的地址,格式要求同src_file字段,不设置时,默认取src_file的值,即添加水印后覆盖原文件。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

region_id

String

当前项目所在region的id,如:xx-xx-1。

watermarked_file

String

添加水印后的OBS图片地址,当前只支持OBS文件,格式为 obs://bucket/object ,其中bucket为和当前项目处于同一区域的OBS桶名称,object为对象全路径名。例如:obs://hwbucket/hwinfo/hw.png,其中obs://表示OBS存储,hwbucket为桶名,hwinfo/hw.png为对象全路径名。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

在xx-xx-1区域,给obs://bucket/test.png路径下的图片嵌入testWaterMark的暗水印。

POST /v1/{project_id}/image-address/watermark/embed HTTP/1.1

{
  "region_id" : "xx-xx-1",
  "src_file" : "obs://bucket/test.png",
  "blind_watermark" : "testWaterMark"
}

响应示例

状态码: 200

请求成功

{
  "region_id" : "xx-xx-1",
  "watermarked_file" : "obs://bucket/test.png"
}

状态码: 400

无效请求

{
  "error_code" : "DSC.00000007",
  "error_msg" : "File format error"
}

状态码

状态码

描述

200

请求成功

400

无效请求

错误码

请参见错误码