You need to enable JavaScript to run this app.
导航
添加盲水印
最近更新时间:2024.08.05 18:26:09首次发布时间:2022.09.14 20:05:53

本接口支持指定服务以及原图后,将自定义的文字盲水印等信息嵌入原图并获取结果图 URI。

说明

该接口属于历史版本 API,建议您使用新版 CreateImageHmEmbed 接口。

注意

请在原图完成全部图片处理操作(如裁剪、缩放、画质增强等)之后再添加盲水印,以免影响水印的稳定性导致无法正常提取水印。

注意事项

  • 请求频率:单用户请求频率限制为 5 次/秒
  • 超时时间:约为 20 秒
  • 计费说明:盲水印功能属于附加组件下智能处理模块,属于后付费计费,使用后会产生附加组件智能处理费用
  • 前提条件:请确保已开通智能处理计费配置
  • 使用限制:使用组件前,请先确认盲水印使用限制
  • 服务地址:veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求说明

  • 请求方式:POST
  • 请求地址:https://imagex.volcengineapi.com/?Action=CreateImageHmEmbed&Version=2018-08-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数

Query

参数类型是否必选示例值描述
ActionStringCreateImageHmEmbed接口名称。当前 API 的名称为 CreateImageHmEmbed
VersionString2018-08-01接口版本。当前 API 的版本为 2018-08-01

Body

参数类型是否必选示例值描述

ServiceId

String

oz***y2

服务 ID。

  • 您可以在 veImageX 控制台 服务管理页面,在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息
StoreUriStringtos-boe-i-oz***y2/cf***9d.jpg待添加盲水印的原图 Uri。当 StoreUriImageUrl 均不为空,以 StoreUri 取值为准。
ImageUrlStringhttps://test.com/example.png待添加盲水印的可公网访问原图 Url。当 StoreUriImageUrl 均不为空,以 StoreUri 取值为准。

Algorithm

String

default

算法模型,取值如下所示:

  • default:文本嵌入基础模型,适用于图片体积增加或画质变化较敏感且水印图不涉及二次编辑的场景,该模型对原图的体积和画质影响最小。。
  • adapt_resize:画质自适应文本嵌入模型,适用于图片大规模搬运取证场景,具备较好的抗图片缩放、压缩攻击。
  • adapt:文本嵌入自适应模型(AIGC 适用),对画质影响较低,可以抵抗一定程度的分辨率缩放、裁剪、画质压缩等攻击。
  • natural: 文本嵌入基础模型(彩色图片通用),适用于图片画质要求不高的原图添加盲水印场景(不建议应用在纯色图片场景),可以抵抗一定程度的图片裁剪和缩放操作,但对画质会产生一定程度影响。建议使用时设置水印强度为中/高强度。
InfoString你好 abc123%^$%自定义盲水印文本内容,最大支持 128 个字符。
OutFormatStringpng输出图片格式,默认 png,支持图片格式有:pngjpegwebp

OutQuality

Integer

75

输出图片质量参数。取值范围为 [1,100],默认为 75。 对于 PNG 无损压缩,其他格式下其值越小,压缩率越高,画质越差。

根据所选的盲水印模型和结果图输出格式,图片质量参数的建议值如下所示。

  • 指定 Algorithm = default

    • OutFormat = png时,建议OutQuality75

    • OutFormat = jpeg时,建议OutQuality80

    • OutFormat = webp时,建议OutQuality = 100

  • 指定 Algorithm = adapt_resize

    • OutFormat = png/jpeg/webp时,建议OutQuality75
  • 指定 Algorithm = adapt

    • OutFormat = png时,建议OutQuality75

    • OutFormat = jpeg时,建议OutQuality78

    • OutFormat = webp时,建议OutQuality90

  • 指定 Algorithm = natural

    • OutFormat = png/jpeg时,建议OutQuality75

    • OutFormat = webp时,建议OutQuality90

您也可根据业务场景适时调整,查看不同参数下处理效果。

StrengthLevel

String

strong

算法强度,强度越高,图像抵抗攻击性能越强。取值如下所示:

  • low:低强度,适用于纯色图场景以及对图像质量要求高;
  • medium:(默认)中强度;
  • strong:高强度,适合图像纹理丰富时使用。
    若 Strength 和 StrengthLevel均不为空,则以 Strength 取值为准。

Strength

Integer

10

说明

仅当 Algorithm 取值为 default/adapt_resize配置有效。

算法强度,取值范围为[10,100]。取值越高,图像抵抗攻击性能越强。

  • StrengthStrengthLevel均不为空,则以 Strength 取值为准。
  • StrengthStrengthLevel均为空,则选取 StrengthLevel 的默认值。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数

参数类型示例值描述
StoreUriStringtos-boe-i-oz***y2/9b***76添加盲水印后的结果图 Uri。您可使用结果图 URI(即 StoreUri拼接完整访问 URL 后,在浏览器查看处理效果。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageHmEmbed&Version=2018-08-01

{
  "ServiceId": "oz***y2",
  "StoreUri": "tos-boe-i-oz***y2/cf***9d.jpg",
  "Info": "你好 abc123%^$%",
  "OutFormat": "png",
  "StrengthLevel": "strong",
  "Algorithm": "default"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2022082316404301017425518104A49986",
    "Action": "CreateImageHmEmbed",
    "Version": "2018-08-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
    "StoreUri": "tos-boe-i-oz***y2/9b***76"
  }
}

错误码

访问公共错误码以及通用错误码获取详细信息。

服务端 SDK

为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示: