Bucket permission control

Updated at：2025-11-03

Set bucket access permissions

Basic workflow

Instantiate the BOSClient class.
Run the BOSClient.setBucketAcl() method.
The setBucketAcl() method does not return any value. If the setting fails, an exception will be thrown.

Example code

                Java
                
                // Set bucket access permission
client.setBucketAcl(<BucketName>, CannedAccessControlList.Private);

Note: CannedAccessControlList an enumerated type and contains three values: Private, PublicRead and PublicReadWrite, which correspond to relevant permissions respectively. For details, refer to BOS API Documentation - Permission Control Using CannedAcl.

Complete example

                Java
                
            

                import org.json.JSONException;
import android.app.Activity;
import android.os.Bundle;
import com.baidubce.BceClientException;
import com.baidubce.BceServiceException;
import com.baidubce.auth.DefaultBceCredentials;
import com.baidubce.development.R;
import com.baidubce.services.bos.BosClient;
import com.baidubce.services.bos.BosClientConfiguration;
import com.baidubce.services.bos.model.CannedAccessControlList;
​    
public class ExampleActivity extends Activity {
  private String bucketName = <BucketName>;
  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    new Thread(new Runnable() {
        @Override
        public void run() {
            try {
                BosClientConfiguration config = new BosClientConfiguration();
                config.setCredentials(new DefaultBceCredentials(<AccessKeyID>, <SecretAccessKey>));
                config.setEndpoint(<EndPoint>);
                BosClient client = new BosClient(config);
 // Set bucket access permission
 client.setBucketAcl(<BucketName>, CannedAccessControlList.Private);   //Specify the bucket name and set the bucket permission to private
            } catch (BceServiceException e) {
                System.out.println("Error ErrorCode: " + e.getErrorCode());
                System.out.println("Error RequestId: " + e.getRequestId());
                System.out.println("Error StatusCode: " + e.getStatusCode());
                System.out.println("Error Message: " + e.getMessage());
                System.out.println("Error ErrorType: " + e.getErrorType());
            } catch (BceClientException e) {
                System.out.println("Error Message: " + e.getMessage());
            } catch (JSONException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
        }
    }).start();
}
}
            

Set access permissions for a specific user on the bucket

Basic workflow

Instantiate the BOSClient class.
To run the BOSClient.setBucketAcl() method, you should create an instance of SetBucketAclRequest to provide the required information.
The setBucketAcl() method does not return any value. If the setting fails, an exception will be thrown.

Example code

                Java
                
            

                List<Grant> grants = new ArrayList<Grant>();
List<Grantee> grantee = new ArrayList<Grantee>();
List<Permission> permission = new ArrayList<Permission>();
 //Grant permission to user
grantee.add(new Grantee(<UserID>);
 //Set permissions
permission.add(Permission.READ);
grants.add(new Grant().withGrantee(grantee).withPermission(permission));
 //Encapsulate into request
SetBucketAclRequest request = new SetBucketAclRequest(<BucketName>, grants);
 //Set bucket access permission
client.setBucketAcl(request);
            

Note: The permission settings in Permission include three values: READ, WRITE and FULL_CONTROL, which correspond to relevant permissions respectively. For details, refer to BOS API Documentation - [Permission Control via Uploading ACL Files](BOS/API Reference/Access control.md#Permission control by uploading ACL files).

Complete example

                Java
                
            

                import java.util.ArrayList;
import java.util.List;
import org.json.JSONException;
import android.app.Activity;
import android.os.Bundle;
import com.baidubce.BceClientException;
import com.baidubce.BceServiceException;
import com.baidubce.auth.DefaultBceCredentials;
import com.baidubce.development.R;
import com.baidubce.services.bos.BosClient;
import com.baidubce.services.bos.BosClientConfiguration;
import com.baidubce.services.bos.model.Grant;
import com.baidubce.services.bos.model.Grantee;
import com.baidubce.services.bos.model.Permission;
import com.baidubce.services.bos.model.SetBucketAclRequest;
​    
public class ExampleActivity extends Activity {
  private String bucketName = <BucektName>;
  List<Grant> grants = new ArrayList<Grant>();
  List<Grantee> grantee = new ArrayList<Grantee>();
  List<Permission> permission = new ArrayList<Permission>();
  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    new Thread(new Runnable() {
        @Override
        public void run() {
            try {
                BosClientConfiguration config = new BosClientConfiguration();
                config.setCredentials(new DefaultBceCredentials(<AccessKeyID>, <SecretAccessKey>));
                config.setEndpoint(<EndPoint>);
                BosClient client = new BosClient(config);
 //Grant permission to specific user
                grantee.add(new Grantee("UserId_1"));
                grantee.add(new Grantee("UserId_2"));
 //Grant permission to Everyone
                grantee.add(new Grantee("*"));
 //Set permissions
                permission.add(Permission.READ);
                permission.add(Permission.WRITE);
                grants.add(new Grant().withGrantee(grantee).withPermission(permission));
 //Encapsulate request
                SetBucketAclRequest request = new SetBucketAclRequest(<BucketName>, grants);
 //Set bucket access permission
                client.setBucketAcl(request);
            } catch (BceServiceException e) {
                System.out.println("Error ErrorCode: " + e.getErrorCode());
                System.out.println("Error RequestId: " + e.getRequestId());
                System.out.println("Error StatusCode: " + e.getStatusCode());
                System.out.println("Error Message: " + e.getMessage());
                System.out.println("Error ErrorType: " + e.getErrorType());
            } catch (BceClientException e) {
                System.out.println("Error Message: " + e.getMessage());
            } catch (JSONException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
        }
    }).start();
}
}
            

Create Bucket

View bucket list