Help Center/OBS BrowserJS SDK/API Reference/Bucket-Related APIs/GET Bucket logging
Updated on 2025-12-04 GMT+08:00
View PDF

GET Bucket logging

API Description

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

Method Definition

ObsClient.getBucketLogging

Request Parameter

Field

Type

Optional or Mandatory

Description

Bucket

String

Mandatory

Bucket 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.

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

Array

List of grantees' permission information

-

Grantee

Object

Grantee

-

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.getBucketLogging ({
       Bucket : 'bucketname'
},function (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(var i=0;i<result.InterfaceResult.LoggingEnabled.TargetGrants.length;i++){
                                  console.log('Grant[' + i + ']:');
                                  console.log('Grantee[ID]-->' + result.InterfaceResult.LoggingEnabled.TargetGrants[i]['Grantee']['ID']);
                                  console.log('Grantee[URI]-->' + result.InterfaceResult.LoggingEnabled.TargetGrants[i]['Grantee']['URI']);
                                  console.log('Permission-->' + result.InterfaceResult.LoggingEnabled.TargetGrants[i]['Permission']);
                           }
                     }
              }else{
                     console.log('Code-->' + result.CommonMsg.Code);
                     console.log('Message-->' + result.CommonMsg.Message);
              }
       }
});
Parent topic:Bucket-Related APIs