Go合规保留策略

注意事项

• 本文以华东1（杭州）外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见访问域名和数据中心。

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

• 本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient，请参见Go初始化。

背景信息

OSS支持WORM（Write Once Read Many）特性，允许您以不可删除、不可篡改的方式保存和使用数据。

当基于时间的合规保留策略创建24小时后未提交锁定，则该策略自动失效。当合规保留策略锁定后，您可以在Bucket中上传和读取文件（Object），但是在Object的保留时间到期之前，不允许删除Object及合规保留策略，且无法缩短策略保护周期，仅允许延长Object的保留时间。关于合规保留策略的详情，请参见保留策略。

新建合规保留策略

以下代码用于新建合规保留策略：

package main

import (
    "fmt"
    "github.com/aliyun/aliyun-oss-go-sdk/oss"
    "os"
)

func HandleError(err error) {
    fmt.Println("Error:", err)
    os.Exit(-1)
}

func main() {
	// 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
	provider, err := oss.NewEnvironmentVariableCredentialsProvider()
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}
	// 创建OSSClient实例。
	// yourEndpoint填写Bucket对应的Endpoint，以华东1（杭州）为例，填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
	client, err := oss.New("yourEndpoint", "", "", oss.SetCredentialsProvider(&provider))
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}

    // 填写待配置合规保留策略的Bucket名称。
    bucketname := "<yourBucketName>"
    // 指定Object保护天数为60天。
    result,err := client.InitiateBucketWorm(bucketname,60)
    if err != nil {
        HandleError(err)
    }

    fmt.Println(result)
}

取消未锁定的合规保留策略

以下代码用于取消未锁定的合规保留策略：

package main

import (
    "fmt"
    "github.com/aliyun/aliyun-oss-go-sdk/oss"
    "os"
)

func HandleError(err error) {
    fmt.Println("Error:", err)
    os.Exit(-1)
}

func main() {
	// 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
	provider, err := oss.NewEnvironmentVariableCredentialsProvider()
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}
	// 创建OSSClient实例。
	// yourEndpoint填写Bucket对应的Endpoint，以华东1（杭州）为例，填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
	client, err := oss.New("yourEndpoint", "", "", oss.SetCredentialsProvider(&provider))
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}

    // 填写待取消合规保留策略的Bucket名称。
    bucketname := "<yourBucketName>"
    err = client.AbortBucketWorm(bucketname)
    if err != nil {
        HandleError(err)
    }
}            

锁定合规保留策略

以下代码用于锁定合规保留策略：

package main

import (
    "fmt"
    "github.com/aliyun/aliyun-oss-go-sdk/oss"
    "os"
)

func HandleError(err error) {
    fmt.Println("Error:", err)
    os.Exit(-1)
}

func main() {
	// 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
	provider, err := oss.NewEnvironmentVariableCredentialsProvider()
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}
	// 创建OSSClient实例。
	// yourEndpoint填写Bucket对应的Endpoint，以华东1（杭州）为例，填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
	client, err := oss.New("yourEndpoint", "", "", oss.SetCredentialsProvider(&provider))
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}

    // 填写待锁定合规保留策略的Bucket名称。
    bucketname := "<yourBucketName>"
    wormConfig,err := client.GetBucketWorm(bucketname)
    err = client.CompleteBucketWorm(bucketName,wormConfig.WormId)

    if err != nil {
        HandleError(err)
    }
}            

获取合规保留策略

以下代码用于获取合规保留策略配置信息：

package main

import (
    "fmt"
    "github.com/aliyun/aliyun-oss-go-sdk/oss"
    "os"
)

func HandleError(err error) {
    fmt.Println("Error:", err)
    os.Exit(-1)
}

func main() {
	// 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
	provider, err := oss.NewEnvironmentVariableCredentialsProvider()
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}
	// 创建OSSClient实例。
	// yourEndpoint填写Bucket对应的Endpoint，以华东1（杭州）为例，填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
	client, err := oss.New("yourEndpoint", "", "", oss.SetCredentialsProvider(&provider))
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}
    // 填写待获取合规保留策略配置信息的Bucket名称。
    bucketname := "<yourBucketName>"
    wormConfig,err := client.GetBucketWorm(bucketname)

    if err != nil {
        HandleError(err)
    }
    // 查看合规保留策略ID。
    fmt.Println(wormConfig.WormId)
    // 查看合规保留策略的创建时间。
    fmt.Println(wormConfig.CreationDate)
    // 查看合规保留策略状态。未锁定状态下为"InProgress", 锁定状态下为"Locked"。
    fmt.Println(wormConfig.State)
    // 查看Object的保护天数。
    fmt.Println(wormConfig.RetentionPeriodInDays)

}            

延长Object的保护天数

以下代码用于延长已锁定的合规保留策略中Object的保护天数：

package main

import (
    "fmt"
    "github.com/aliyun/aliyun-oss-go-sdk/oss"
    "os"
)

func HandleError(err error) {
    fmt.Println("Error:", err)
    os.Exit(-1)
}

func main() {
	// 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
	provider, err := oss.NewEnvironmentVariableCredentialsProvider()
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}
	// 创建OSSClient实例。
	// yourEndpoint填写Bucket对应的Endpoint，以华东1（杭州）为例，填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
	client, err := oss.New("yourEndpoint", "", "", oss.SetCredentialsProvider(&provider))
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}

    // 填写待延长保护天数的Object所属的Bucket名称。
    bucketname := "<yourBucketName>"
    wormConfig,err := client.GetBucketWorm(bucketname)
    // 延长已锁定的合规保留策略中Object的保护天数为30天。
    err = client.ExtendBucketWorm(bucketName,30,wormConfig.WormId)

    if err != nil {
        HandleError(err)
    }
}

            

相关文档

• 关于规保留策略的完整示例代码，请参见GitHub示例。

• 关于新建合规保留策略的更多信息，请参见InitiateBucketWorm。

• 关于取消未锁定的合规保留策略的更多信息，请参见AbortBucketWorm。

• 关于锁定合规保留策略的更多信息，请参见CompleteBucketWorm。

• 关于获取合规保留策略配置的更多信息，请参见GetBucketWorm。

• 关于延长Object保留天数的更多信息，请参见ExtendBucketWorm。