GET Bucket acl
API Description
You can use this API to obtain a bucket ACL.
Method Definition
ObsClient.getBucketAcl
Request Parameter
Field |
Type |
Optional or Mandatory |
Description |
---|---|---|---|
Bucket |
String |
Mandatory |
Bucket name |
Returned Result (InterfaceResult)
Field |
Type |
Description |
||
---|---|---|---|---|
RequestId |
String |
Request ID returned by the OBS server |
||
Owner |
Object |
Bucket owner |
||
ID |
String |
ID of the domain to which the bucket owner belongs |
||
Name |
String |
Name of the bucket owner |
||
Grants |
Array |
List of grantees' permission information |
||
Grantee |
Object |
Grantee |
||
Name |
String |
Grantee name. This field is null when Type of Grantee is Group. |
||
ID |
String |
ID of the domain to which the grantee belongs. This field is null when Type of Grantee is Group. |
||
URI |
String |
Grantee group. This field is null when Type of Grantee is CanonicalUser. |
||
Permission |
String |
Granted permission |
||
Delivered |
String |
Whether an object inherits the ACL of its residing bucket |
Sample Code
obsClient.getBucketAcl ({ Bucket : 'bucketname' },(err, result) => { if(err){ console.error('Error-->' + err); }else{ if(result.CommonMsg.Status < 300){ console.log('RequestId-->' + result.InterfaceResult.RequestId); console.log('Owner[ID]-->' + result.InterfaceResult.Owner.ID); console.log('Grants:'); for(let i=0;i<result.InterfaceResult.Grants.length;i++){ console.log('Grant[' + i + ']:'); console.log('Grantee[ID]-->' + result.InterfaceResult.Grants[i]['Grantee']['ID']); console.log('Grantee[URI]-->' + result.InterfaceResult.Grants[i]['Grantee']['URI']); console.log('Permission-->' + result.InterfaceResult.Grants[i]['Permission']); } }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.