嵌入图片水印预览-按地址 - CreateImageWatermarkV2PreviewByAddress
功能介绍
功能介绍:嵌入图片水印预览-byAddress
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/image-address/watermark/embed-preview
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| region_id | 否 | String | 参数解释: 区域ID,用于指定水印处理所需资源所在的地域,可通过查询云服务区域列表接口获取 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| src_file | 否 | String | 参数解释: 源文件,需要嵌入水印的原始图片文件路径或地址(如obs://桶/路径/文件名),支持PNG、JPG等常见图片格式 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| is_visible_mark | 否 | Boolean | 参数解释: 是否可见水印 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| is_blind_mark | 否 | Boolean | 参数解释: 是否盲水印 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| blind_watermark | 否 | String | 参数解释: 盲水印文本内容,当is_blind_mark为True时有效,作为嵌入图片的盲水印信息 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| image_watermark | 否 | String | 参数解释: 图片水印,盲水印所使用的图片水印数据,支持base64编码或文件路径格式 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| dst_file | 否 | String | 参数解释: 目标文件,嵌入水印后输出图片的文件路径或地址(如obs://桶/路径/文件名) 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| visible_watermark_type | 否 | String | 参数解释: 可见水印类型,指定可见水印的类型,可取文字水印或图片水印,与visible_text_watermark、visible_image_watermark参数对应使用 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| visible_text_watermark | 否 | String | 参数解释: 可见文字水印,当visible_watermark_type为文字水印类型时,此参数指定水印文字内容 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| visible_image_watermark | 否 | String | 参数解释: 可见图片水印,当visible_watermark_type为图片水印类型时,此参数指定水印图片数据,支持base64编码或文件路径格式 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| visible_watermark_position | 否 | String | 参数解释: 可见水印位置,指定水印在图片中的放置位置,如左上角、居中、右下角等 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| offset_x | 否 | Integer | 参数解释: X轴偏移量,水印内容相对定位基准点在X轴方向的偏移距离,单位为像素(px) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| offset_y | 否 | Integer | 参数解释: Y轴偏移量,水印内容相对定位基准点在Y轴方向的偏移距离,单位为像素(px) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| opacity | 否 | Integer | 参数解释: 不透明度,控制可见水印内容的透明程度,取值范围0~100,以百分比(%)表示 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| watermark_size | 否 | Integer | 参数解释: 水印大小,控制可见水印文字的尺寸,单位为像素(px) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| text_rotation | 否 | Integer | 参数解释: 文字旋转角度,可见水印文字相对于水平方向的旋转角度(°) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| text_color | 否 | Integer | 参数解释: 文字颜色,以RGB整数值表示,如16777215表示白色 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
请求示例
嵌入图片水印预览-按地址请求体
{
"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" : 80,
"watermark_size" : 24,
"text_rotation" : 45,
"text_color" : 8421504
} 响应示例
状态码:200
{
"status" : "success",
"msg" : "嵌入图片水印预览-按地址成功",
"id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 嵌入图片水印预览-byAddress成功 |
错误码
请参见错误码。