• Object Storage Service

obs
  1. Help Center
  2. Object Storage Service
  3. API Reference (Node.js SDK)
  4. Bucket-Related APIs
  5. GET Bucket logging

GET Bucket logging

API Description

You can use this API to obtain the access logging settings of a bucket.

Method Definition

ObsClient.getBucketLoggingConfiguration(parameter, callback)

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

LoggingEnabled

Object

Log configuration information

  

TargetBucket

String

Target bucket for which logs are generated

TargetPrefix

String

Name prefix of a to-be-logged object in the target bucket

TargetGrants

Object

Grantees' ACL information

  

Grant

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.getBucketLoggingConfiguration ({
       Bucket : 'bucketname'
},(err, result) => {
       if(err){
              console.error('Error-->' + err);
       }else{
              if(result.CommonMsg.Status < 300){
                     console.log('RequestId-->' + result.InterfaceResult.RequestId);
                     if(result.InterfaceResult.LoggingEnabled){
                           console.log('TargetBucket-->' + result.InterfaceResult.LoggingEnabled.TargetBucket);
                           console.log('TargetPrefix-->' + result.InterfaceResult.LoggingEnabled.TargetPrefix);
                           for(let i=0;i<result.InterfaceResult.LoggingEnabled.TargetGrants.Grant.length;i++){
                                  console.log('Grant[' + i + ']:');
                                  console.log('Grantee[ID]-->' + result.InterfaceResult.LoggingEnabled.TargetGrants.Grant[i]['Grantee']['ID']);
                                  console.log('Grantee[Name]-->' + result.InterfaceResult.LoggingEnabled.TargetGrants.Grant[i]['Grantee']['Name']);
                                  console.log('Grantee[URI]-->' + result.InterfaceResult.LoggingEnabled.TargetGrants.Grant[i]['Grantee']['URI']);
                                  console.log('Permission-->' + result.InterfaceResult.LoggingEnabled.TargetGrants.Grant[i]['Permission']);
                           }
                     }
              }else{
                     console.log('Code-->' + result.CommonMsg.Code);
                     console.log('Message-->' + result.CommonMsg.Message);
              }
       }
});