编辑样式--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

编辑样式

最近更新时间：2024.09.03 16:47:46首次发布时间：2022.07.19 19:59:37

对当前已创建的创意魔方样式的各元素（如图片、文字等）进行新的编辑操作，并选择是否对上传图片按照当前样式数据进行样式渲染以及渲染结果图的存储。

使用限制

请求频率限制：5 次/秒
超时时间：10 秒
服务地址：仅支持使用国内对应的 OpenAPI 域名，具体请见请求地址。

请求说明

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

请求参数

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

Query

参数	类型	是否必填	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。

Body

参数类型是否必填描述

参数	类型	是否必填	描述
DoUpload	Bool	否	是否执行对上传图像的样式渲染和渲染结果图上传操作，默认为``。取值如下所示： true：将所有已上传至该样式的图像以更新后的样式数据进行重新处理，并将结果图上传至该样式所绑定服务的存储中。其更新后的结果图 Uri 请在获取样式详情中获取。 false：（默认）不执行上述操作。说明建议您仅在手动保存样式或关闭当前页面时指定`DoUpload`为`TRUE`，可节省后端渲染成本。
Style	JSON Object	是	更新的样式结构，包含图片编辑、文字编辑、背景等自定义参数配置，具体请参考样式结构。

DoUpload

Bool

否

是否执行对上传图像的样式渲染和渲染结果图上传操作，默认为``。取值如下所示：

true：将所有已上传至该样式的图像以更新后的样式数据进行重新处理，并将结果图上传至该样式所绑定服务的存储中。其更新后的结果图 Uri 请在获取样式详情中获取。
false：（默认）不执行上述操作。

说明

建议您仅在手动保存样式或关闭当前页面时指定DoUpload为TRUE，可节省后端渲染成本。

Style JSON Object 是更新的样式结构，包含图片编辑、文字编辑、背景等自定义参数配置，具体请参考样式结构。

返回参数

无

示例

请求示例

POST https://imagex.volcengineapi.com?Action=UpdateImageStyle&Version=2018-08-01
{
   {
   "DoUpload":false,
   "Style":{
      "id":"62d0f3e8a1520596600b786*",
      "name":"test",
      "width":510,
      "height":600,
      "unit":"px",
      "service":"nnsl1jf0m*",
      "background":{
         "fill":"#FFFFFF",
         "fillSrc":"",
         "viewpoint":{
            "x":0,
            "y":0,
            "width":1,
            "height":1
         }
      },
      "elements":[
         {
            "type":"image",
            "id":"el18200560c802",
            "name":"图片1",
            "left":0,
            "top":20,
            "width":320,
            "height":560,
            "content":"tos-cn-i-ldojp2yol9/mofang/779a640e6f743ecc910c5331140*.jpeg",
            "opacity":80,
            "angle":0,
            "flipX":false,
            "flipY":false,
            "attr":{
               "fillptn":{
                  "ptn":1,
                  "viewpoint":{
                     "x":0,
                     "y":0,
                     "width":1,
                     "height":1
                  },
                  "viewLoc":5
               },
               "filter":[
                  {
                     "name":"bright",
                     "param":{
                        "bright":5
                     }
                  },
                  {
                     "name":"contrast",
                     "param":{
                        "contrast":13
                     }
                  },
              {
                     "name":"saturation",
                     "param":{
                        "saturation":15
                     }
                  },
                  {
                     "name":"sharpen",
                     "param":{
                        "sharpen":19
                     }
                  }
               ]
            }
         }
      ],
      "output":{
         "format":"WEBP",
         "quality":0
      }
   }
}
}

正常返回示例

{
   "ResponseMetadata":{
      "RequestId":"2022071513305401021204519717A8DFCF",
      "Action":"UpdateImageStyle",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":{
   }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022071513305401021204519717A8DFCF",
        "Action": "UpdateImageStyle",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
             "Code": "xx",
            "Message": "xx"
        }
    }
}

错误码

访问公共错误码和创意魔方错误码获取详细信息。