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

文档中心

立即注册

导航

veImageX

获取样式列表

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

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

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageStyles`	接口名称。当前 API 的名称为 `GetImageStyles`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
Type	String	是	`user`	样式类型。取值 `user` 表示用户样式。
SearchPtn	String	否	`pattern`	需要返回的样式列表标识。返回的样式名称、样式 ID 包含了该值的样式列表。返回的样式宽度或样式高度为该值的样式列表。
Limit	String	否	`10`	分页返回条数，取值范围为[0,100]，默认 10 条。
Offset	String	否	`0`	分页偏移量，用于控制分页查询返回结果的起始位置，以便对数据进行分页展示和浏览。默认值为 0。说明例如，指定分页条数 Limit = 10，分页偏移量 Offset = 10，表示从查询结果的第 11 条记录开始返回数据，共展示 10 条数据。

返回参数

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

参数	类型	示例值	描述
Total	Integer	`1`	总样式个数。
Styles	Array of Styles	`-`	当前分页样式数据

Styles

参数	类型	示例值	描述
Id	String	`8020****0283`	样式ID
Name	String	`text-test`	样式名称
Width	String	`1504`	样式宽
Height	String	`2672`	样式高
Unit	String	`px`	尺寸单位。当前仅支持取值 px 表示像素。
Service	String	`y8c**6us5`	样式绑定的服务 ID
ResUri	String	`tos-cn-i-y8s5/c63a3b45c9ff9eec20afe8c86be`	样式渲染结果图的存储 URI
CreateAt	String	`2023-07-18 21:19:37`	样式创建时间
UpdateAt	String	`2023-07-18 22:08:59`	样式更新时间

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageStyles&Version=2023-05-01&Type=user&SearchPtn=pattern&Limit=10&Offset=0

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetImageStyles",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 1,
        "Styles": [
            {
                "Id": "Zhr0bq",
                "Name": "text-test",
                "Width": "1504",
                "Height": "2672",
                "Unit": "px",
                "Service": "y8c**6us5",
                "ResUri": "tos-cn-i-y8**s5/c63a3b45c9ff9**eec20afe8c86be",
                "CreateAt": "2023-07-18 21:19:37",
                "UpdateAt": "2023-07-18 22:08:59"
            }
        ]
    }
}

错误码

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

历史版本

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