通過Go SDK V2解凍歸檔、冷歸檔和深度冷歸檔Object - Object Storage Service

歸檔、冷歸檔以及深度冷歸檔類型的檔案需要解凍之後才能讀取。檔案解凍後，會產生一個標準儲存類型的檔案副本，即同時存在標準儲存類型的檔案副本和歸檔、冷歸檔或深度冷歸檔的原檔案。在檔案解凍的有效期間過後，標準儲存類型的檔案副本會自動刪除。本文介紹如何使用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)
}

常見使用情境

使用CleanRestoredObject方法清理檔案副本

冷歸檔或者深度冷Archive Storage類型檔案（Object）在資料解凍時會產生一份標準儲存類型的檔案副本用於訪問，檔案副本在解凍時間結束前會收取臨時儲存費用。如果您希望提前結束解凍狀態，且檔案副本不再產生臨時儲存費用，您可以發起CleanRestoredObject請求。請求完成後，Object將恢複為冷凍狀態，不能直接讀取。

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 // 儲存OSS所在的地區
	bucketName string // 儲存空間名稱
	objectName string // 對象名稱
)

// init函數用於初始化命令列參數解析器，並為每個參數設定預設值與協助資訊
func init() {
	flag.StringVar(&region, "region", "", "The region in which the bucket is located. Required.")
	flag.StringVar(&bucketName, "bucket", "", "The name of the bucket. Required.")
	flag.StringVar(&objectName, "object", "", "The name of the object. Required.")
}

func main() {
	// 解析命令列參數
	flag.Parse()

	// 檢查必填參數：region是否為空白
	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// 檢查必填參數：bucket名稱是否為空白
	if len(bucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, bucket name 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.CleanRestoredObjectRequest{
		Bucket: oss.Ptr(bucketName), // 設定儲存空間名稱
		Key:    oss.Ptr(objectName), // 設定對象名稱
	}

	// 發送清理已解凍對象副本的請求
	result, err := client.CleanRestoredObject(context.TODO(), request)
	if err != nil {
		log.Fatalf("failed to clean restored object %v", err)
	}

	// 列印清理結果
	log.Printf("clean restored object result:%#v\n", result)
}

Object Storage Service：Go解凍檔案