调用方式--图像技术-火山引擎

文档中心

导航

调用方式

最近更新时间：2022.09.15 15:48:57首次发布时间：2022.07.21 16:20:22

接口简介

图片智能填充，能够根据参数，通过填充的方式，将图片填充到指定的比例，返回填充后的图片。

限制条件

名称	内容
图片要求	1. 图片格式：JPG、JPEG、PNG、BMP等常见格式，建议使用JPG格式。 2. 图片文件大小：最大 5 MB。

请求说明

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	POST
Content-Type	`application/x-www-form-urlencoded`(传入参数不包含类型File) `multipart/form-data`(参数包含类型File)

请求参数

（1）header请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见公共参数

名称	类型	是否必填	描述
X-Date	String	是	使用UTC时间，精确到秒。请使用格式：`YYYYMMDD'T'HHMMSS'Z'` ，例如：`20201103T104027Z`
Authorization	String	是	HMAC-SHA256：签名方法 -Credential为签名凭证，其中: -AccessKeyId为访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：`YYYYMMDD`，例如：`20180201`； -Region为请求地区，国内一般为为`cn-north-1`； -Service为请求的服务，一般为`cv`； -SignedHeaders为参与签名计算的头部信息，`content-type` 和 `host` 为必选头部； -Signature为签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入例如：`HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}`
X-Security-Token	String	否	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

（2）Query参数

业务请求参数

参数	可选/必选	类型	说明
Action	必选	String	接口名，取值：ImageOutpaint
Version	必选	String	版本号，取值：2020-08-26

（3）Body参数

业务请求参数

参数	可选/必选	类型	说明
`image`	必选(`image`与`image_base64`必选其一)	File	上传图片文件
`image_base64`	必选(`image`与`image_base64`必选其一)	String	图片Base64编码
`x_pref`	必选	`String`	x轴上的填充策略，`left`表示向左扩展，`right`和`both`同理
`y_pref`	必选	`String`	与上同理，有`up`，`down`和`both`三种策略
`ratio`	必选	`Float`	填充后图片的宽高比

备注: image和image_base64都有时会使用image

输出说明

（1）通用输出参数

通用输出参数具体见通用返回字段及错误码

（2）业务输出参数

data字段说明

字段	类型	说明
`img_data`	`String`	图片二进制(`jpeg`格式)的base64编码

（3）输出示例

{
    "status": 10000,
    "code": 10000,
    "time_elapsed": "1.49221491814s",
    "request_id": "68929651727767982161604893518",
    "message": "Success",
    "data": {
        "img_data": ${图片二进制的base64编码}
    }
}

错误码

（1）通用错误码
请参考通用返回字段及错误码

（2）业务错误码

HttpCode	错误码	错误消息	描述
200	10000	无	请求成功