恢复文件--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

恢复文件

最近更新时间：2024.09.24 11:25:03首次发布时间：2024.01.31 15:20:04

本接口支持恢复归档或冷归档存储的文件。

说明

对于低频存储文件，您可直接访问无需恢复。

使用说明

恢复操作完成后，将生成一个临时文件副本供您访问，副本有效期为您指定的恢复时长。期间将按照临时存储类型进行计费。详见恢复说明。

注意事项

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

请求说明

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

请求参数

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

Query

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

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

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

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

ServiceId

String

是

8h**kl

服务 ID。

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

Body

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

参数	类型	是否必选	示例值	描述
StoreUri	String	是	`demo.png`	文件存储 URI。您可以在 veImageX 控制台资源管理页面，在已上传文件的名称列获取资源 URI。您也可以通过 OpenAPI 的方式获取 URI，具体请参考获取服务下全部上传文件。
Duration	Integer	是	`30`	恢复时长，取值范围为[1,365]，单位为天。

StoreUri

String

是

demo.png

文件存储 URI。

您可以在 veImageX 控制台资源管理页面，在已上传文件的名称列获取资源 URI。
您也可以通过 OpenAPI 的方式获取 URI，具体请参考获取服务下全部上传文件。

Duration Integer 是 30 恢复时长，取值范围为[1,365]，单位为天。

返回参数

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

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateFileRestore&Version=2023-05-01&ServiceId=8h**kl
{
    "StoreUri": "demo.png",
    "Duration": 30
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "CreateFileRestore",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {}
}

错误码

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