Overview

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

Setting Log Management

Feature description

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

Method prototype

PutBucketLoggingResult putBucketLogging(PutBucketLoggingRequest request) throws CosXmlClientException, CosXmlServiceException;

void putBucketLoggingAsync(PutBucketLoggingRequest request, CosXmlResultListener cosXmlResultListener);

Sample request

String srcBucket = "examplebucket-1250000000"; // Format: BucketName-APPID
String targetBucket = "examplebucket-1250000000"; // Format: BucketName-APPID
PutBucketLoggingRequest putBucketLoggingRequest = new PutBucketLoggingRequest(srcBucket);
putBucketLoggingRequest.setTargetBucket(targetBucket);
putBucketLoggingRequest.setTargetPrefix("objectPrefix");

// Use the sync method
try {
    PutBucketLoggingResult putBucketLoggingResult = cosXmlService.putBucketLogging(putBucketLoggingRequest);
} catch (CosXmlClientException e) {
    e.printStackTrace();
} catch (CosXmlServiceException e) {
    e.printStackTrace();
}

// Use the async callback to request
cosXmlService.putBucketLoggingAsync(putBucketLoggingRequest, new CosXmlResultListener() {
    @Override
    public void onSuccess(CosXmlRequest request, CosXmlResult result) {
        PutBucketLoggingResult putBucketLoggingResult = (PutBucketLoggingResult) result;
    }

    @Override
    public void onFail(CosXmlRequest cosXmlRequest, CosXmlClientException clientException, CosXmlServiceException serviceException)  {
    }
});

Parameter description

Response description

Querying Log Management

Feature description

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

Method prototype

GetBucketLoggingResult getBucketLogging(GetBucketLoggingRequest request) throws CosXmlClientException, CosXmlServiceException;

void getBucketLoggingAsync(GetBucketLoggingRequest request, CosXmlResultListener cosXmlResultListener);

Sample request

String bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
GetBucketLoggingRequest getBucketLoggingRequest = new GetBucketLoggingRequest(bucket);
// Set signature verification host. All headers are to be verified by default
Set<String> headerKeys = new HashSet<>();
headerKeys.add("Host");
getBucketLoggingRequest.setSignParamsAndHeaders(null, headerKeys);
// Use the sync method
try {
    GetBucketLoggingResult getBucketLoggingResult = cosXmlService.getBucketLogging(getBucketLoggingRequest);
} catch (CosXmlClientException e) {
    e.printStackTrace();
} catch (CosXmlServiceException e) {
    e.printStackTrace();
}

// Use the async callback to request
cosXmlService.getBucketLoggingAsync(getBucketLoggingRequest, new CosXmlResultListener() {
    @Override
    public void onSuccess(CosXmlRequest request, CosXmlResult result) {
        GetBucketLoggingResult getBucketLoggingResult = (GetBucketLoggingResult)result;
    }

    @Override
    public void onFail(CosXmlRequest cosXmlRequest, CosXmlClientException clientException, CosXmlServiceException serviceException)  {
    }
});

Parameter description

Response description