日誌轉存(Python SDK V2)

更新時間:
Copy as MD

訪問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
    cfg.use_internal_endpoint = True  # 如需通過公網訪問,請將此處設定為False或刪除此行
    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
    cfg.use_internal_endpoint = True  # 如需通過公網訪問,請將此處設定為False或刪除此行
    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
    cfg.use_internal_endpoint = True  # 如需通過公網訪問,請將此處設定為False或刪除此行
    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()

相關文檔