如何通過Python SDK V2進行日誌轉存 - Object Storage Service

訪問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()  # 指令碼進入點，控製程序流程從這裡開始

配置使用者自訂日誌欄位

您可以使用PutUserDefinedLogFieldsConfig介面為儲存空間（Bucket）即時日誌中的user_defined_log_fields欄位進行個人化配置。您可以將OSS請求中使用者關心的要求標頭或查詢參數資訊記錄到該欄位中去以便後續分析請求。

import argparse
import alibabacloud_oss_v2 as oss  # 匯入阿里雲 OSS SDK

# 建立命令列參數解析器
parser = argparse.ArgumentParser(description="put user defined log fields config 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')


def main():
    # 解析命令列參數
    args = parser.parse_args()

    # 使用環境變數載入訪問憑證（AccessKey ID 和 AccessKey Secret）
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 載入預設配置並設定憑證提供者、地區（Region）和訪問網域名稱（Endpoint）
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 初始化 OSS 用戶端
    client = oss.Client(cfg)

    # 構造 PutUserDefinedLogFieldsConfig 請求對象
    result = client.put_user_defined_log_fields_config(
        oss.PutUserDefinedLogFieldsConfigRequest(
            bucket=args.bucket,  # 指定目標 Bucket 名稱
            user_defined_log_fields_configuration=oss.UserDefinedLogFieldsConfiguration(
                header_set=oss.LoggingHeaderSet(
                    headers=['header1', 'header2'],  # 自訂日誌中需要記錄的 HTTP Headers
                ),
                param_set=oss.LoggingParamSet(
                    parameters=['parameter1', 'parameter2'],  # 自訂日誌中需要記錄的 URL 參數
                ),
            ),
        )
    )

    # 列印請求結果中的狀態代碼和請求 ID，用於調試或確認操作是否成功
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id}')


if __name__ == "__main__":
    main()

查詢使用者自訂日誌欄位

您可以使用GetUserDefinedLogFieldsConfig介面擷取儲存空間（Bucket）即時日誌中user_defined_log_fields欄位的個人化配置。

import argparse
import alibabacloud_oss_v2 as oss  # 匯入阿里雲 OSS SDK


# 建立命令列參數解析器
parser = argparse.ArgumentParser(description="get user defined log fields config 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')


def main():
    # 解析命令列參數
    args = parser.parse_args()

    # 使用環境變數載入訪問憑證（AccessKey ID 和 AccessKey Secret）
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 載入預設配置並設定憑證提供器、地區（Region）和端點（Endpoint）
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 初始化 OSS 用戶端
    client = oss.Client(cfg)

    # 構造 GetUserDefinedLogFieldsConfig 請求對象
    result = client.get_user_defined_log_fields_config(
        oss.GetUserDefinedLogFieldsConfigRequest(
            bucket=args.bucket,  # 指定目標 Bucket 名稱
        ),
    )

    # 列印請求結果中的狀態代碼、請求 ID 以及自訂日誌欄位配置內容
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' header set: {result.user_defined_log_fields_configuration.header_set},'
          f' param set: {result.user_defined_log_fields_configuration.param_set},'
    )


if __name__ == "__main__":
    main()

刪除使用者自訂日誌欄位

您可以使用DeleteUserDefinedLogFieldsConfig介面刪除儲存空間（Bucket）即時日誌中user_defined_log_fields欄位的個人化配置。

import argparse
import alibabacloud_oss_v2 as oss  # 匯入阿里雲 OSS SDK 模組


# 建立命令列參數解析器
parser = argparse.ArgumentParser(description="delete user defined log fields config 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')


def main():
    # 解析命令列參數
    args = parser.parse_args()

    # 使用環境變數載入訪問憑證（AccessKey ID 和 AccessKey Secret）
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 載入預設配置並設定憑證提供器、地區（Region）和端點（Endpoint）
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 初始化 OSS 用戶端執行個體
    client = oss.Client(cfg)

    # 構造 DeleteUserDefinedLogFieldsConfig 請求對象
    result = client.delete_user_defined_log_fields_config(
        oss.DeleteUserDefinedLogFieldsConfigRequest(
            bucket=args.bucket,  # 指定目標 Bucket 名稱
        ),
    )

    # 列印請求結果中的狀態代碼和請求 ID
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id}'
    )


if __name__ == "__main__":
    main()