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

文档嵌入水印(文件地址版本)

功能介绍

对WORD(.docx),PPT(.pptx),EXCEL(.xlsx),PDF(.pdf)*类型的文档嵌入文字暗水印、文字明水印或者图片明水印,用户传入待加水印的文档地址(目前支持OBS)和水印相关信息,DSC服务对文档加完水印后返回给用户已嵌入水印的文档的存放地址。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/doc-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为对象全路径名。

doc_type

String

待嵌入水印的文档类型。

枚举值:

  • WORD

  • EXCEL

  • PDF

  • PPT

dst_file

String

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

blind_watermark

String

暗文字水印内容,与“visible_watermark”字段至少有一个不为空

visible_watermark

String

明文字水印内容,与暗水印“blind_watermark”字段至少有一个不为空。

image_mark

String

待嵌入的图形明水印文件的地址, 字段格式要求同src_file字段,图形文件的格式必须为“png”或“jpg”,否则返回参数错误;图像文件大小不超过1MB

visible_type

String

该字段控制明水印嵌入文字还是图片。默认为TEXT类型,需填写visible_watermark字段设置明文字水印; 当该字段为IMAGE时,需填写image_watermark字段设置水印图片地址此时 ,“visible_watermark”,“font_size”,“rotation”和“opacity”字段无效。

枚举值:

  • TEXT

  • IMAGE

file_password

String

待加水印文件有密码时,读取文件的密码, 最大支持长度256。如果Office文档有读密码或域控的权限密码,请输入读密码,或者有读权限的域控密码。

marked_file_password

String

添加水印后给文件设置密码, 最大支持长度256。默认不加文档密码。

readonly_password

String

添加水印后给文件设置只读密码, 最大支持长度256。默认不加只读密码。

front

Integer

明水印字体大小,取值为[1,100],默认值50

rotation

Integer

明水印旋转角度,逆时针方向,取值为[0,90],默认值45。

opacity

Float

明水印的透明度,取值[0,1],默认值为0.3;

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

region_id

String

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

watermarked_file

String

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

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

给obs://hwbucket/hwinfo/hw.doc路径下的WORD文档嵌入blind_watermark的明水印和visible_watermark的暗水印。

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

{
  "region_id" : "xx-xx-1",
  "src_file" : "obs://hwbucket/hwinfo/hw.doc",
  "doc_type" : "WORD",
  "blind_watermark" : "blind_watermark",
  "visible_watermark" : "visible_watermark"
}

响应示例

状态码: 200

请求成功

{
  "region_id" : "xx-xx-1",
  "watermarked_file" : "obs://hwbucket/hwinfo/hw.docx"
}

状态码: 400

无效请求

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

SDK代码示例

SDK代码示例如下。

给obs://hwbucket/hwinfo/hw.doc路径下的WORD文档嵌入blind_watermark的明水印和visible_watermark的暗水印。

 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
51
52
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 CreateDocWatermarkByAddressSolution {

    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();
        CreateDocWatermarkByAddressRequest request = new CreateDocWatermarkByAddressRequest();
        CreateDocWatermarkByAddressRequestBody body = new CreateDocWatermarkByAddressRequestBody();
        body.withVisibleWatermark("visible_watermark");
        body.withBlindWatermark("blind_watermark");
        body.withDocType(CreateDocWatermarkByAddressRequestBody.DocTypeEnum.fromValue("WORD"));
        body.withSrcFile("obs://hwbucket/hwinfo/hw.doc");
        body.withRegionId("xx-xx-1");
        request.withBody(body);
        try {
            CreateDocWatermarkByAddressResponse response = client.createDocWatermarkByAddress(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());
        }
    }
}

给obs://hwbucket/hwinfo/hw.doc路径下的WORD文档嵌入blind_watermark的明水印和visible_watermark的暗水印。

 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
# 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 = CreateDocWatermarkByAddressRequest()
        request.body = CreateDocWatermarkByAddressRequestBody(
            visible_watermark="visible_watermark",
            blind_watermark="blind_watermark",
            doc_type="WORD",
            src_file="obs://hwbucket/hwinfo/hw.doc",
            region_id="xx-xx-1"
        )
        response = client.create_doc_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)

给obs://hwbucket/hwinfo/hw.doc路径下的WORD文档嵌入blind_watermark的明水印和visible_watermark的暗水印。

 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
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.CreateDocWatermarkByAddressRequest{}
	visibleWatermarkCreateDocWatermarkByAddressRequestBody:= "visible_watermark"
	blindWatermarkCreateDocWatermarkByAddressRequestBody:= "blind_watermark"
	request.Body = &model.CreateDocWatermarkByAddressRequestBody{
		VisibleWatermark: &visibleWatermarkCreateDocWatermarkByAddressRequestBody,
		BlindWatermark: &blindWatermarkCreateDocWatermarkByAddressRequestBody,
		DocType: model.GetCreateDocWatermarkByAddressRequestBodyDocTypeEnum().WORD,
		SrcFile: "obs://hwbucket/hwinfo/hw.doc",
		RegionId: "xx-xx-1",
	}
	response, err := client.CreateDocWatermarkByAddress(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求成功

400

无效请求

错误码

请参见错误码