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 from other Alibaba Cloud services in the same region as OSS, use an internal endpoint. For more information about OSS regions and endpoints, see Regions and endpoints.
In this topic, access credentials are obtained from environment variables. For more information about how to configure access credentials, see Configure access credentials using OSS SDK for Python 1.0.
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:PutBucketAclpermission. To query the ACL of a bucket, you must have theoss:GetBucketAclpermission. For more information, see Attach a custom policy to a RAM user.
Set the ACL for 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 the objects. | oss2.BUCKET_ACL_PRIVATE |
public-read | The bucket owner and authorized users have read and write permissions on objects in the bucket. Other users have only read permissions on the objects. Use this permission with caution. | oss2.BUCKET_ACL_PUBLIC_READ |
public-read-write | All users have read and write permissions on objects in the bucket. Use this permission with caution. | oss2.BUCKET_ACL_PUBLIC_READ_WRITE |
The following sample code provides an example on how to configure the ACL of a bucket:
# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 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.
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
# Specify the Endpoint for the region where the bucket is located. For example, if the bucket is in the China (Hangzhou) region, set the Endpoint to https://oss-cn-hangzhou.aliyuncs.com.
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# Specify the region where the bucket is located, such as cn-hangzhou. Note that this parameter is required for V4 signatures.
region = "cn-hangzhou"
# Set yourBucketName to the name of the bucket.
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)
# Set the bucket ACL to private.
bucket.put_bucket_acl(oss2.BUCKET_ACL_PRIVATE)Obtaining bucket access permissions
The following sample code provides an example on how to query the ACL of a bucket:
# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 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.
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
# Specify the Endpoint for the region where the bucket is located. For example, if the bucket is in the China (Hangzhou) region, set the Endpoint to https://oss-cn-hangzhou.aliyuncs.com.
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# Specify the region where the bucket is located, such as cn-hangzhou. Note that this parameter is required for V4 signatures.
region = "cn-hangzhou"
# Set yourBucketName to the name of the bucket.
bucket = oss2.Bucket(auth, endpoint, "yourBucketName", region=region)
# Get the bucket ACL.
print(bucket.get_bucket_acl().acl)References
For the complete sample code that shows how to manage bucket ACLs, see GitHub.
For more information about the API operation for setting a bucket ACL, see PutBucketAcl.
For more information about the API operation for retrieving a bucket ACL, see GetBucketAcl.