Bucket permission control
Updated at:2025-11-03
Bucket permission control
Set bucket access permission
-
Basic workflow
- Create a BosClient instance.
- Execute the putBucketAcl method. The putBucketAcl method has no return value, and the setting is successful if no exception is thrown. The request parameters of the
putBucketAclmethod are:
| Parameters | Description |
|---|---|
| BucketName | Bucket name |
| CannedAcl | Bucket access permission, which can be private, public-read, or public-read-write |
| aclStr | Content of the acl file, see Permission Control via Uploading Acl File for details |
- Example code
Plain Text
1 // Set the bucket access permission to private using the cannedAcl method
2 try {
3 await bosClient.putBucketAcl(bucketName, "private", undefined)
4 logger.info(`put bucket acl success`);
5 } catch (bosResponse) {
6 logger.error(`errCode: ${bosResponse.error.code}`)
7 logger.error(`requestId: ${bosResponse.error.requestId}`)
8 logger.error(`errMessage: ${bosResponse.error.message}`)
9 logger.error(`statusCode: ${bosResponse.statusCode}`)
10 }
11 // Set access permissions using the content of the acl file
12 let aclStr = `{
13 "accessControlList":[
14 {
15 "grantee":[{
16 "id":"123456"
17 }],
18 "permission":["FULL_CONTROL"]
19 }
20 ]
21 }`;
22 try {
23 await bosClient.putBucketAcl(bucketName, undefined, aclStr)
24 logger.info(`put bucket acl success`);
25 } catch (bosResponse) {
26 logger.error(`errCode: ${bosResponse.error.code}`)
27 logger.error(`requestId: ${bosResponse.error.requestId}`)
28 logger.error(`errMessage: ${bosResponse.error.message}`)
29 logger.error(`statusCode: ${bosResponse.statusCode}`)
30 }
View bucket permission
-
Basic workflow
- Create a BosClient instance.
- Run the getBucketAcl() method.
- Example code
Plain Text
1 let bucketAcl: GetBucketAclResult;
2 try {
3 bucketAcl = await bosClient.getBucketAcl(bucketName)
4 logger.info(`get bucket acl success, content: ${JSON.stringify(bucketAcl)}`)
5 } catch (bosResponse) {
6 logger.error(`errCode: ${bosResponse.error.code}`)
7 logger.error(`requestId: ${bosResponse.error.requestId}`)
8 logger.error(`errMessage: ${bosResponse.error.message}`)
9 logger.error(`statusCode: ${bosResponse.statusCode}`)
10 }
