恢复历史版本文件--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

恢复历史版本文件

最近更新时间：2024.11.15 13:33:59首次发布时间：2024.11.15 13:33:59

本接口支持恢复指定的历史版本文件，使其成为最新版本。

使用说明

使用场景：
- 未开启版本控制的服务，不支持恢复历史版本文件；
- 已开启/暂停版本控制的服务，支持恢复历史版本文件。
  - 开启状态下，历史版本文件恢复后，版本 ID 为全局唯一的随机字符串；
  - 暂停状态下，历史版本文件恢复后，版本 ID 为 null。
恢复规则：
- 仅支持恢复历史版本文件；
- 不支持恢复最新版本以及删除标记。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述

Action String 是 UpdateHistoryVersionFile 接口名称。当前 API 的名称为 UpdateHistoryVersionFile。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateHistoryVersionFile`	接口名称。当前 API 的名称为 `UpdateHistoryVersionFile`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`test`	指定要恢复文件所属的服务 ID 您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

test

指定要恢复文件所属的服务 ID

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

Body

参数	类型	是否必选	示例值	描述
Key	String	是	`demo.png`	待恢复的历史版本文件的存储 Key。您可通过调用 GetImageStorageVersionFiles 获取历史版本文件的版本信息。
VersionID	String	是	`56DE4E5***F9B9C`	待恢复历史版本文件对应的版本 ID。您可通过调用 GetImageStorageVersionFiles 获取历史版本文件的版本信息。

返回参数

本接口暂无特定的返回参数。更多信息请见公共返回参数。

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateHistoryVersionFile&Version=2023-05-01&ServiceId=test
{
    "Key": "demo.png",
    "VersionID": "56DE4E5***F9B9C"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateHistoryVersionFile",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    }
}

错误码

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