Help Center> OBS Nodejs SDK> API Reference> Bucket-Related APIs> PUT Bucket acl
Updated on 2022-02-10 GMT+08:00
View PDF

PUT Bucket acl

API Description

You can use this API to set the ACL of a bucket.

Method Definition

ObsClient.setBucketAcl

Request Parameter

Field

Type

Optional or Mandatory

Description

Bucket

String

Mandatory

Bucket name

ACL

String

Optional

Pre-defined access control policy

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

Available Grantee Types

ID

String

If Type is CanonicalUser, this field is mandatory. If Type is Group, this field must be null.

ID of the domain to which the grantee belongs

URI

String

If Type is Group, this field is mandatory. If Type is CanonicalUser, this field must be null.

Available Grantee Groups

Permission

String

Mandatory

Granted permission

Delivered

Boolean

Optional

Whether an object inherits the ACL of its residing bucket
  • Owner and Grants must be used together. These two fields are mutually exclusive with ACL. When ACL is configured, these two fields are unavailable, and vice versa.
  • 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}
       ]
},(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);
              }
       }
});
Parent topic: Bucket-Related APIs