Bucket Logging Management

Updated at：2025-11-03

Application scenarios

Create a BosClient.
Execute the doesBucketExist() method.

If you expect to track requests accessing a certain bucket in BOS, you can enable the access logging function for that bucket

Set access logs

This API is designed to enable bucket access logs and specify the bucket for storing logs and the file prefix of access logs. For access log rules, refer to [Log Naming Rules](BOS/Developer Guide/Bucket Basic Operations/Set access logs.md#Log naming rules) and [Log Format](BOS/Developer Guide/Bucket Basic Operations/Set access logs.md#Log format).

Basic workflow
1. Create a BosClient instance.
2. Run the putBucketLogging() method.
Example code

                JavaScript
                
            

                    const logInfo = {
        targetBucket: 'targetBucket',
        targetPrefix: 'targetPrefix',
    };
    client.putBucketLogging(<BucketName>,<logInfo>)            
      .then(function(response) {
          if(response) {
              console.log('Bucket exists');
          }
          else {
              console.log('Bucket not exists');
          }
      })
      .catch(function() {});
            

Request parameters

Parameters	Types	Meaning	Required or not
BucketName	string	Bucket name	Yes
logInfo	Record<{targetBuckett: string, targetPrefix: string}>	Log configuration information	Yes
+targetBucket	string	Specified bucket for storing access logs	Yes
+targetPrefix	string	Specified bucket for storing access logs	No

Get access log configuration

This API retrieves the access log configuration of a bucket.

Basic workflow
1. Create a BosClient instance.
2. Run the getBucketLogging() method.
Example code

                JavaScript
                
            

                    client.getBucketLogging(<BucketName>)            
      .then(function(response) {
          if(response) {
              console.log('Bucket exists');
          }
          else {
              console.log('Bucket not exists');
          }
      })
      .catch(function() {});
            

Delete access logs

Basic workflow
1. Create a BosClient instance.
2. Run the deleteBucketLogging() method.
Example code

                JavaScript
                
            

                    client.deleteBucketLogging(<BucketName>)            
      .then(function(response) {
          if(response) {
              console.log('Bucket exists');
          }
          else {
              console.log('Bucket not exists');
          }
      })
      .catch(function() {});
            

Overview

Bucket Lifecycle Management