嵌入图片水印-按地址 - CreateImageWatermarkByAddress
功能介绍
功能介绍:嵌入图片水印-byAddress
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/image-address/watermark/embed
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| region_id | 否 | String | 参数解释: 图片水印按地址ID 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| src_file | 否 | String | 参数解释: 源文件 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| is_visible_mark | 否 | Boolean | 参数解释: 是否可见水印 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| is_blind_mark | 否 | Boolean | 参数解释: 是否盲水印 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| blind_watermark | 否 | String | 参数解释: 盲水印 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| image_watermark | 否 | String | 参数解释: 图片水印 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| dst_file | 否 | String | 参数解释: 目标文件 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| visible_watermark_type | 否 | String | 参数解释: 可见水印类型 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| visible_text_watermark | 否 | String | 参数解释: 可见文字水印 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| visible_image_watermark | 否 | String | 参数解释: 可见图片水印 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| visible_watermark_position | 否 | String | 参数解释: 可见水印位置 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| offset_x | 否 | Integer | 参数解释: X轴偏移量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| offset_y | 否 | Integer | 参数解释: Y轴偏移量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| opacity | 否 | Integer | 参数解释: 不透明度 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| watermark_size | 否 | Integer | 参数解释: 图片水印按地址大小 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| text_rotation | 否 | Integer | 参数解释: 文字旋转角度 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| text_color | 否 | Integer | 参数解释: 文字颜色 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| region_id | String | 参数解释: 图片水印嵌入按地址响应ID 取值范围: 不涉及 |
| watermarked_file | String | 参数解释: 嵌入水印后的图片文件地址 取值范围: 不涉及 |
请求示例
嵌入图片水印-按地址请求体
{
"region_id" : "cn-north-4",
"src_file" : "obs://dsc-watermark-bucket/src/financial-report.png",
"is_visible_mark" : true,
"is_blind_mark" : true,
"blind_watermark" : "asset-owner-001",
"image_watermark" : "obs://dsc-watermark-bucket/logo/company-logo.png",
"dst_file" : "obs://dsc-watermark-bucket/dst/financial-report-watermarked.png",
"visible_watermark_type" : "TEXT",
"visible_text_watermark" : "internal-use-only",
"visible_image_watermark" : "obs://dsc-watermark-bucket/logo/visible-logo.png",
"visible_watermark_position" : "BOTTOM_RIGHT",
"offset_x" : 10,
"offset_y" : 10,
"opacity" : 0.8,
"watermark_size" : 24,
"text_rotation" : 45,
"text_color" : 8421504
} 响应示例
状态码:200
{
"region_id" : "cn-north-4",
"watermarked_file" : "obs://dsc-watermark-bucket/dst/financial-report-watermarked.png"
} SDK代码示例
SDK代码示例如下。
Java
嵌入图片水印-按地址请求体
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 | 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.withDstFile("obs://dsc-watermark-bucket/dst/financial-report-watermarked.png"); body.withImageWatermark("obs://dsc-watermark-bucket/logo/company-logo.png"); body.withBlindWatermark("asset-owner-001"); body.withSrcFile("obs://dsc-watermark-bucket/src/financial-report.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
嵌入图片水印-按地址请求体
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 | # 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( dst_file="obs://dsc-watermark-bucket/dst/financial-report-watermarked.png", image_watermark="obs://dsc-watermark-bucket/logo/company-logo.png", blind_watermark="asset-owner-001", src_file="obs://dsc-watermark-bucket/src/financial-report.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
嵌入图片水印-按地址请求体
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 56 57 58 59 | 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{} dstFileCreateImageWatermarkByAddressRequestBody:= "obs://dsc-watermark-bucket/dst/financial-report-watermarked.png" imageWatermarkCreateImageWatermarkByAddressRequestBody:= "obs://dsc-watermark-bucket/logo/company-logo.png" blindWatermarkCreateImageWatermarkByAddressRequestBody:= "asset-owner-001" request.Body = &model.CreateImageWatermarkByAddressRequestBody{ DstFile: &dstFileCreateImageWatermarkByAddressRequestBody, ImageWatermark: &imageWatermarkCreateImageWatermarkByAddressRequestBody, BlindWatermark: &blindWatermarkCreateImageWatermarkByAddressRequestBody, SrcFile: "obs://dsc-watermark-bucket/src/financial-report.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 | 嵌入图片水印-byAddress成功 |
错误码
请参见错误码。