云盒Object ACL

更新时间:
复制 MD 格式

Object ACL(访问控制列表)是OSS提供的Object级别访问权限控制功能。当需要为Bucket中的某个Object设置独立于Bucket的访问权限时,可通过Object ACL精确控制单个文件的读写权限。

注意事项

  • 如果未设置Object ACL,即Object的ACL为default,则Object的读写权限和Bucket的读写权限一致。

  • 如果设置了Object ACL,则Object的读写权限优先级高于Bucket的读写权限,即以设置的Object的读写权限为准。例如设置了Object的读写权限为public-read,则无论Bucket是什么读写权限,该Object都可以被匿名访问。

操作步骤

使用阿里云SDK

支持通过Java、Python、Go SDK设置Object ACL(Java SDK要求3.15.0及以上版本,Python SDK V2要求1.1.1及以上版本,Go SDK V2要求v1.2.1及以上版本)。云盒场景下,Python、Go SDK的操作调用方式与公共云OSS一致,创建客户端的方式请参见SDK支持。以下代码示例分别以Java、Python、Go SDK为例。

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.CannedAccessControlList;
import com.aliyun.oss.common.auth.CredentialsProviderFactory;
import com.aliyun.oss.common.auth.EnvironmentVariableCredentialsProvider;
import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.common.auth.DefaultCredentialProvider;

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****";
        // 填写不包含Bucket名称在内的Object完整路径,例如testfolder/exampleobject.txt。
        String objectName = "testfolder/exampleobject.txt";

        // 创建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 {
            // 设置Object的访问权限为私有。
            ossClient.setObjectAcl(bucketName, objectName, CannedAccessControlList.Private);
        } 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();
            }
        }
    }
}            
# -*- coding: utf-8 -*-
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

# 设置Region为云盒所在的地域,例如cn-hangzhou。
cfg.region = "cn-hangzhou"

# 设置云盒ID。设置云盒ID后,SDK会自动将签名产品切换为oss-cloudbox。
cfg.cloud_box_id = "cb-f8z7yvzgwfkl9q0h****"

# 设置访问域名,格式为CloudboxId.Region.oss-cloudbox.aliyuncs.com。
cfg.endpoint = "cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com"

# 创建OSS客户端。
client = oss.Client(cfg)

# 填写Bucket名称,例如examplebucket。
bucket_name = "examplebucket"
# 填写Object完整路径,完整路径中不能包含Bucket名称。
object_name = "testfolder/exampleobject.txt"

# 设置Object的访问权限为私有(private)。
result = client.put_object_acl(oss.PutObjectAclRequest(
    bucket=bucket_name,
    key=object_name,
    object_acl="private",
))
print(f'status code: {result.status_code}')
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的默认配置,并设置访问凭证、地域、云盒ID及访问域名。
	// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		// 设置Region为云盒所在的地域,例如cn-hangzhou。
		WithRegion("cn-hangzhou").
		// 设置访问域名,格式为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名称,例如examplebucket。
	bucketName := "examplebucket"
	// 填写Object完整路径,完整路径中不能包含Bucket名称。
	objectName := "testfolder/exampleobject.txt"

	// 设置Object的访问权限为私有(private)。
	result, err := client.PutObjectAcl(context.TODO(), &oss.PutObjectAclRequest{
		Bucket: oss.Ptr(bucketName),
		Key:    oss.Ptr(objectName),
		Acl:    oss.ObjectACLPrivate,
	})
	if err != nil {
		log.Fatalf("failed to put object acl %v", err)
	}
	log.Printf("put object acl success, status code:%d\n", result.StatusCode)
}

使用命令行工具ossutil

关于使用ossutil设置或修改Object ACL的具体操作,请参见put-object-acl。

使用REST API

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

更多参考

除Object ACL以外,OSS还提供了云盒Bucket ACL、云盒Bucket Policy以及RAM Policy的权限控制策略。