文档中心

使用图像降噪获取结果图

最近更新时间：2024.02.02 17:54:28

首次发布时间：2022.10.12 11:42:27

本接口支持通过指定服务 ID 以及降噪配置，获取降噪结果图。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：超时时间约为 50 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=GetDenoisingImage&Version=2018-08-01

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetDenoisingImage`	接口名称。当前 API 的名称为 `GetDenoisingImage`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	`8j**ji`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	示例值	描述
StoreUri	String	否	`tos-i-t3***nr/0866d.jpg`	待降噪的原图 URI。若同时传入 StoreUri 和 ImageUrl，仅取值 StoreUri，ImageUrl 将会被忽略。
ImageUrl	String	否	`http://test/tos-i-t3*nr/0866d.jpg~tplv-t3nr-1.png`	公网可访问的待降噪的原图 URL。
OutFormat	String	是	`webp`	输出格式，支持格式有：png、jpeg、webp。
Intensity	Float	是	`0.9`	降噪强度，取值范围为[0,1]。取值为0时表示不降噪，取值越大降噪强度越大。
CanDemotion	Boolean	是	`true`	是否支持降级，即发生错误时返回原图地址。传入 StoreUri 则返回 StoreUri，传入 ImageUrl 则返回 ImageUrl。取值如下所示： true：支持降级 false：不支持降级

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
ResUri	String	`tos-i-t3**nr/bedd9`	降噪后的图片地址，根据输入时的地址决定返回值。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=GetDenoisingImage&Version=2018-08-01&ServiceId=8j**ji

{
    "StoreUri":"tos-i-t3***nr/0866d.jpg",
    "ImageUrl":"http://test/tos-i-t3***nr/0866d.jpg~tplv-t3**nr-1.png",
    "OutFormat":"webp",
    "Intensity": 0.9,
    "Demotion": true

}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "GetDenoisingImage",
    "Version": "2018-08-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
    "ResUri": "tos-i-t3**nr/bedd9",
    "Demotion": false
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。