新建样式--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

新建样式

最近更新时间：2024.09.03 16:47:46首次发布时间：2024.04.19 11:39:02

使用本接口来创建创意魔方样式，您可以自定义样式名称、样式画布高度/宽度等参数，并得到返回的样式 ID。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 10 秒。
前提条件：已开通创意魔方组件。
服务地址：仅支持使用国内对应的 OpenAPI 域名，具体请见请求地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=CreateImageStyle&Version=2023-05-01

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateImageStyle`	接口名称。当前 API 的名称为 `CreateImageStyle`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数	类型	是否必选	示例值	描述
Name	String	是	`test`	样式名称，当前对字符长度及支持字符暂无限制。
Width	Integer	是	`400`	样式画布的宽度，取值范围为[0,1000]。
Height	Integer	是	`600`	样式画布的高度，取值范围为[0,1000]。
Unit	String	否	`px`	尺寸单位。即样式画布宽度/高度的像素单位，取值为`px`。
ServiceId	String	是	`nnsl1jf0m*`	绑定的服务 ID，用于计量计费和样式渲染结果图的存储。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

返回参数

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

参数	类型	示例值	描述
StyleId	String	`62d0f3e8a1520596600b786*`	创建成功的样式 ID。

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageStyle&Version=2023-05-01
{
  "Name": "test",
  "ServiceId": "nnsl1jf0m*",
  "Width": 400,
  "Height": 600,
  "Unit": "px"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateImageStyle",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "StyleId": "62d0f3e8a1520596600b786*"
    }
}

错误码

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

历史版本

2018-08-01 版本 CreateImageStyle 接口文档现已停止维护，建议您参考本文档使用最新版本。