全部产品
Search
文档中心

对象存储 OSS:Go解冻文件

更新时间:Nov 26, 2024

归档、冷归档以及深度冷归档类型的文件需要解冻之后才能读取。文件解冻后,会产生一个标准存储类型的文件副本,即同时存在标准存储类型的文件副本和归档、冷归档或深度冷归档的原文件。在文件解冻的有效期过后,标准存储类型的文件副本会自动删除。本文介绍如何使用OSS Go SDK解冻归档、冷归档以及深度冷归档文件。

注意事项

  • 仅归档、冷归档类型的Object支持调用RestoreObject方法。

  • 本文示例代码以华东1(杭州)的地域IDcn-hangzhou为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见OSS地域和访问域名

  • 本文以从环境变量读取访问凭证为例。如何配置访问凭证,请参见配置访问凭证

  • 要解冻文件,您必须有oss:RestoreObject权限。具体操作,请参见为RAM用户授权自定义的权限策略

方法定义

func (c *Client) RestoreObject(ctx context.Context, request *RestoreObjectRequest, optFns ...func(*Options)) (*RestoreObjectResult, error)

请求参数列表

参数名

类型

说明

ctx

context.Context

请求的上下文,可以用来设置请求的总时限

request

*RestoreObjectRequest

设置接口的请求参数,具体请参见RestoreObjectRequest

optFns

...func(*Options)

(可选)接口级的配置参数, 具体请参见Options

其中,RestoreObjectRequest的常用参数说明列举如下:

参数名

类型

说明

bucket

*string

存储空间名称

key

*string

对象名称

versionId

*string

待解冻对象的版本号,如果不设置则默认指定最新版本的对象

restoreRequest

*RestoreRequest

设置解冻请求参数

其中,RestoreRequest的参数说明列举如下:

参数名

类型

说明

days

int32

设置解冻持续时间,具体请参见解冻状态持续时间

tier

*string

设置解冻消耗时间,具体请参见解冻消耗时间

返回值列表

返回值名

类型

说明

result

*RestoreObjectResult

接口返回值,当 err 为nil 时有效,具体请参见RestoreObjectResult

err

error

请求的状态,当请求失败时,err 不为 nil

示例代码

您可以使用以下代码解冻归档、冷归档或者深度冷归档文件:

package main

import (
	"context"
	"flag"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

// 定义全局变量
var (
	region     string // 存储区域
	bucketName string // 存储空间名称
	objectName string // 对象名称
)

// init函数用于初始化命令行参数
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located.")
	flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
	flag.StringVar(&objectName, "object", "", "The name of the object.")
}

func main() {
	// 解析命令行参数
	flag.Parse()

	// 检查bucket名称是否为空
	if len(bucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, bucket name required")
	}

	// 检查region是否为空
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 检查object名称是否为空
	if len(objectName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, object name required")
	}

	// 加载默认配置并设置凭证提供者和区域
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	// 创建OSS客户端
	client := oss.NewClient(cfg)

	// 创建解冻对象的请求
	request := &oss.RestoreObjectRequest{
		Bucket: oss.Ptr(bucketName), // 存储空间名称
		Key:    oss.Ptr(objectName), // 对象名称
		RestoreRequest: &oss.RestoreRequest{
			Days: 3, // 设置解冻状态的持续天数为3天
		},
	}

	// 发送解冻对象的请求
	result, err := client.RestoreObject(context.TODO(), request)
	if err != nil {
		log.Fatalf("failed to restore object %v", err)
	}

	// 打印解冻对象的结果
	log.Printf("restore object result:%#v\n", result)
}

相关文档

  • 关于解冻文件的完整示例代码,请参见GitHub示例

  • 关于解冻文件的API接口,请参见RestoreObject

  • 关于解冻文件的更多操作信息,请参见解冻文件