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

最近更新时间：2023.05.26 11:42:49

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

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

说明

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

请求说明

接口名称：GetImageEnhanceResultWithData
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=GetImageEnhanceResultWithData&Version=2018-08-01
请求频率：单用户请求频率为 20 次/秒。
通用增强数据延迟说明：
- 720p: 1081ms
- 1080p: 1410ms
- 2k: 1864ms
- 4k: 分辨率过大不支持

说明

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

请求参数

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

Query

参数类型是否必填备注

Action String 是接口名称。

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

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

ServiceId

String

是

服务 ID。

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

Body

参数	类型	是否必填	备注
Input	String	是	具体增强参数
Data	File	是	图片二进制数据

Input

参数类型是否必填备注

参数	类型	是否必填	备注
Model	Integer	是	增强模型。取值如下所示： `0`：通用模型 `1`：低质专清模型
DisableAr	Bool	否	是否不去压缩失真。`Model`取值为`0`时选填，支持以下取值： `true`：不进行去压缩失真处理 `false`：（默认）进行去压缩失真处理
DisableSharp	Bool	否	是否不自适应锐化。`Model`取值为`0`时选填，支持以下取值： `true`：不进行锐化处理 `false`：（默认）进行锐化处理

Model

Integer

是

增强模型。取值如下所示：

0：通用模型
1：低质专清模型

DisableAr

Bool

否

是否不去压缩失真。Model取值为0时选填，支持以下取值：

true：不进行去压缩失真处理
false：（默认）进行去压缩失真处理

DisableSharp

Bool

否

是否不自适应锐化。Model取值为0时选填，支持以下取值：

true：不进行锐化处理
false：（默认）进行锐化处理

返回参数

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

示例

请求示例

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": "**********************************"
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022052415272701022524315306968BA4",
        "Action": "GetImageEnhanceResultWithData",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": ,
            "Code": "",
            "Message": "参数"
        }
    }
}

错误码

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

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

服务端 SDK

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