文档中心

获取服务下所有图片模版

最近更新时间：2024.01.31 15:01:39

首次发布时间：2021.02.23 10:42:24

本接口支持通过其指定服务 ID 获取该服务下所有的图片模板信息。

请求说明

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

说明

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

请求参数

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

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	服务ID 您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
TemplateNamePattern	String	否	支持的字符正则集合为[a-zA-Z0-9_-]。指定时返回模板名称包含该字符串的图片模板，不填或者为空则返回所有模板。
Offset	Integer	否	分页偏移量，默认 0。取值为 1 时，表示跳过第一条数据，从第二条数据取值。
Limit	Integer	否	分页获取条数，默认 10。
Asc	String	否	是否按照模板创建时间升序查询，默认为`false`。取值为`true`时，表示按升序查询。取值为`false`时，表示降序查询。

返回参数

参数	类型	描述
ServiceId	String	服务 ID。
Total	Integer	模板总数。
Templates	Array of Templates	所有模板信息

Templates

参数	类型	描述
ServiceID	String	服务 ID。
TemplateName	String	模板名称。
Content	String	模版 JSON 内容。
CreateAt	String	模板创建时间。
Abstract	Array of String	模板的摘要信息。
WithSig	Bool	模板是否开启鉴权。取值为`true`，表示开启鉴权。取值为`false`，表示关闭鉴权。
Parameters	Array of String	图片模板的参数列表，URL 中下发参数的顺序需要跟列表中的保持一致。
ReqDeadline	String	URL 失效期，为 Unix 时间戳。
OuputQuality	Integer	对图片编码使用的质量参数，取值范围为 [1,100]，默认为 75。
OutputFormat	String	该模板计划使用的输出格式。
DemotionFormat	String	模板计划使用的降级格式，仅对 heic 静图有效。
Sync	Bool	是否同步处理，仅对 heic 图有效。
Usage	String	该模板的使用用例。
Filters	Array of Filters	对图片的编辑操作。
AdaptiveFmt	JSON Map	指定图像自适应配置。
OutputExtra	JSON Map	编码自定义参数，键值均为 String。取值`png.use_quant`表示是否开启 png quant 压缩，取值为`true`表示开启，取值为`false`表示关闭；取值`heic.sync`表示使用 heic 同步编码，取值为`true`表示同步；取值`heic.timeout`表示 heic 同步编码的超时时间，比如 20。
Snapshot	JSON Map	视频截帧配置。
Animation	JSON Map	视频转动图配置。
ErrMsg	String	模版内容校验失败时有值，表示失败原因。

OutputExtra

参数	类型	描述
png.use_quant	String	是否压缩颜色空间。默认关闭。
jpeg.progressive	String	是否采用 jpeg 渐进编码格式。默认关闭。
heic.roi	String	是否开启 ROI 编码。仅当`OutputFormat`取值为`heic`时配置有效，默认关闭。
heic.encode.depth	String	色位深度。仅当`OutputFormat`取值为`heic`时配置有效，默认关闭。
heic.thumb.ratio	String	缩略图比例，仅当`OutputFormat`取值为`heic`时配置有效，开启后默认为 5。默认关闭。
heic.alpha.reserve	String	是否带 ALPHA 透明通道编码。仅当`OutputFormat`取值为`heic`时配置有效，默认开启。

AdaptiveFmt

说明

自适应的具体原理说明请参考实现原理。

参数	类型	描述
Static	String	静图自适应，支持取值：webp、heic、avif、dynamic。
Animated	String	动图自适应，支持取值：webp、heic、avif、dynamic。

Snapshot

参数	类型	描述
Type	String	截图类型。
TimeOffsetMs	Integer	截图的时间戳，单位为 ms。

Animation

参数	类型	描述
StartTime	Integer	动图起始时间戳，单位为 ms。
Duration	Integer	动图时长，单位为 ms。
SelectFrameMode	String	抽帧策略。取值为`fps`，表示抽帧频率，1 秒 X 帧。取值为`spf`，表示抽帧间隔，X 秒 1 帧。取值为`key`，表示抽取关键帧。
FramePerSecond	Integer	帧率，1 秒 X 帧。仅当`SelectFrameMode`取值为`fps`时，需要配置。
SecondPerFrame	Integer	秒数，X 秒 1 帧。仅当`SelectFrameMode`取值为`spf`时，需要配置。
WaitTime	Integer	同步等待时长，单位为 s，超时未完成则根据`DemotionType`降级
DemotionType	String	降级类型。取值为`image`，表示抽取一帧降为静图返回。取值为`video`，表示直接返回原资源降级。

Filters

参数	类型	描述
Name	String	编辑操作的名称，具体详情请见图片编辑数据结构。
Param	JSON Map	编辑操作的参数，具体详情请见图片编辑数据结构。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetAllImageTemplates&Version=2018-08-01&ServiceId=fc51f8f9*

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetAllImageTemplates",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "ServiceId": "fc51f8f9*",
        "Templates": [
            {                
                "ServiceID": "fc51f8f9*",
                "TemplateName": "tplv-xyz-xxx",
                "CreateAt": "2018-05-09 17:44:40",
                "Abstract": [
                    "缩略：等比缩放",
                    "效果：模糊半径20"
                ],
                "WithSig": false,
                "Parameters": [
                    "width"
                ],
                "ReqDeadline": "",
                "OuputQuality": 85,
                "OutputFormat": "image",
                "Sync": false,
                "Usage": "~tplv-xyz-xxx:width.image",
                "Filters": [
                    {
                        "Name": "resize",
                        "Param": {
                            "width": "${width}",
                            "height": 0,
                            "keepratio": true
                        }
                    }
                ]
            }
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetAllImageTemplates",
        "Version": "2018-08-01",
         "Service": "imagex",
         "Region": "cn-north-1"
        "Error": {
            "Code": "RetrieveTemplatesFailure",
            "Message": "Service not found."
        }
    }
}

错误码

访问公共错误码以及模板相关错误码获取详细信息。