You need to enable JavaScript to run this app.
导航
veImageX
  • 文档首页
    • /veImageX/API 参考/历史版本/模板管理/删除图片模板
删除图片模板
最近更新时间：2024.08.20 11:28:11首次发布时间：2021.02.23 10:42:23
我的收藏

本接口支持通过指定服务 ID 以及模板名称删除对应的图片模板。

说明

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

请求说明

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

说明

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

请求参数

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

Query

参数类型是否必填描述
ActionString是接口名称。
VersionString是接口版本。veImageX 当前 API 的版本为 2018-08-01。

ServiceId

String

是

服务 ID。

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

Body

参数
类型
是否必选描述

TemplateNames

Array of String

是

待删除模板名称，最大限制为 100。

说明

您可以通过调用获取服务下所有图片模板获取所需的模板名称。

返回参数

参数
类型
描述

TemplateNames

Array of String

成功删除的模板名称。

  • 如果仅指定删除单个模板，若删除失败直接返回错误。
  • 如果指定删除多个模板，若全部删除失败则返回错误；否则将返回成功删除的模板名称。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=DeleteImageTemplate&Version=2018-08-01&ServiceId=d7b84ac7-38b7-4f4f-8eea-fff3c5f95be*
{
    "TemplateNames": [
        "tplv-xyz-xxx"
    ]
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DeleteImageTemplate",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "TemplateNames": [
            "tplv-xyz-xxx"
        ]
    }
}

异常返回示例

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

错误码

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