获取样式列表--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取样式列表

最近更新时间：2024.08.05 18:26:08首次发布时间：2022.07.20 10:05:37

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

说明

该接口属于历史版本 API，建议您使用新版 GetImageStyles 接口。

请求说明

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

说明

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

请求参数

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

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
Type	String	是	样式类型。取值 user 表示用户样式。
SearchPtn	String	否	需要返回的样式列表标识。返回的样式名称、样式 ID 包含了该值的样式列表。返回的样式宽度或样式高度为该值的样式列表。
Limit	Integer	否	分页返回条数，取值范围为[0,100]，默认 10 条。
Offset	Integer	否	分页偏移，默认 0，取值为 1 时，表示跳过一条数据，从第二条数据取值。

返回参数

参数	类型	描述
Total	Integer	总样式个数。
Style	Array of Style	当前分页样式数据。

Style

参数	类型	描述
id	String	样式 ID。
name	String	样式名称。
width	Integer	样式画布的宽度。
height	Integer	样式画布的高度。
unit	String	尺寸单位。表示样式宽度和样式高度的像素单位，取值为 `px`。
service	String	样式绑定的服务 ID。
ResUri	String	样式渲染结果图的 URI。
CreateAt	String	样式创建时间，即样式创建时的服务器当地时间。
UpdateAt	String	样式更新时间，即样式更新时的服务器当地时间。

示例

请求示例

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"
        }
    }
}

错误码

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