导入模板--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

导入模板

最近更新时间：2024.08.20 11:27:54首次发布时间：2024.08.20 11:27:54

本接口支持通过指定服务 ID 以及模板的 JSON 内容，来向该服务导入图片模板。

如果导入成功，则返回模板名称。
如果导入失败，则返回失败原因。

说明

包含附加组件的模板不做导入，直接忽略。
包含图文水印的模板，需上传水印文件到目标服务，并替换模板内容中的水印 URI。

注意事项

请求频率限制：单用户请求频率限制为 10 次/秒。
超时时间：约为 5 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateImageTemplatesByImport`	接口名称。当前 API 的名称为 `CreateImageTemplatesByImport`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
ServiceId	String	是	`n8**e0`	模板导入的目标服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
Rename	Boolean	否	`false`	模板名称冲突时是否重命名（增加版本号）。 `true`：是，有重名模板时，将对其增加版本号后再导入。 `false`：（默认）否。将忽略重名模板，不执行导入。
Templates	Array of String	是	`["{\"name\":\"tplv-n8**e0-13\",\"output\":{\"quality\":30,\"format\":\"jpeg\",\"extra\":{\"heic.alpha.reserve\":\"true\"},\"exif\":{\"auto_orient_off\":true}},\"input\":{},\"max_age\":2592000,\"filters\":[]}"]`	待导入的模板 JSON 内容列表。

ServiceId

String

是

n8**e0

模板导入的目标服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Rename

Boolean

否

false

模板名称冲突时是否重命名（增加版本号）。

true：是，有重名模板时，将对其增加版本号后再导入。
false：（默认）否。将忽略重名模板，不执行导入。

Templates Array of String 是 ["{\"name\":\"tplv-n8**e0-13\",\"output\":{\"quality\":30,\"format\":\"jpeg\",\"extra\":{\"heic.alpha.reserve\":\"true\"},\"exif\":{\"auto_orient_off\":true}},\"input\":{},\"max_age\":2592000,\"filters\":[]}"] 待导入的模板 JSON 内容列表。

返回参数

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

参数	类型	示例值	描述
ImportResults	Array of ImportResults	`-`	导入结果

ImportResults

参数	类型	示例值	描述
TemplateName	String	`tplv-n8**e0-13`	源模板名称。
Success	Boolean	`true`	导入是否成功，取值如下所示： `true`：导入成功 `false`：导入失败
ImportedName	String	`tplv-l7**px-17`	导入后模板名称。当`Success`取值为`true`时有值。
Msg	String	`duplicate template name tplv-n8**e0-13`	导入失败原因。当`Success`取值为`false`时有值。

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageTemplatesByImport&Version=2023-05-01
{
    "ServiceId": "n8**e0",
    "Templates": {
        "name": "tplv-n8**e0-13",
        "output": {
            "quality": 30,
            "format": "jpeg",
            "extra": {
                "heic.alpha.reserve": "true"
            },
            "exif": {
                "auto_orient_off": true
            }
        },
        "input": {},
        "max_age": 2592000,
        "filters": []
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateImageTemplatesByImport",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "ImportResults": [
            {
                "TemplateName": "tplv-n8**e0-13",
                "Success": true,
                "ImportedName": "tplv-l7**px-17"
            }
        ]
    }
}

错误码

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

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。

历史版本

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