在一张图片的一个或多个特定区域内添加多种形状的马赛克、高斯模糊或纯色块,并将填充后的图片保存到指定的OSS文件对象地址。该功能主要用于隐私保护。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
imm:AddImageMosaic |
none |
*Project
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProjectName |
string |
是 |
项目名称,获取方式请参见创建项目。 |
test-project |
| SourceURI |
string |
是 |
源图片的 OSS 地址。 OSS 地址规则为 oss://${Bucket}/${Object},其中 支持的图片格式:jpg,png,tiff,jp2,bmp。 |
oss://examplebucket/sampleobject.jpg |
| TargetURI |
string |
是 |
输出图片存储的 OSS 地址。 OSS 地址规则为 oss://${Bucket}/${Object},其中 |
oss://examplebucket/outputImage.jpg |
| ImageFormat |
string |
否 |
图片保存时的编码格式。可取值为 jpg、png、webp,默认与输入图片编码格式相同。 枚举值:
|
jpg |
| Quality |
integer |
否 |
输出图片的压缩质量,仅限 jpg 和 webp 图片格式。设置范围为 0~100,默认为 80。 |
80 |
| Targets |
array<object> |
是 |
处理框及操作类别参数数组。 |
|
|
array<object> |
否 |
处理框及操作类别参数。 |
||
| Type |
string |
是 |
添加的马赛克类型。可取值如下:
|
square |
| Boundary |
object |
是 |
处理框位置信息。 |
|
| ReferPos |
string |
否 |
处理框在图片上的基准位置。可取值如下:
|
topleft |
| X |
number |
是 |
处理框相较于基准点的水平偏移,不同取值的含义如下:
|
0 |
| Y |
number |
是 |
处理框相较于基准点的垂直偏移,不同取值的含义如下:
|
0 |
| Height |
number |
是 |
处理框的高,不同取值的含义如下:
|
200 |
| Width |
number |
是 |
处理框的宽,不同取值的含义如下:
|
200 |
| MosaicRadius |
integer |
否 |
马赛克小块的半径大小。默认值为 5,单位为 px。 说明
该参数对于添加高斯模糊与纯色块不生效。 |
5 |
| BlurRadius |
integer |
否 |
高斯模糊的模糊半径,取值范围为 1~50,默认值为 3,单位为 px。 说明
该参数仅在添加高斯模糊时生效。 |
3 |
| Sigma |
integer |
否 |
高斯模糊的标准差,取值必须大于 0,默认值为 5。 说明
该参数仅在添加高斯模糊时生效。 |
5 |
| Color |
string |
否 |
纯色块的颜色,支持 说明
该参数仅在添加纯色块时生效。 |
#FFFFFF |
| CredentialConfig | CredentialConfig |
否 |
如无特殊需求,请保持留空即可。 链式授权配置,非必填。更多信息,请参见使用链式授权访问其他实体资源。 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
CA995EFD-083D-4F40-BE8A-BDF75FF***** |
示例
正常返回示例
JSON格式
{
"RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FF*****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。