Help Center> OBS Node.js SDK> API Reference> Bucket-Related APIs> PUT Bucket logging
View PDF

PUT Bucket logging

API Description

You can use this API to set the access logging settings for a bucket.

Method Definition

ObsClient.setBucketLogging

Request Parameter

Field

Type

Optional or Mandatory

Description

Bucket

String

Mandatory

Bucket name

Agency

String

Mandatory when configuring bucket logging

Agency name

LoggingEnabled

Object

Optional

Log configuration information
  

TargetBucket

String

Mandatory

Target bucket for which logs are generated

TargetPrefix

String

Mandatory

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

TargetGrants

Array

Optional

List of grantees' permission information
  

Grantee

Object

Optional

Grantee
  

Type

String

Mandatory

Grantee type

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.

Grantee group

Permission

String

Optional

Granted permission

Returned Result (InterfaceResult)

Field

Type

Description

RequestId

String

Request ID returned by the OBS server

Sample Code

obsClient.setBucketLogging ({
       Bucket : 'bucketname',
       Agency : 'your agency',
       LoggingEnabled:{
              TargetBucket:'targetbucketname',
              TargetPrefix:'prefix',
              TargetGrants:[
                         {Grantee: {Type:'CanonicalUser',ID:'userid'},Permission: obsClient.enums.PermissionRead},
                         {Grantee: {Type:'Group',URI: obsClient.enums.GroupAllUsers},Permission: obsClient.enums.PermissionRead}                    
              ]
       }
},(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