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

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

功能介绍

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

调用方法

请参见如何调用API

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://hwbucket/test.png路径下的图片嵌入testWaterMark的暗水印。

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

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

响应示例

状态码: 200

请求成功

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

状态码: 400

无效请求

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

SDK代码示例

SDK代码示例如下。

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dsc.v1.region.DscRegion;
import com.huaweicloud.sdk.dsc.v1.*;
import com.huaweicloud.sdk.dsc.v1.model.*;


public class CreateImageWatermarkByAddressSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DscClient client = DscClient.newBuilder()
                .withCredential(auth)
                .withRegion(DscRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateImageWatermarkByAddressRequest request = new CreateImageWatermarkByAddressRequest();
        CreateImageWatermarkByAddressRequestBody body = new CreateImageWatermarkByAddressRequestBody();
        body.withBlindWatermark("testWaterMark");
        body.withSrcFile("obs://hwbucket/test.png");
        body.withRegionId("xx-xx-1");
        request.withBody(body);
        try {
            CreateImageWatermarkByAddressResponse response = client.createImageWatermarkByAddress(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdsc.v1.region.dsc_region import DscRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdsc.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = DscClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DscRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateImageWatermarkByAddressRequest()
        request.body = CreateImageWatermarkByAddressRequestBody(
            blind_watermark="testWaterMark",
            src_file="obs://hwbucket/test.png",
            region_id="xx-xx-1"
        )
        response = client.create_image_watermark_by_address(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dsc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dsc.NewDscClient(
        dsc.DscClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateImageWatermarkByAddressRequest{}
	blindWatermarkCreateImageWatermarkByAddressRequestBody:= "testWaterMark"
	request.Body = &model.CreateImageWatermarkByAddressRequestBody{
		BlindWatermark: &blindWatermarkCreateImageWatermarkByAddressRequestBody,
		SrcFile: "obs://hwbucket/test.png",
		RegionId: "xx-xx-1",
	}
	response, err := client.CreateImageWatermarkByAddress(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求成功

400

无效请求

错误码

请参见错误码