文档中心

创建盲水印前背景图层

最近更新时间：2024.04.19 11:10:56

首次发布时间：2023.12.15 19:59:57

本接口支持生成含有盲水印的 png 格式透明图，适用于纯色背景网页被截图外发后进行截图者身份溯源场景。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：超时时间约为 30 秒。
前提条件：已开通盲水印组件能力。
计费说明：盲水印功能属于增值服务项，故使用后会产生增值服务费用，详情请见后付费。
可添加盲水印的图片最小尺寸限制：320 * 192
提取水印说明：
- 提取水印的图片需为已添加该模型水印的纯色背景网页的截图。
- 经裁剪后仍可提取水印的原图最小尺寸限制为 320 * 192。
- 原图抗分辨率缩放攻击范围为 0.5~2。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=CreateHiddenWatermarkImage&Version=2023-05-01

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

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

Action String 是 CreateHiddenWatermarkImage 接口名称。当前 API 的名称为 CreateHiddenWatermarkImage。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateHiddenWatermarkImage`	接口名称。当前 API 的名称为 `CreateHiddenWatermarkImage`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`h1**0k`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

h1**0k

服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

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

Algorithm String 是 tracev1 获取盲水印图的算法模型，仅支持取值 tracev1。该模型可以生成带有水印的透明图像，但仅适用于纯色网页泄露溯源场景。该模型可有效抵抗常见的社交软件传播。然而，该算法对页面背景色的影响相对较大，因此不适合用于保护多彩页面或图片，例如商品页面。

参数	类型	是否必选	示例值	描述
Algorithm	String	是	`tracev1`	获取盲水印图的算法模型，仅支持取值 `tracev1`。该模型可以生成带有水印的透明图像，但仅适用于纯色网页泄露溯源场景。该模型可有效抵抗常见的社交软件传播。然而，该算法对页面背景色的影响相对较大，因此不适合用于保护多彩页面或图片，例如商品页面。
Strength	String	是	`medium`	盲水印强度，取值如下所示： `low`：低强度，适用于对图像质量要求高。 `medium`：中强度 `strong`：高强度，适合图像纹理丰富时使用。
Info	String	是	`你好`	自定义盲水印文本信息，最大支持 128 个字符。

Strength

String

是

medium

盲水印强度，取值如下所示：

low：低强度，适用于对图像质量要求高。
medium：中强度
strong：高强度，适合图像纹理丰富时使用。

Info String 是 你好 自定义盲水印文本信息，最大支持 128 个字符。

返回参数

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

参数	类型	示例值	描述
StoreUri	String	`tos-cn-i-h1**0k-example.png`	盲水印图片 Uri，当前仅支持输出 png 格式。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateHiddenWatermarkImage&Version=2023-05-01&ServiceId=h1**0k

{
    "Algorithm": "tracev1",
    "Strength": "low",
    "Info": "你好"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "CreateHiddenWatermarkImage",
        "Version": "2023-05-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "StoreUri": "tos-cn-i-h1**0k-example.png"
    }
}

错误码

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

服务端 SDK

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