如何通过Python SDK V2进行日志转存_对象存储(OSS)-阿里云帮助中心

访问OSS的过程中会产生大量的访问日志。您可以通过日志转存功能将这些日志按照固定命名规则，以小时为单位生成日志文件写入您指定的存储空间（Bucket）。

注意事项

本文示例代码以华东1（杭州）的地域IDcn-hangzhou为例，默认使用外网Endpoint，如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见OSS地域和访问域名。
要开启日志转存，您必须有oss:PutBucketLogging权限；要查看日志转存配置，您必须有oss:GetBucketLogging权限；要关闭日志转存，您必须有oss:DeleteBucketLogging权限。具体操作，请参见为RAM用户授权自定义的权限策略。

方法定义

开启日志转存

put_bucket_logging(request: PutBucketLoggingRequest, **kwargs) → PutBucketLoggingResult

查看日志转存配置

get_bucket_logging(request: GetBucketLoggingRequest, **kwargs) → GetBucketLoggingResult

关闭日志转存

delete_bucket_logging(request: DeleteBucketLoggingRequest, **kwargs) → DeleteBucketLoggingResult

请求参数列表

参数名	类型	说明

参数名	类型	说明
request	PutBucketLoggingRequest	设置请求参数，具体请参见PutBucketLoggingRequest
	GetBucketLoggingRequest	设置请求参数，具体请参见GetBucketLoggingRequest
	DeleteBucketLoggingRequest	设置请求参数，具体请参见DeleteBucketLoggingRequest

返回值列表

类型	说明

类型	说明
PutBucketLoggingResult	返回值，具体请参见PutBucketLoggingResult
GetBucketLoggingResult	返回值，具体请参见GetBucketLoggingResult
DeleteBucketLoggingResult	返回值，具体请参见DeleteBucketLoggingResult

关于开启日志转存的完整定义，请参见put_bucket_logging。

关于查看日志转存配置的完整定义，请参见get_bucket_logging。

关于关闭日志转存的完整定义，请参见delete_bucket_logging

示例代码

开启日志转存

以下代码用于开启日志转存功能。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器，并描述脚本用途：设置存储空间访问日志（Logging）
parser = argparse.ArgumentParser(description="put bucket logging sample")

# 定义命令行参数，包括必需的区域、源存储空间名称、endpoint、目标存储空间名称以及日志对象前缀（可选）
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the source bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--target_bucket', help='The bucket that stores access logs', required=True)
parser.add_argument('--target_prefix', help='The prefix of the log objects. This parameter can be left empty.', default='')

def main():
    # 解析命令行参数，获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问凭证信息，用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK默认配置创建配置对象，并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 设置配置对象的区域属性，根据用户提供的命令行参数
    cfg.region = args.region

    # 如果提供了自定义endpoint，则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端，准备与OSS交互
    client = oss.Client(cfg)

    # 发送请求以配置指定存储空间的访问日志设置
    result = client.put_bucket_logging(oss.PutBucketLoggingRequest(
            bucket=args.bucket,  # 源存储空间名
            bucket_logging_status=oss.BucketLoggingStatus(
                logging_enabled=oss.LoggingEnabled(
                    target_bucket=args.target_bucket,  # 存储访问日志的目标存储空间名
                    target_prefix=args.target_prefix,  # 日志对象前缀，可以为空字符串
                ),
            ),
    ))

    # 打印操作结果的状态码和请求ID，以便确认请求状态
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
    )

# 当此脚本被直接执行时，调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点，控制程序流程从这里开始

查看日志转存配置

以下代码用于查看日志转存配置。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器，并描述脚本用途：获取存储空间访问日志配置（Logging）
parser = argparse.ArgumentParser(description="get bucket logging sample")

# 定义命令行参数，包括必需的区域、存储空间名称以及endpoint
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # 解析命令行参数，获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问凭证信息，用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK默认配置创建配置对象，并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 设置配置对象的区域属性，根据用户提供的命令行参数
    cfg.region = args.region

    # 如果提供了自定义endpoint，则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端，准备与OSS交互
    client = oss.Client(cfg)

    # 发送请求以获取指定存储空间的访问日志配置详情
    result = client.get_bucket_logging(oss.GetBucketLoggingRequest(
            bucket=args.bucket,  # 存储空间名
    ))

    # 打印操作结果的状态码和请求ID，以便确认请求状态
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' target bucket: {result.bucket_logging_status.logging_enabled.target_bucket if result.bucket_logging_status and result.bucket_logging_status.logging_enabled else "Not set"},'  # 存储访问日志的目标存储空间名，如果没有设置则显示"Not set"
          f' target prefix: {result.bucket_logging_status.logging_enabled.target_prefix if result.bucket_logging_status and result.bucket_logging_status.logging_enabled else "Not set"},'  # 日志对象前缀，如果没有设置则显示"Not set"
    )

# 当此脚本被直接执行时，调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点，控制程序流程从这里开始

关闭日志转存

以下代码用于关闭日志转存功能。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器，并描述脚本用途：删除存储空间访问日志配置（Logging）
parser = argparse.ArgumentParser(description="delete bucket logging sample")

# 定义命令行参数，包括必需的区域、存储空间名称以及endpoint
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # 解析命令行参数，获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问凭证信息，用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK默认配置创建配置对象，并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 设置配置对象的区域属性，根据用户提供的命令行参数
    cfg.region = args.region

    # 如果提供了自定义endpoint，则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端，准备与OSS交互
    client = oss.Client(cfg)

    # 发送请求以删除指定存储空间的访问日志配置
    result = client.delete_bucket_logging(oss.DeleteBucketLoggingRequest(
            bucket=args.bucket,  # 存储空间名
    ))

    # 打印操作结果的状态码和请求ID，以便确认请求状态
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
    )

# 当此脚本被直接执行时，调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点，控制程序流程从这里开始