tencent cloud

文档反馈

日志管理

最后更新时间:2022-04-18 14:25:44

    简介

    本文档提供关于日志管理的 API 概览以及 SDK 示例代码。

    API 操作名 操作描述
    PUT Bucket logging 设置日志管理 为源存储桶开启日志记录
    GET Bucket logging 查询日志管理 查询源存储桶的日志配置信息

    设置日志管理

    功能说明

    PUT Bucket logging 用于为源存储桶开启日志记录,将源存储桶的访问日志保存到指定的目标存储桶中。

    方法原型

    put_bucket_logging(Bucket, BucketLoggingStatus={}, **kwargs):
    

    请求示例

    # -*- coding=utf-8
    from qcloud_cos import CosConfig
    from qcloud_cos import CosS3Client
    import sys
    import logging
    # 正常情况日志级别使用INFO,需要定位时可以修改为DEBUG,此时SDK会打印和服务端的通信信息
    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
    # 1. 设置用户属性, 包括 secret_id, secret_key, region等。Appid 已在CosConfig中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
    secret_id = 'SecretId'     # 替换为用户的 SecretId,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
    secret_key = 'SecretKey'   # 替换为用户的 SecretKey,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
    region = 'ap-beijing'      # 替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.tencentcloud.com/cos5/bucket
                             # COS支持的所有region列表参见https://www.tencentcloud.com/document/product/436/6224
    token = None               # 如果使用永久密钥不需要填入token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见https://www.tencentcloud.com/document/product/436/14048
    scheme = 'https'           # 指定使用 http/https 协议来访问 COS,默认为 https,可不填
    config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
    client = CosS3Client(config)
    response = client.put_bucket_logging(
      Bucket='examplebucket-1250000000',
      BucketLoggingStatus={
          'LoggingEnabled': {
              'TargetBucket': 'logging-bucket-1250000000',
              'TargetPrefix': 'string'
          }
      }
    )
    

    参数说明

    参数名称 参数描述 类型 是否必填
    Bucket 开启日志功能的源存储桶名称,命名格式为 BucketName-APPID ,详情请参见 命名规范 String
    TargetBucket 存放日志的目标存储桶名称,命名格式为 BucketName-APPID ,详情请参见 命名规范 String
    TargetPrefix 日志存放在目标存储桶的指定路径前缀 String

    返回结果说明

    该方法返回值为 None。

    查询日志管理

    功能说明

    GET Bucket logging 用于查询指定存储桶的日志配置信息。

    方法原型

    get_bucket_logging(Bucket, **kwargs):
    

    请求示例

    # -*- coding=utf-8
    from qcloud_cos import CosConfig
    from qcloud_cos import CosS3Client
    import sys
    import logging
    # 正常情况日志级别使用INFO,需要定位时可以修改为DEBUG,此时SDK会打印和服务端的通信信息
    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
    # 1. 设置用户属性, 包括 secret_id, secret_key, region等。Appid 已在CosConfig中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
    secret_id = 'SecretId'     # 替换为用户的 SecretId,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
    secret_key = 'SecretKey'   # 替换为用户的 SecretKey,请登录访问管理控制台进行查看和管理,https://console.tencentcloud.com/cam/capi
    region = 'ap-beijing'      # 替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.tencentcloud.com/cos5/bucket
                             # COS支持的所有region列表参见https://www.tencentcloud.com/document/product/436/6224
    token = None               # 如果使用永久密钥不需要填入token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见https://www.tencentcloud.com/document/product/436/14048
    scheme = 'https'           # 指定使用 http/https 协议来访问 COS,默认为 https,可不填
    config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
    client = CosS3Client(config)
    response = client.get_bucket_logging(
      Bucket='examplebucket-1250000000'
    )
    

    参数说明

    参数名称 参数描述 类型 是否必填
    Bucket 存放日志的目标存储桶,格式为 BucketName-APPID ,详情请参见 命名规范 String

    返回结果说明

    Bucket 日志管理配置,类型为 dict。

    {
      'LoggingEnabled': {
          'TargetBucket': 'logging-bucket-1250000000',
          'TargetPrefix': 'string'
      }
    }
    
    参数名称 参数描述 类型
    TargetBucket 存放日志的目标存储桶名称,命名格式为 BucketName-APPID ,详情请参见 命名规范 String
    TargetPrefix 日志存放在目标存储桶的指定路径前缀 String
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持