You need to enable JavaScript to run this app.
导航

获取样式列表

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

首次发布时间2022.07.20 10:05:37

通过输入样式类型等数据,获取分页返回的样式数据信息,如:样式 ID、样式名称和结果图 Uri等参数。

请求说明

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

说明

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

请求参数

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

Query

参数类型是否必选描述
ActionString接口名称。
VersionString接口版本。veImageX 当前 API 的版本为 2018-08-01
TypeString样式类型。取值 user 表示用户样式。

SearchPtn

String

需要返回的样式列表标识。

  • 返回的样式名称、样式 ID 包含了该值的样式列表。
  • 返回的样式宽度或样式高度为该值的样式列表。
LimitInteger分页返回条数,取值范围为[0,100],默认 10 条。
OffsetInteger分页偏移,默认 0,取值为 1 时,表示跳过一条数据,从第二条数据取值。

返回参数

参数类型描述
TotalInteger总样式个数。
StyleArray of Style当前分页样式数据。

Style

参数类型描述
idString样式 ID。
nameString样式名称。
widthInteger样式画布的宽度。
heightInteger样式画布的高度。
unitString尺寸单位。表示样式宽度和样式高度的像素单位,取值为 px
serviceString样式绑定的服务 ID。
ResUriString样式渲染结果图的 URI。
CreateAtString样式创建时间,即样式创建时的服务器当地时间。
UpdateAtString样式更新时间,即样式更新时的服务器当地时间。

示例

请求示例

GET https://imagex.volcengineapi.com/?imagex-lang=zh&Action=GetImageStyles&Version=2018-08-01&Type=user&SearchPtn=62d12ce488b5a625a29a2db*&Offset=0&Limit=18

正常返回示例

"ResponseMetadata":{
      "RequestId":"2022071517022601021213615302B2CD09",
      "Action":"GetImageStyles",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":{
      "Total":1,
      "Styles":[
         {
            "id":"62d12ce488b5a625a29a2db*",
            "name":"test",
            "width":800,
            "height":2000,
            "unit":"px",
            "service":"nnsl1jf0m*",
            "ResUri":"tos-cn-i-nnsl1jf0mq/43e2128c584b5e7c347adebf40e18f21d2c*",
            "CreateAt":"2022-07-15 17:01:24",
            "UpdateAt":"2022-07-15 17:29:23"
         }
      ]
   }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022071517022601021213615302B2CD09",
        "Action": "GetImageStyles",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
             "Code": "xx",
            "Message": "xx"
        }
    }
}

错误码

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