tencent cloud

Feedback

Log Management

Last updated: 2022-01-24 12:37:09

    Overview

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

    API Operation Description
    PUT Bucket logging Setting logging Enables logging for a source bucket
    GET Bucket logging Querying logging configuration Queries the logging configuration of a source bucket

    SDK API References

    For the parameters and method descriptions of all the APIs in the SDK, see SDK API Reference.

    Setting Logging Configuration

    Description

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

    Sample code

    String srcBucket = "examplebucket-1250000000"; //Format: BucketName-APPID
    String targetBucket = "examplebucket-1250000000"; //Format: BucketName-APPID
    PutBucketLoggingRequest putBucketLoggingRequest =
           new PutBucketLoggingRequest(srcBucket);
    // Destination bucket
    putBucketLoggingRequest.setTargetBucket(targetBucket);
    // Specified location in which to store the logs
    putBucketLoggingRequest.setTargetPrefix("dir/");
    cosXmlService.putBucketLoggingAsync(putBucketLoggingRequest,
           new CosXmlResultListener() {
       @Override
       public void onSuccess(CosXmlRequest request, CosXmlResult result) {
           PutBucketLoggingResult putBucketLoggingResult =
                   (PutBucketLoggingResult) result;
       }
        // If you use the Kotlin language to call this, please note that the exception in the callback method is nullable; otherwise, the onFail method will not be called back, that is:
       // clientException is of type CosXmlClientException? and serviceException is of type CosXmlServiceException?
       @Override
       public void onFail(CosXmlRequest cosXmlRequest,
                          @Nullable CosXmlClientException clientException,
                          @Nullable CosXmlServiceException serviceException) {
           if (clientException != null) {
               clientException.printStackTrace();
           } else {
               serviceException.printStackTrace();
           }
       }
    });
    
    Note:

    For more samples, please visit GitHub.

    Querying Logging Configuration

    Description

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

    Sample code

    // Bucket name in the format of BucketName-APPID (APPID is required), which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
    String bucket = "examplebucket-1250000000";
    GetBucketLoggingRequest getBucketLoggingRequest =
           new GetBucketLoggingRequest(bucket);
    cosXmlService.getBucketLoggingAsync(getBucketLoggingRequest,
           new CosXmlResultListener() {
       @Override
       public void onSuccess(CosXmlRequest request, CosXmlResult result) {
           GetBucketLoggingResult getBucketLoggingResult =
                   (GetBucketLoggingResult) result;
       }
        // If you use the Kotlin language to call this, please note that the exception in the callback method is nullable; otherwise, the onFail method will not be called back, that is:
       // clientException is of type CosXmlClientException? and serviceException is of type CosXmlServiceException?
       @Override
       public void onFail(CosXmlRequest cosXmlRequest,
                          @Nullable CosXmlClientException clientException,
                          @Nullable CosXmlServiceException serviceException) {
           if (clientException != null) {
               clientException.printStackTrace();
           } else {
               serviceException.printStackTrace();
           }
       }
    });
    
    Note:

    For more samples, please visit GitHub.

    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support