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

文档中心

立即注册

导航

veImageX

导入模板

最近更新时间：2024.08.20 11:28:39首次发布时间：2021.02.23 10:42:28

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

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

说明

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

注意

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

请求说明

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

说明

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

请求参数

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

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。

Body

参数	类型	是否必选	描述
ServiceId	String	是	模板导入目标服务 ID。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
Rename	Bool	否	模板名称冲突时是否重命名(增加版本号)。默认否，表示忽略重名模板，不执行导入。
Templates	Array of String	是	待导入的模板 JSON 内容列表。

参数

类型

是否必选

描述

ServiceId

String

是

模板导入目标服务 ID。

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

Rename

Bool

否

模板名称冲突时是否重命名(增加版本号)。默认否，表示忽略重名模板，不执行导入。

Templates

Array of String

是

待导入的模板 JSON 内容列表。

返回参数

参数	类型	描述
ImportResults	Array of ImportResults	导入结果

ImportResults

参数	类型	描述
TemplateName	String	源模板名称。
Success	Bool	导入是否成功。取值为`true`时，表示导入成功。取值为`false`时，表示导入失败。
ImportedName	String	导入后模版名称。当`Success`取值为`true`时有值。
Msg	String	导入失败原因。当`Success`取值为`false`时有值。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageTemplatesByImport&Version=2018-08-01
{
   "ServiceId":"nn**0m",
   "Rename":true,
   "Templates":[
      
   ]
}

正常返回示例

{
   "ResponseMetadata":{
      "RequestId":"202208251904550102081211031FE743B0",
      "Action":"CreateImageTemplatesByImport",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":{
      "ImportResults":[
         {
            "TemplateName":"tplv-l7**px-17",
            "Success":true,
            "ImportedName":"tplv-l7**px-17"
         }
      ]
   }
}

异常返回示例

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

错误码

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