文档中心

新建样式

最近更新时间：2024.01.31 15:20:00

首次发布时间：2022.07.15 15:30:46

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

请求说明

接口名称：CreateImageStyle
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=CreateImageStyle&Version=2018-08-01
请求频率限制：5 次/秒
超时时间：10 秒

说明

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

请求参数

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

Query

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

Body

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

返回参数

参数	类型	描述
StyleId	String	创建好的样式 ID。

示例

请求示例

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

正常返回示例

{
   "ResponseMetadata":{
      "RequestId":"2022071512581601021219801626B46052",
      "Action":"CreateImageStyle",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":{
      "StyleId":"62d0f3e8a1520596600b786*"
   }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022071512581601021219801626B46052",
        "Action": "CreateImageStyle",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
             "Code": "xx",
            "Message": "xx"
        }
    }
}

错误码

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