Help Center/ OBS BrowserJS SDK/ API Reference/ Object-Related APIs/ GET Object acl
Updated on 2022-02-10 GMT+08:00
View PDF
Share

GET Object acl

API Description

You can use this API to obtain the ACL of an object in a specified bucket.

Method Definition

ObsClient.getObjectAcl

Request Parameter

Field

Type

Optional or Mandatory

Description

Bucket

String

Mandatory

Bucket name

Key

String

Mandatory

Object name

RequestDate

String

or

Date

Optional

Request time

NOTE:

When the parameter type is String, the value must comply with the ISO8601 or RFC822 standards.

VersionId

String

Optional

Object version ID

Returned Result (InterfaceResult)

Field

Type

Description

RequestId

String

Request ID returned by the OBS server

VersionId

String

Object version ID

Owner

Object

Object owner
  

ID

String

ID of the domain to which the object owner belongs

Name

String

Name of the object owner

Delivered

String

Whether the bucket ACL is applied to objects in the bucket

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

Sample Code

obsClient.getObjectAcl({
       Bucket:'bucketname',
       Key : 'objectkey'
},function (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);
                     for(var 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);
              }
       }
});
Parent topic: Object-Related APIs