-
API Reference
- Overview
- Initialization
- Pre-defined Constants
-
Bucket-Related APIs
- Before You Start
- HEAD Bucket
- DELETE Bucket
- GET Objects
- GET Object versions
- List Multipart uploads
- Obtain Bucket Metadata
- GET Bucket location
- GET Bucket storageinfo
- PUT Bucket quota
- GET Bucket quota
- Set Bucket storagePolicy
- GET Bucket storagePolicy
- PUT Bucket acl
- GET Bucket acl
- PUT Bucket logging
- GET Bucket logging
- PUT Bucket policy
- GET Bucket policy
- DELETE Bucket policy
- PUT Bucket lifecycle
- GET Bucket lifecycle
- DELETE Bucket lifecycle
- PUT Bucket website
- GET Bucket website
- DELETE Bucket website
- PUT Bucket versioning
- GET Bucket versioning
- GET Bucket cors
- DELETE Bucket cors
- PUT Bucket tagging
- GET Bucket tagging
- DELETE Bucket tagging
- Object-Related APIs
- Other APIs
- Change History
- General Reference
Copied.
PUT Bucket acl
API Description
You can use this API to set the ACL for a bucket.
Method Definition
ObsClient.setBucketAcl
Request Parameter
Field |
Type |
Optional or Mandatory |
Description |
||
---|---|---|---|---|---|
Bucket |
String |
Mandatory |
Bucket name |
||
RequestDate |
String or Date |
Optional |
Request time When the parameter type is String, the value must comply with the ISO8601 or RFC822 standards. |
||
ACL |
String |
Optional |
|||
Owner |
Object |
Optional |
Bucket owner |
||
ID |
String |
Mandatory |
ID of the domain to which the bucket owner belongs |
||
Grants |
Array |
Optional |
List of grantees' permission information |
||
Grantee |
Object |
Mandatory |
Grantee |
||
Type |
String |
Mandatory |
|||
ID |
String |
Mandatory when Type is CanonicalUser. In other cases, leave it null. |
ID of the domain to which the grantee belongs |
||
URI |
String |
Mandatory when Type is Group. In other cases, leave it null. |
|||
Permission |
String |
Mandatory |
|||
Delivered |
Boolean |
Optional |
Whether an object inherits the ACL of its residing bucket |
- Owner and Grants must be used together and they cannot be used with ACL.
- You must set either the two fields or ACL.
Returned Result (InterfaceResult)
Field |
Type |
Description |
---|---|---|
RequestId |
String |
Request ID returned by the OBS server |
Sample Code
obsClient.setBucketAcl ({ Bucket : 'bucketname', Owner:{ID:'ownerid'}, Grants:[ {Grantee:{Type:'CanonicalUser',ID:'userid'},Permission:obsClient.enums.PermissionRead}, {Grantee:{Type:'CanonicalUser',ID:'userid'},Permission:obsClient.enums.PermissionWrite}, {Grantee:{Type:'Group', URI: obsClient.enums.GroupLogDelivery},Permission: obsClient.enums.PermissionWrite}, {Grantee:{Type:'Group', URI: obsClient.enums.GroupLogDelivery},Permission: obsClient.enums.PermissionWriteAcp} ] },function (err, result) { if(err){ console.error('Error-->' + err); }else{ if(result.CommonMsg.Status < 300){ console.log('RequestId-->' + result.InterfaceResult.RequestId); }else{ console.log('Code-->' + result.CommonMsg.Code); console.log('Message-->' + result.CommonMsg.Message); } } });
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot