Overview

This document provides an overview of APIs and SDK code samples related to logging.

Setting Logging Configuration

API description

This API is used to enable logging for a source bucket and store its access logs in the specified destination bucket.

Note：

Only the source bucket owner can request this operation.

Sample request

Sample 1: configure the source bucket sourcebucket-1250000000 so that its logs are delivered to the path bucket-logging-prefix/ under the destination bucket targetbucket-1250000000.

cos.putBucketLogging({
    Bucket: 'sourcebucket-1250000000',  /* Required */
    Region: 'ap-beijing',                                  /* Required */
    BucketLoggingStatus: {              /* Required */
        LoggingEnabled: {
            TargetBucket: 'targetbucket-1250000000',
            TargetPrefix: 'bucket-logging-prefix/'
        }
    }
}, function(err, data) {
    console.log(err || data);
});

Sample 2: disable log delivery to the destination bucket sourcebucket-1250000000.

cos.putBucketLogging({
    Bucket: 'sourcebucket-1250000000',  /* Required */
    Region: 'ap-beijing',                                  /* Required */
    BucketLoggingStatus: {}             /* Required */
}, function(err, data) {
    console.log(err || data);
});

Parameter description

Callback function description

function(err, data) { ... }

Querying Logging Configuration

API description

This API is used to query the logging configuration of a source bucket.

Note：

Only the source bucket owner can request this operation.

Sample request

cos.getBucketLogging({
    Bucket: 'sourcebucket-1250000000',  /* Required */
    Region: 'ap-beijing',                                  /* Required */
}, function(err, data) {
    console.log(err || data);
});

Sample response

{
    "BucketLoggingStatus": {
        "LoggingEnabled": {
            "TargetBucket": "targetbucket-1250000000",
            "TargetPrefix": "bucket-logging-prefix/"
        }
    },
    "statusCode": 200,
    "headers": {}
}

Parameter description

Callback function description

function(err, data) { ... }