按地址嵌入图片水印 - CreateImageWatermarkByAddress
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/image-address/watermark/embed
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识用户所属的项目,实现权限控制和资源隔离。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 长度为32个字符 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| region_id | 是 | String | 参数解释: 区域ID,用于指定文件所在OBS服务的区域。获取方法请参见获取区域列表。 约束限制: 必填 取值范围: 格式为xx-xx-1,由小写字母、数字和连字符组成,长度1~64个字符 默认取值: 不涉及 |
| src_file | 是 | String | 参数解释: 源图片地址,待处理图片文件在OBS上的存储路径 约束限制: 必填 取值范围: 格式为obs://bucket-name/object-key,字符串长度1~2048个字符 默认取值: 不涉及 |
| is_visible_mark | 否 | Boolean | 参数解释: 是否嵌入明水印 约束限制: 不涉及 取值范围: true false 默认取值: 不涉及 |
| is_blind_mark | 否 | Boolean | 参数解释: 是否嵌入暗水印 约束限制: 不涉及 取值范围: true false 默认取值: 不涉及 |
| blind_watermark | 否 | String | 参数解释: 文字暗水印,嵌入图片中的不可见文字水印 约束限制: 仅支持英文数字,长度不超过32字符 取值范围: 字符串类型,仅支持英文字母和数字,长度1~32个字符 默认取值: 不涉及 |
| image_watermark | 否 | String | 参数解释: 图片暗水印地址,暗水印图片文件在OBS上的存储路径 约束限制: 仅支持png/jpg 取值范围: 格式为obs://bucket-name/object-key,字符串长度1~2048个字符 默认取值: 不涉及 |
| dst_file | 否 | String | 参数解释: 加水印后图片地址 约束限制: 可选,不填则覆盖源文件 取值范围: 不涉及 默认取值: 不涉及 |
| visible_watermark_type | 否 | String | 参数解释: 明水印类型 约束限制: 不涉及 取值范围: TEXT-文字水印,IMAGE-图片水印 默认取值: 不涉及 |
| visible_text_watermark | 否 | String | 参数解释: 文字明水印 约束限制: 仅支持中英文数字,长度不超过32字符 取值范围: 不涉及 默认取值: 不涉及 |
| visible_image_watermark | 否 | String | 参数解释: 图片明水印地址 约束限制: 当visible_watermark_type为IMAGE时必填 取值范围: 不涉及 默认取值: 不涉及 |
| visible_watermark_position | 否 | String | 参数解释: 明水印位置 约束限制: 不涉及 取值范围: TL-左上角,TOP-上方,TR-右上角,LEFT-左边,CENTER-正中,RIGHT-右边,BL-左下角,BOTTOM-下方,BR-右下角 默认取值: 不涉及 |
| offset_x | 否 | Integer | 参数解释: X轴偏移 约束限制: 不涉及 取值范围: 0~100 默认取值: 不涉及 |
| offset_y | 否 | Integer | 参数解释: Y轴偏移 约束限制: 不涉及 取值范围: 0~100 默认取值: 不涉及 |
| opacity | 否 | Integer | 参数解释: 水印不透明度 约束限制: 不涉及 取值范围: 0~100 默认取值: 50 |
| watermark_size | 否 | Integer | 参数解释: 水印尺寸百分比 约束限制: 文字水印最小为1 取值范围: 0~100 默认取值: 50 |
| text_rotation | 否 | Integer | 参数解释: 水印旋转角度 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| text_color | 否 | Integer | 参数解释: 水印颜色值 约束限制: 不涉及 取值范围: 0~16777215 默认取值: 不涉及 |
| src_bucket_credential | 否 | Credential object | 参数解释: 源桶临时凭证 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| dst_bucket_credential | 否 | Credential object | 参数解释: 目标桶临时凭证 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| visible_watermark_bucket_credential | 否 | Credential object | 参数解释: 明水印桶临时凭证 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| blind_watermark_bucket_credential | 否 | Credential object | 参数解释: 盲水印桶临时凭证 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| region_id | String | 参数解释: 区域ID,用于标识文件所在OBS服务的区域 取值范围: 格式为xx-xx-1,由小写字母、数字和连字符组成,长度1~64个字符 |
| watermarked_file | String | 参数解释: 加水印后的图片文件在OBS上的存储地址 取值范围: 格式为obs://bucket/object |
请求示例
对OBS地址中的图片嵌入明水印和暗水印。
{
"region_id" : "cn-north-4",
"src_file" : "obs://bucket/src.png",
"is_visible_mark" : true,
"is_blind_mark" : true,
"visible_text_watermark" : "机密",
"blind_watermark" : "blind-demo"
} 响应示例
状态码:200
{
"region_id" : "cn-north-4",
"watermarked_file" : "obs://bucket/dst.png"
} SDK代码示例
SDK代码示例如下。
Java
对OBS地址中的图片嵌入明水印和暗水印。
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 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"); 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(); CreateImageWatermarkByAddressRequest request = new CreateImageWatermarkByAddressRequest(); CreateImageWatermarkByAddressRequestBody body = new CreateImageWatermarkByAddressRequestBody(); body.withBlindWatermark("blind-demo"); body.withSrcFile("obs://bucket/src.png"); body.withRegionId("cn-north-4"); 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()); } } } |
Python
对OBS地址中的图片嵌入明水印和暗水印。
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 | # 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 = CreateImageWatermarkByAddressRequest() request.body = CreateImageWatermarkByAddressRequestBody( blind_watermark="blind-demo", src_file="obs://bucket/src.png", region_id="cn-north-4" ) 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) |
Go
对OBS地址中的图片嵌入明水印和暗水印。
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 53 54 55 | 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.CreateImageWatermarkByAddressRequest{} blindWatermarkCreateImageWatermarkByAddressRequestBody:= "blind-demo" request.Body = &model.CreateImageWatermarkByAddressRequestBody{ BlindWatermark: &blindWatermarkCreateImageWatermarkByAddressRequestBody, SrcFile: "obs://bucket/src.png", RegionId: "cn-north-4", } response, err := client.CreateImageWatermarkByAddress(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。