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

本接口支持恢复指定服务回收站内的模板。

说明

当已经有同名模板的时候，此时恢复模板会递增版本号。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是CreateTemplatesFromBin接口名称。当前 API 的名称为 CreateTemplatesFromBin。
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"]待恢复模板的名称。您可以通过调用获取回收站中所有模板获取所需的模板名称。

返回参数

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

参数类型示例值描述
ResultsArray of Results-返回各模板恢复的结果。

Results

参数类型示例值描述
BinNameStringtplv-xyz-xxx@2022-08-23T20:25:26+08:00回收站中的模板名。
NewNameStringtplv-xyz-xxx恢复后的模板名。

Success

Boolean

true

是否恢复成功，取值如下所示：

  • true：恢复成功
  • false：恢复不成功

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateTemplatesFromBin",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Results": [
            {
                "BinName": "tplv-xyz-xxx@2022-08-23T20:25:26+08:00",
                "NewName": "tplv-xyz-xxx",
                "Success": true
            }
        ]
    }
}

错误码

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

服务端 SDK

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

历史版本

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