All Products
Search
Document Center

Object Storage Service:Manage bucket ACLs

Last Updated:Oct 18, 2023

A bucket is a container for objects stored in Object Storage Service (OSS). All objects in OSS are stored in buckets. This topic describes how to configure and query the access control list (ACL) of a bucket.

Usage notes

  • In this topic, the public endpoint of the China (Hangzhou) region is used. If you want to access OSS by using other Alibaba Cloud services in the same region as OSS, use an internal endpoint. For more information about the regions and endpoints supported by OSS, see Regions and endpoints.

  • In this topic, an OSSClient instance is created by using an OSS endpoint. If you want to create an OSSClient instance by using custom domain names or Security Token Service (STS), see Initialization.

  • To configure the ACL of a bucket, you must have the oss:PutBucketAcl permission. To query the ACL of a bucket, you must have the oss:GetBucketAcl permission. For more information, see Attach a custom policy to a RAM user.

Configure the ACL of a bucket

The following table describes the bucket ACLs.

ACL

Description

Method

Private

Only the bucket owner and authorized users have read and write permissions on objects in the bucket. Other users cannot access objects in the bucket.

CannedAccessControlList.Private

Public-read

Only the bucket owner and authorized users have read and write permissions on objects in the bucket. Other users have only read permissions on objects in the bucket. Exercise caution when you set the bucket ACL to this value.

CannedAccessControlList.PublicRead

Public-read-write

All users have read and write permissions on the objects in the bucket. Exercise caution when you set the bucket ACL to this value.

CannedAccessControlList.PublicReadWrite

The following code provides an example on how to configure the ACL of a bucket:

using Aliyun.OSS;

// Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. 
var endpoint = "yourEndpoint";
// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");
// Specify the name of the bucket. 
var bucketName = "yourBucketName";

// Initialize an OSSClient instance. 
var client = new OssClient(endpoint, accessKeyId, accessKeySecret);

public void SetBucketAcl(string bucketName)
{
    try
    {
        // Set the ACL of the bucket to public-read. 
        client.SetBucketAcl(bucketName, CannedAccessControlList.PublicRead);
        Console.WriteLine("Set bucket ACL succeeded");
    }
    catch (Exception ex)
    {
        Console.WriteLine("Set bucket ACL failed. {0}", ex.Message);
    }
}

Query the ACL of a bucket

The following sample code provides an example on how to query the ACL of a bucket:

using Aliyun.OSS;
// Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. 
var endpoint = "yourEndpoint";
// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");
// Initialize an OSSClient instance. 
var client = new OssClient(endpoint, accessKeyId, accessKeySecret);

// Query the ACL of the bucket. 
public void GetBucketAcl(string bucketName)
{
    try
    {  
        // Specify the name of the bucket. 
        string bucketName = "yourBucketName";
        var acl = client.GetBucketAcl(bucketName);

        Console.WriteLine("Get bucket ACL success", acl.ACL.ToString());
    }
    catch (Exception ex)
    {
        Console.WriteLine("Get bucket ACL failed. {0}", ex.Message);
    }
}

References

  • For the complete sample code that is used to configure the ACL of a bucket, visit GitHub.

  • For the complete sample code that is used to query the ACL of a bucket, visit GitHub.

  • For more information about the API operation that you can call to configure the ACL of a bucket, see PutBucketAcl.

  • For more information about the API operation that you can call to query the ACL of a bucket, see GetBucketAcl.