嵌入文档水印 - CreateDocWatermark
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/sdg/doc/watermark/embed
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识用户所属的项目,实现权限控制和资源隔离。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 长度为32个字符 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| doc_type | 是 | String | 参数解释: 文档类型,指定待处理文档的文件格式 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| visible_type | 否 | String | 参数解释: 可见水印类型,指定可见水印的表现形式 约束限制: 不涉及 取值范围: 默认取值: TEXT |
| visible_watermark | 否 | String | 参数解释: 文字可见水印,可见水印的文字内容 约束限制: 当visible_type为TEXT时必填 取值范围: 字符串类型,支持中文、英文字母、数字,长度1~256个字符 默认取值: 不涉及 |
| blind_watermark | 否 | String | 参数解释: 盲水印,嵌入文档中的不可见水印内容 约束限制: 可选 取值范围: 字符串类型,长度1~256个字符 默认取值: 不涉及 |
| file_password | 否 | String | 参数解释: 文件密码,用于解密受保护的待处理文档 约束限制: 可选 取值范围: 字符串类型,长度1~256个字符 默认取值: 不涉及 |
| marked_file_password | 否 | String | 参数解释: 加水印后文件的密码 约束限制: 可选 取值范围: 字符串类型,长度1~256个字符 默认取值: 不涉及 |
| readonly_password | 否 | String | 参数解释: 只读密码,用于设置文档的只读保护 约束限制: 可选 取值范围: 字符串类型,长度1~256个字符 默认取值: 不涉及 |
| opacity | 否 | Float | 参数解释: 水印透明度,水印的不透明程度 约束限制: 当visible_type为IMAGE时该字段无效 取值范围: 0~1.0 默认取值: 0.3 |
| font_size | 否 | Integer | 参数解释: 水印字体大小,单位px 约束限制: 当visible_type为IMAGE时该字段无效 取值范围: 1~100 默认取值: 50 |
| rotation | 否 | Integer | 参数解释: 水印旋转角度 约束限制: 当visible_type为IMAGE时该字段无效 取值范围: 0~90 默认取值: 45 |
| sparse_degree | 否 | Integer | 参数解释: 水印稀疏度 约束限制: 不涉及 取值范围: 0~100 默认取值: 0 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| file | 是 | File | 参数解释: 待加水印文档文件 约束限制: 必填,格式须与doc_type匹配,支持PDF、DOCX、XLSX等文档格式,文件大小存在上限限制 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| - | File | 参数解释: 加水印后的文件流,以二进制文件形式返回 取值范围: 不涉及 |
请求示例
向PDF文档中嵌入可见水印"机密"和盲水印。
/v1/2b31ed520abcd1234ebedb6e57123456/sdg/doc/watermark/embed?doc_type=PDF&visible_type=TEXT&visible_watermark=机密
响应示例
状态码:200
{
"description" : "返回加水印后的文件流"
} SDK代码示例
SDK代码示例如下。
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 | 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 CreateDocWatermarkSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DscClient client = DscClient.newBuilder() .withCredential(auth) .withRegion(DscRegion.valueOf("<YOUR REGION>")) .build(); CreateDocWatermarkRequest request = new CreateDocWatermarkRequest(); try { CreateDocWatermarkResponse response = client.createDocWatermark(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()); } } } |
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 | # 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DscClient.new_builder() \ .with_credentials(credentials) \ .with_region(DscRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateDocWatermarkRequest() response = client.create_doc_watermark(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 | 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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dsc.DscClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dsc.NewDscClient(hcClient) request := &model.CreateDocWatermarkRequest{} response, err := client.CreateDocWatermark(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。