恢复回收站模板--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

恢复回收站模板

最近更新时间：2024.08.20 11:28:32首次发布时间：2022.08.26 14:55:41

本接口支持通过指定服务 ID 以及待恢复的模板名称，恢复该服务回收站内对应的模板。当已经有同名模版的时候，此时恢复模版会递增版本号。

说明

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

请求说明

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

说明

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

请求参数

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

Query

参数类型是否必选描述

Action String 是接口名称。

Version String 是接口版本。veImageX 当前 API 的版本为 2018-08-01。

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

服务 ID。

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

Body

参数	类型	是否必选	描述
TemplateNames	Array of String	是	待恢复模板名称。说明您可以通过调用获取回收站中所有模板获取所需的模板名称。

返回参数

参数	类型	描述
Results	Array of Result	返回各模版恢复的结果。

Result

参数	类型	描述
BinName	String	回收站中的模版名。
NewName	String	恢复后的模版名。
Success	bool	是否恢复成功。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateTemplatesFromBin&Version=2018-08-01&ServiceId=xxxx 
{
    "TemplateNames": [
        "tplv-xyz-xxx"
    ]
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "CreateTemplatesFromBin",
        "Version": "2018-08-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
            }
        ]
    }
}

异常返回示例

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

错误码

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