You need to enable JavaScript to run this app.
导航
veImageX
  • 文档首页
    • /veImageX/API 参考/模板管理/删除回收站模板
删除回收站模板
最近更新时间：2024.08.20 11:16:11首次发布时间：2024.08.20 11:16:11
我的收藏

本接口支持删除指定服务下回收站内的模板。删除后，该模板不可恢复。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是DeleteTemplatesFromBin接口名称。当前 API 的名称为 DeleteTemplatesFromBin。
VersionString是2023-05-01接口版本。当前 API 的版本为 2023-05-01。

ServiceId

String

是

8h**9q

待删除模板对应的服务 ID。

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

Body

参数类型是否必选示例值描述
TemplateNamesArray of String是["tplv-xyz-xxx@2022-08-23T20:25:26+08:00"]待删除模板名称。您可以通过调用获取回收站中所有模板获取所需的模板名称。

返回参数

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

参数类型示例值描述

TemplateNames

Array of String

["tplv-xyz-xxx@2022-08-23T20:25:26+08:00"]

成功删除的模板名称。

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

请求示例

POST https://imagex.volcengineapi.com/?Action=DeleteTemplatesFromBin&Version=2023-05-01&ServiceId=8h**9q
{
    "TemplateNames": [
        "tplv-xyz-xxx@2022-08-23T20:25:26+08:00"
    ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "DeleteTemplatesFromBin",
    "Version": "2023-05-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
    "TemplateNames": [
      "tplv-xyz-xxx@2022-08-23T20:25:26+08:00"
    ]
  }
}

错误码

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

服务端 SDK

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

历史版本

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