日志转存（Python SDK V2）_对象存储(OSS)-阿里云帮助中心

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

注意事项

要开启Bucket的日志转存，您必须有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
import alibabacloud_oss_v2.vectors as oss_vectors

parser = argparse.ArgumentParser(description="vector put bucket logging sample")
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')
parser.add_argument('--account_id', help='The account id.', required=True)
parser.add_argument('--target_bucket', help='The name of the target bucket.', required=True)

def main():
    args = parser.parse_args()

    # Loading credentials values from the environment variables
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # Using the SDK's default configuration
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region
    cfg.account_id = args.account_id
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    vector_client = oss_vectors.Client(cfg)

    result = vector_client.put_bucket_logging(oss_vectors.models.PutBucketLoggingRequest(
        bucket=args.bucket,
        bucket_logging_status=oss_vectors.models.BucketLoggingStatus(
            logging_enabled=oss_vectors.models.LoggingEnabled(
                target_bucket=args.target_bucket,
                target_prefix='log-prefix',
                logging_role='AliyunOSSLoggingDefaultRole'
            )
        )
    ))

    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
    )

if __name__ == "__main__":
    main()

查看日志转存配置

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

import argparse
import alibabacloud_oss_v2 as oss
import alibabacloud_oss_v2.vectors as oss_vectors

parser = argparse.ArgumentParser(description="vector get bucket logging sample")
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')
parser.add_argument('--account_id', help='The account id.', required=True)

def main():
    args = parser.parse_args()

    # Loading credentials values from the environment variables
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # Using the SDK's default configuration
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region
    cfg.account_id = args.account_id
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    vector_client = oss_vectors.Client(cfg)

    result = vector_client.get_bucket_logging(oss_vectors.models.GetBucketLoggingRequest(
        bucket=args.bucket,
    ))

    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          )

    if result.bucket_logging_status:
        print(f'logging enabled: target_bucket={result.bucket_logging_status.logging_enabled.target_bucket}, '
              f'target_prefix={result.bucket_logging_status.logging_enabled.target_prefix}')


if __name__ == "__main__":
    main()

关闭日志转存

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

import argparse
import alibabacloud_oss_v2 as oss
import alibabacloud_oss_v2.vectors as oss_vectors

parser = argparse.ArgumentParser(description="vector delete bucket logging sample")
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')
parser.add_argument('--account_id', help='The account id.', required=True)

def main():
    args = parser.parse_args()

    # Loading credentials values from the environment variables
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # Using the SDK's default configuration
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region
    cfg.account_id = args.account_id
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    vector_client = oss_vectors.Client(cfg)

    result = vector_client.delete_bucket_logging(oss_vectors.models.DeleteBucketLoggingRequest(
        bucket=args.bucket,
    ))

    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
    )

if __name__ == "__main__":
    main()

注意事项

方法定义

开启日志转存

查看日志转存配置

关闭日志转存

请求参数列表

返回值列表

示例代码

开启日志转存

查看日志转存配置

关闭日志转存

相关文档