Overview

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

Setting Logging

API description

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

Method prototype

CosResult CosAPI::PutBucketLogging(const PutBucketLoggingReq& request, PutBucketLoggingResp* response);

Sample request

qcloud_cos::CosConfig config("./config.json");
qcloud_cos::CosAPI cos(config);
std::string bucket_name = "examplebucket-1250000000";
qcloud_cos::PutBucketLoggingReq req(bucket_name);
qcloud_cos::PutBucketLoggingResp resp;

qcloud_cos::LoggingEnabled rules;
rules.SetTargetBucket(TargetBucketname);  // Set the destination bucket to store the logs.
rules.SetTargetPrefix(TargetPrefix);  // Set the path in the destination bucket to store the logs.    
req.SetLoggingEnabled(rules);

qcloud_cos::CosResult result = cos.PutBucketLogging(req, &resp);

if (result.IsSucc()) {
    // Request successful. You can obtain the static website configuration via `resp`.
} else {
    // Request failed. You can call the CosResult member functions to output the error information, such as requestID.
} 

Parameter description

PutBucketLoggingReq provides the following method to configure logging for the bucket:

void SetLoggingEnabled(const LoggingEnabled& rules);

LoggingEnabledt provides the following methods for the configuration:

class LoggingEnabled {
public:
    void SetTargetBucket(const std::string &targetbucket);
    void SetTargetPrefix(const std::string &targetprefix);

Querying Logging

API description

This API (GET Bucket logging) is used to query the logging configuration of a bucket.

Method prototype

CosResult CosAPI::GetBucketLogging(const GetBucketLoggingReq& request, GetBucketLoggingResp* response);

Sample request

qcloud_cos::CosConfig config("./config.json");
qcloud_cos::CosAPI cos(config);
std::string bucket_name = "examplebucket-1250000000";
qcloud_cos::GetBucketLoggingReq req(bucket_name);
qcloud_cos::GetBucketLoggingResp resp;

qcloud_cos::CosResult result = cos.GetBucketLogging(req, &resp);

if (result.IsSucc()) {
    // Request successful. You can obtain the bucket logging configuration via `resp`.
} else {
    // Request failed. You can call the CosResult member functions to output the error information, such as requestID.
} 

Parameter description

GetBucketLoggingResp provides the following method to obtain the logging configuration:

LoggingEnabled GetLoggingEnabled() const;