文档中心

使用画质增强获取编码后图片二进制数据

最近更新时间：2023.12.28 15:46:26

首次发布时间：2023.04.27 17:02:24

本接口使用 HTML 表单指定服务 ID 和具体增强参数后，对输入的原图二进制数据执行画质增强处理，并最终输出编码后图片二进制数据。

说明

您也可以通过调用 GetImageEnhanceResult 输入图片 URI 或 URL，来获取经画质增强处理后的结果图地址。

注意事项

请求频率：单用户请求频率为 5 次/秒。
输入限制：
- 通用模型：
  - 图像格式：heic、webp、jpeg、png
  - 图像大小：不超过 8MB
  - 图像分辨率：64 < 长边 <= 2160，64 < 短边 <= 1440
- 低质专清模型：
  - 图像格式：heic、webp、jpeg、png
  - 图像大小：不超过 8MB
  - 图像分辨率：64 < 长边 <= 2048，64 < 短边 <= 2048
通用增强数据延迟说明：
- 720p: 1081ms
- 1080p: 1410ms
- 2k: 1864ms
- 4k: 分辨率过大不支持

请求说明

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

说明

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

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数类型是否必选示例值描述

Action String 是 GetImageEnhanceResultWithData 接口名称。当前 API 的名称为 GetImageEnhanceResultWithData。

Version String 是 2018-08-01 接口版本。当前 API 的版本为2018-08-01。

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

ServiceId

String

是

8J**21

服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	示例值	描述
Input	String	是	-	具体增强参数
Data	File	是	`data`	图片二进制数据

Input

参数	类型	是否必选	示例值	描述
Model	Integer	是	`0`	增强模型。取值如下所示： `0`：通用模型 `1`：低质专清模型
DisableAr	Bool	否	`false`	是否不去压缩失真。`Model`取值为`0`时选填，支持以下取值： `true`：不进行去压缩失真处理 `false`：（默认）进行去压缩失真处理
DisableSharp	Bool	否	`false`	是否不自适应锐化。`Model`取值为`0`时选填，支持以下取值： `true`：不进行锐化处理 `false`：（默认）进行锐化处理
OutFormat	String	否	`png`	输出图片格式。默认为 png，支持的图片格式有： `png`、`jpeg`、`webp`。说明当输入图像是 RGBA 格式时，为了保证输出图像仍为 RGBA 格式以及确保 Alpha 通道的准确性，建议您指定输出为 png 格式。不可选择输出为 jpeg。如您希望降低全链路图片加载耗时，建议您指定输出为 jpeg 或 webp 格式。
Quality	Integer	否	`90`	输出图片编码质量参数。取值范围为 [1,100]，默认为 90。对于 PNG 为无损压缩，该值无效。其他格式下其值越小，压缩率越高，画质越差。则在不影响画质的情况下，推荐指定为 90 以上。

返回参数

经画质增强处理编码后的图片二进制数据

示例

请求示例

POST /topapi/v1/services?Action=GetImageEnhanceResultWithData&version=2018-08-01&ServiceId=v0****dbf HTTP/1.1
Host: xxx
X-Top-Account-Id: 1900000000
Content-Length: <ContentLength>
Content-Type: multipart/form-data; boundary=<boundary>

--<boundary>
Content-Disposition: form-data; name="Input"

{"Model": 0, "DisableAr": false, "DisableSharp": false}
--<boundary>
Content-Disposition: form-data; name="Data"; filename="1.jpeg"
Content-Type: image/jpeg

(data)
--<boundary>--

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022052415234901022524314707965A79",
        "Action": "GetImageEnhanceResultWithData",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": "**********************************"
}

错误码

该接口错误码如下表所示。您也可以访问错误码和附加组件错误码获取其他详细信息。

Http 状态码	错误码	错误码说明
400	600003	输入参数错误
400	600012	图片解码失败
400	611400	图片分辨率越界
400	600011	算法处理失败

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：