如何实现云盒Bucket的版本控制-对象存储(OSS)-阿里云帮助中心

版本控制是针对云盒Bucket的数据保护功能。开启版本控制后，针对数据的覆盖和删除操作将会以历史版本的形式保存下来。您在错误覆盖或者删除对象（Object）后，能够将Bucket中存储的Object恢复至任意时刻的历史版本。

前提条件

仅华东1（杭州）、华东2（上海）、华南1（深圳）、华南2（河源）、华北2（北京）、西南1（成都）地域支持使用OSS ON云盒服务。
已购买云盒。
已在云盒内创建专有网络VPC和交换机。
已联系技术支持申请创建云盒VPC内网SingleTunnel网络类型。

使用场景

建议您在以下场景中使用版本控制，为您的数据安全提供更好的保障。

数据误删除
当前OSS不提供回收站功能。您删除OSS数据后想要找回时，可使用版本控制功能，恢复已删除的数据。
文件被覆盖
对于网盘、在线协作类产品，文件会被频繁修改，针对文件的编辑会产生大量的临时版本。您可以使用版本控制功能找回某个时间点的版本。

注意事项

权限说明

只有云盒Bucket的拥有者及授予了oss-cloudbox:PutBucketVersioning权限的RAM用户才能配置版本控制。
功能互斥

如果Bucket已开启版本控制，上传文件时附加的覆盖同名文件请求头x-oss-forbid-overwrite将不生效。更多信息，请参见PutObject。

版本控制状态

Bucket包含三种版本控制状态，分别为未开启、开启或者暂停。

默认情况下，Bucket版本控制状态为“未开启”。一旦Bucket处于“开启”版本状态，将无法返回至“未开启”状态。但是，您可以暂停Bucket的版本控制状态。
当Bucket版本控制处于“开启”状态时，OSS将为新上传的Object生成全局唯一的随机字符串版本ID。
当Bucket版本控制处于“暂停”状态时，OSS将为新上传的Object生成特殊字符串为“null”的版本ID。

说明

当云盒Bucket版本控制处于“开启”状态时，由于Object的每个版本都被保存下来，每个版本都会占用存储空间。建议结合您的使用场景通过生命周期规则删除不再需要的历史版本。

数据保护

以下表格说明了不同版本控制状态下，覆盖和删除Object的行为差异。

版本控制状态	覆盖Object	删除Object
未开启	已有Object被直接覆盖，且无法恢复，只能获取最新版本Object。	直接删除，无法再获取此Object。
开启	生成新版本，历史版本不受影响。	Object被标记为已删除状态，历史版本不受影响，可恢复。
暂停	生成新版本，如果已存在相同的暂停期版本则覆盖，其他历史版本不受影响。	Object被标记为已删除状态，如果已存在相同的暂停期版本标记则覆盖，其他历史版本不受影响。

开启版本控制

开启版本控制后，OSS会为Bucket中所有Object的每个版本指定唯一的versionId。

使用OSS控制台

新建云盒Bucket时开启版本控制
1. 登录OSS管理控制台。
2. 在左侧导航栏，选择数据服务 > 云盒Bucket，然后单击左上角的创建 Bucket。
3. 在创建 Bucket页面配置各项参数。
  
  其中，版本控制区域选择开通。其他参数的配置详情，请参见创建云盒Bucket。
4. 单击确定。
对已创建的云盒Bucket开启版本控制
1. 在左侧导航栏，选择数据服务 > 云盒Bucket，然后在Bucket列表中单击目标Bucket。
2. 在左侧导航栏，选择数据安全 > 版本控制。
3. 单击版本控制右侧的开启。

使用阿里云SDK

支持通过Java、Python、Go SDK开启版本控制（Java SDK要求3.15.0及以上版本，Python SDK V2要求1.1.1及以上版本，Go SDK V2要求v1.2.1及以上版本）。云盒场景下，Python、Go SDK的操作调用方式与公共云OSS一致，创建客户端的方式请参见SDK支持。

Java

import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.*;
import com.aliyun.oss.common.auth.DefaultCredentialProvider;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.common.auth.CredentialsProviderFactory;
import com.aliyun.oss.common.auth.EnvironmentVariableCredentialsProvider;

public class Demo {
    public static void main(String[] args) throws Exception {
        // 填写云盒Bucket的数据域名。
        String endpoint = "https://cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com";
        // 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // 填写云盒Bucket名称，例如examplebucket。
        String bucketName = "examplebucket";
        // 填写云盒Bucket所在地域。
        String region = "cn-hangzhou";
        // 填写云盒ID。
        String cloudBoxId = "cb-f8z7yvzgwfkl9q0h****";

        // 创建OSSClient实例。
        // 当OSSClient实例不再使用时，调用shutdown方法以释放资源。
        ClientBuilderConfiguration conf = new ClientBuilderConfiguration();
        conf.setSignatureVersion(SignVersion.V4);
        OSS ossClient = OSSClientBuilder.create()
                .endpoint(endpoint)
                .credentialsProvider(new DefaultCredentialProvider(credentialsProvider.getCredentials()))
                .clientConfiguration(conf)
                .region(region)
                .cloudBoxId(cloudBoxId)
                .build();

        try {
            // 设置Bucket为开启版本控制状态。
            BucketVersioningConfiguration configuration = new BucketVersioningConfiguration();
            configuration.setStatus(BucketVersioningConfiguration.ENABLED);
            SetBucketVersioningRequest request = new SetBucketVersioningRequest(bucketName, configuration);
            ossClient.setBucketVersioning(request);
        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "but was rejected with an error response for some reason.");
            System.out.println("Error Message:" + oe.getErrorMessage());
            System.out.println("Error Code:" + oe.getErrorCode());
            System.out.println("Request ID:" + oe.getRequestId());
            System.out.println("Host ID:" + oe.getHostId());
        } catch (ClientException ce) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
    }
}

Python

import alibabacloud_oss_v2 as oss

# 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()
# 使用SDK的默认配置。
cfg = oss.config.load_default()
cfg.credentials_provider = credentials_provider
# 填写云盒Bucket所在地域，例如cn-hangzhou。
cfg.region = "cn-hangzhou"
# 填写云盒ID。设置云盒ID后，SDK会自动将签名产品切换为oss-cloudbox。
cfg.cloud_box_id = "cb-f8z7yvzgwfkl9q0h****"
# 填写云盒Bucket的数据域名，格式为CloudboxId.Region.oss-cloudbox.aliyuncs.com。
cfg.endpoint = "cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com"
# 创建OSS客户端。
client = oss.Client(cfg)

# 开启云盒Bucket的版本控制。
result = client.put_bucket_versioning(oss.PutBucketVersioningRequest(
    bucket="examplebucket",
    versioning_configuration=oss.VersioningConfiguration(
        status="Enabled",
    ),
))
print(f'status code: {result.status_code}, request id: {result.request_id}')

package main

import (
	"context"
	"log"

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

func main() {
	// 使用SDK的默认配置，并从环境变量中获取访问凭证。
	// 运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		// 填写云盒Bucket所在地域，例如cn-hangzhou。
		WithRegion("cn-hangzhou").
		// 填写云盒Bucket的数据域名，格式为CloudboxId.Region.oss-cloudbox.aliyuncs.com。
		WithEndpoint("cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com").
		// 填写云盒ID。设置云盒ID后，SDK会自动将签名产品切换为oss-cloudbox。
		WithCloudBoxId("cb-f8z7yvzgwfkl9q0h****")

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

	// 开启云盒Bucket的版本控制。
	request := &oss.PutBucketVersioningRequest{
		Bucket: oss.Ptr("examplebucket"),
		VersioningConfiguration: &oss.VersioningConfiguration{
			Status: oss.VersionEnabled,
		},
	}
	result, err := client.PutBucketVersioning(context.TODO(), request)
	if err != nil {
		log.Fatalf("failed to put bucket versioning %v", err)
	}
	log.Printf("put bucket versioning result:%#v\n", result)
}

使用命令行工具ossutil

您可以使用命令行工具ossutil来设置指定存储空间的版本控制状态，ossutil的安装请参见安装ossutil。

以下命令用于启用指定存储空间的版本控制功能。

ossutil api put-bucket-versioning --bucket examplebucket --versioning-configuration "{\"Status\":\"Enabled\"}"

关于该命令的更多信息，请参见put-bucket-versioning。

使用REST API

如果您的程序自定义要求较高，您可以直接发起REST API请求。直接发起REST API请求需要手动编写代码计算签名。更多信息，请参见PutBucketVersioning。

暂停版本控制

开启版本控制后，您还可以随时暂停版本控制以停止在Bucket中继续累积同一Object的新版本。暂停版本控制后，OSS将为新生成的Object添加versionId为null的版本，已有的历史版本Object将继续保留。