Object Storage Service：生命週期管理（Python SDK V2）

背景資訊

在OSS中，並非所有上傳的資料都需要頻繁訪問，但出於資料合規性或歸檔需求，部分資料仍需以冷儲存的形式儲存。根據業務需求，您可以選擇：

1. 基於最後修改時間（Last Modified Time）的生命週期規則：當某些資料長時間未被修改且不再需要保留時，可以通過此規則大量刪除它們，或將其轉換為冷儲存類型，從而釋放儲存空間。

2. 基於最後訪問時間（Last Access Time）的生命週期規則：如果希望OSS自動監測資料的訪問模式來識別冷資料並動態轉換儲存類型，可啟用此規則。OSS將自動識別長期未被訪問的資料，將其轉換為更經濟的冷儲存，從而實現冷熱分層，降低儲存成本。

注意事項

• 在配置基於最後一次修改時間或者最後一次訪問時間的生命週期規則之前，請確保您已瞭解該功能。詳情請參見基於最後一次修改時間的生命週期規則和基於最後一次訪問時間的生命週期規則。

• 本文範例程式碼以華東1（杭州）的地區IDcn-hangzhou為例，預設使用外網Endpoint，如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。

• 要設定生命週期規則，您必須有oss:PutBucketLifecycle許可權；要查看生命週期規則，您必須有oss:GetBucketLifecycle許可權；要清空生命週期規則，您必須有oss:DeleteBucketLifecycle許可權。具體操作，請參見為RAM使用者授予自訂的權限原則。

設定生命週期規則

以下代碼分別提供了設定基於最後一次修改時間和基於最後一次訪問時間的生命週期規則的樣本。設定完成後，如果您希望修改其中的一條或多條生命週期規則，請參見如何修改其中一條或多條生命週期規則配置？

基於最後一次修改時間策略執行轉換檔儲存類型

以下代碼用於為Bucket設定基於最後一次修改時間策略，以執行轉換檔儲存類型的操作。

import argparse
import datetime
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，用於接收使用者輸入的參數
parser = argparse.ArgumentParser(description="put bucket lifecycle sample")

# 添加命令列參數 --region，表示儲存空間所在的地區，必填項
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)

# 添加命令列參數 --bucket，表示儲存空間的名稱，必填項
parser.add_argument('--bucket', help='The name of the bucket.', required=True)

# 添加命令列參數 --endpoint，表示其他服務訪問 OSS 時使用的網域名稱，可選項
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

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

    # 從環境變數中載入憑證資訊（AccessKeyId 和 AccessKeySecret）
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 載入 SDK 的預設配置
    cfg = oss.config.load_default()

    # 設定憑證提供者
    cfg.credentials_provider = credentials_provider

    # 設定儲存空間所在的地區
    cfg.region = args.region

    # 如果使用者提供了自訂的 endpoint，則設定到配置中
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用設定物件初始化 OSS 用戶端
    client = oss.Client(cfg)

    result = client.put_bucket_lifecycle(oss.PutBucketLifecycleRequest(
            bucket=args.bucket,
            lifecycle_configuration=oss.LifecycleConfiguration(
                rules=[oss.LifecycleRule(
                    #  指定生命週期規則rule1。規則中指定首碼為foo、標籤鍵為k1、標籤值為v1的檔案，在距離最後一次修改時間30天后轉為低頻訪問類型
                    id='rule1',
                    status='Enabled',
                    prefix='foo/',
                    transitions=[oss.LifecycleRuleTransition(
                        days=30,
                        storage_class=oss.StorageClassType.IA,
                        is_access_time=False, # 設定為false，基於最後一次修改時間策略
                    )],
                    tags=[oss.Tag(
                        key='k1',
                        value='v1',
                    )],
                ), oss.LifecycleRule(
                    # 指定生命週期規則rule2。規則中指定首碼為dir，在受版本控制狀態下的Object僅有刪除標記的情況下自動刪除刪除標記，非目前的版本Object超過30天后到期刪除，非目前的版本Object超過10天后轉為IA儲存類型
                    id='rule2',
                    status='Enabled',
                    prefix='dir/',
                    expiration=oss.LifecycleRuleExpiration(
                        days=10,
                        expired_object_delete_marker=True
                    ),
                    noncurrent_version_expiration=oss.NoncurrentVersionExpiration(
                        noncurrent_days=30,
                    ),
                    noncurrent_version_transition=oss.NoncurrentVersionTransition(
                        noncurrent_days=10,
                        storage_class=oss.StorageClassType.IA,
                        is_access_time=False, # 設定為false，基於最後一次修改時間策略
                    ),
                )]
            ),
    ))

    # 列印操作結果的狀態代碼和請求 ID
    print(f'status code: {result.status_code}, '  # HTTP 狀態代碼，表示請求是否成功
          f'request id: {result.request_id}')    # 請求 ID，用於追蹤請求日誌和調試


if __name__ == "__main__":
    # 程式入口，調用 main 函數執行邏輯
    main()

基於最後一次修改時間策略限制除指定首碼、標籤以外的檔案執行轉換儲存類型操作

以下代碼用於指定Bucket中除首碼為log、包含key為key1，value為value1標籤且符合指定大小以外的檔案在距離最後一次修改時間30天后轉低頻訪問類型。

import argparse
import datetime
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，用於接收使用者輸入的參數
parser = argparse.ArgumentParser(description="put bucket lifecycle sample")

# 添加命令列參數 --region，表示儲存空間所在的地區，必填項
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)

# 添加命令列參數 --bucket，表示儲存空間的名稱，必填項
parser.add_argument('--bucket', help='The name of the bucket.', required=True)

# 添加命令列參數 --endpoint，表示其他服務訪問 OSS 時使用的網域名稱，可選項
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

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

    # 從環境變數中載入憑證資訊（AccessKeyId 和 AccessKeySecret）
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 載入 SDK 的預設配置
    cfg = oss.config.load_default()

    # 設定憑證提供者
    cfg.credentials_provider = credentials_provider

    # 設定儲存空間所在的地區
    cfg.region = args.region

    # 如果使用者提供了自訂的 endpoint，則設定到配置中
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用設定物件初始化 OSS 用戶端
    client = oss.Client(cfg)

    result = client.put_bucket_lifecycle(oss.PutBucketLifecycleRequest(
            bucket=args.bucket,
            lifecycle_configuration=oss.LifecycleConfiguration(
                rules=[oss.LifecycleRule(
                    #  指定生命週期規則rule1。規則中指定除首碼為log、包含key為key1，value為value1標籤且符合指定大小以外的檔案在距離最後一次修改時間30天后轉低頻訪問類型
                    id='rule1',
                    status='Enabled',
                    prefix='logs/',
                    transitions=[oss.LifecycleRuleTransition(
                        days=30,
                        storage_class=oss.StorageClassType.IA,
                        is_access_time=False, # 設定為false，基於最後一次修改時間策略
                    )],
                    filter=oss.LifecycleRuleFilter(
                        object_size_greater_than=500,
                        object_size_less_than=1000,
                        filter_not=[oss.LifecycleRuleNot(
                            prefix='logs/log',
                            tag={
                               'key': 'key1',
                                'value': 'value1',
                            },
                        )],
                    )
                )]
            ),
    ))

    # 列印操作結果的狀態代碼和請求 ID
    print(f'status code: {result.status_code}, '  # HTTP 狀態代碼，表示請求是否成功
          f'request id: {result.request_id}')    # 請求 ID，用於追蹤請求日誌和調試


if __name__ == "__main__":
    # 程式入口，調用 main 函數執行邏輯
    main()

基於最後一次訪問時間策略轉換檔儲存類型

以下代碼用於為Bucket設定基於最後一次訪問時間策略，以執行轉換儲存類型的操作。

import argparse
import datetime
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，用於接收使用者輸入的參數
parser = argparse.ArgumentParser(description="put bucket lifecycle sample")

# 添加命令列參數 --region，表示儲存空間所在的地區，必填項
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)

# 添加命令列參數 --bucket，表示儲存空間的名稱，必填項
parser.add_argument('--bucket', help='The name of the bucket.', required=True)

# 添加命令列參數 --endpoint，表示其他服務訪問 OSS 時使用的網域名稱，可選項
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

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

    # 從環境變數中載入憑證資訊（AccessKeyId 和 AccessKeySecret）
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 載入 SDK 的預設配置
    cfg = oss.config.load_default()

    # 設定憑證提供者
    cfg.credentials_provider = credentials_provider

    # 設定儲存空間所在的地區
    cfg.region = args.region

    # 如果使用者提供了自訂的 endpoint，則設定到配置中
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用設定物件初始化 OSS 用戶端
    client = oss.Client(cfg)

    result = client.put_bucket_lifecycle(oss.PutBucketLifecycleRequest(
            bucket=args.bucket,
            lifecycle_configuration=oss.LifecycleConfiguration(
                rules=[oss.LifecycleRule(
                    # 在生命週期規則1中指定首碼為data/的所有檔案在距離最後一次訪問時間200天后轉為低頻訪問類型。且再次訪問首碼為data/的檔案時，這些檔案仍保留為低頻訪問類型
                    id='rule1',
                    status='Enabled',
                    prefix='data/',
                    transitions=[oss.LifecycleRuleTransition(
                        days=200,
                        storage_class=oss.StorageClassType.IA,
                        is_access_time=True, # 設定為true，基於最後一次訪問時間策略
                        return_to_std_when_visit=False
                    )],
                ), oss.LifecycleRule(
                    # 在生命週期規則2中指定首碼為log/的所有檔案在距離最後一次訪問時間120天后轉為低頻訪問類型。且再次訪問首碼為log/的檔案時，這些檔案仍保留為低頻訪問類型
		    # 同一規則中指定首碼為log/的所有檔案在距離最後一次訪問時間250天后轉為歸檔類型。
                    id='rule2',
                    status='Enabled',
                    prefix='log/',
                    transitions=[oss.LifecycleRuleTransition(
                        days=120,
                        storage_class=oss.StorageClassType.IA,
                        is_access_time=True, # 設定為true，基於最後一次訪問時間策略
                        return_to_std_when_visit=False
                    ), oss.LifecycleRuleTransition(
                        days=250,
                        storage_class=oss.StorageClassType.ARCHIVE,
                        is_access_time=True, # 設定為true，基於最後一次訪問時間策略
                        return_to_std_when_visit=False
                    )],
                )]
            ),
    ))

    # 列印操作結果的狀態代碼和請求 ID
    print(f'status code: {result.status_code}, '  # HTTP 狀態代碼，表示請求是否成功
          f'request id: {result.request_id}')    # 請求 ID，用於追蹤請求日誌和調試


if __name__ == "__main__":
    # 程式入口，調用 main 函數執行邏輯
    main()

查看生命週期規則

以下代碼用於查看生命週期規則中包含的資訊。

import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，用於接收使用者輸入的參數
parser = argparse.ArgumentParser(description="get bucket lifecycle sample")

# 添加命令列參數 --region，表示儲存空間所在的地區，必填項
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)

# 添加命令列參數 --bucket，表示儲存空間的名稱，必填項
parser.add_argument('--bucket', help='The name of the bucket.', required=True)

# 添加命令列參數 --endpoint，表示其他服務訪問 OSS 時使用的網域名稱，可選項
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

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

    # 從環境變數中載入憑證資訊（AccessKeyId 和 AccessKeySecret）
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 載入 SDK 的預設配置
    cfg = oss.config.load_default()

    # 設定憑證提供者
    cfg.credentials_provider = credentials_provider

    # 設定儲存空間所在的地區
    cfg.region = args.region

    # 如果使用者提供了自訂的 endpoint，則設定到配置中
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用設定物件初始化 OSS 用戶端
    client = oss.Client(cfg)

    # 調用 get_bucket_lifecycle 方法擷取儲存空間的生命週期規則
    result = client.get_bucket_lifecycle(
        oss.GetBucketLifecycleRequest(
            bucket=args.bucket,  # 指定目標儲存空間的名稱
        )
    )

    # 列印操作結果的狀態代碼和請求 ID
    print(f'status code: {result.status_code}, '  # HTTP 狀態代碼，表示請求是否成功
          f'request id: {result.request_id}')    # 請求 ID，用於追蹤請求日誌和調試

    # 如果返回的生命週期規則集合中包含規則，則逐個列印每個規則的詳細資料
    if result.lifecycle_configuration.rules:  # 檢查是否存在生命週期規則
        for r in result.lifecycle_configuration.rules:  # 遍曆所有規則
            print(f'rule: {r}')  # 列印每個規則的內容


if __name__ == "__main__":
    # 程式入口，調用 main 函數執行邏輯
    main()

清空生命週期規則

以下代碼用於清空examplebucket的所有生命週期規則。如果您需要刪除其中一條或者多條生命週期規則，請參見如何刪除其中一條或多條生命週期規則？

import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，用於接收使用者輸入的參數
parser = argparse.ArgumentParser(description="delete bucket lifecycle sample")

# 添加命令列參數 --region，表示儲存空間所在的地區，必填項
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)

# 添加命令列參數 --bucket，表示儲存空間的名稱，必填項
parser.add_argument('--bucket', help='The name of the bucket.', required=True)

# 添加命令列參數 --endpoint，表示其他服務訪問 OSS 時使用的網域名稱，可選項
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

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

    # 從環境變數中載入憑證資訊（AccessKeyId 和 AccessKeySecret）
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 載入 SDK 的預設配置
    cfg = oss.config.load_default()

    # 設定憑證提供者
    cfg.credentials_provider = credentials_provider

    # 設定儲存空間所在的地區
    cfg.region = args.region

    # 如果使用者提供了自訂的 endpoint，則設定到配置中
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用設定物件初始化 OSS 用戶端
    client = oss.Client(cfg)

    # 調用 delete_bucket_lifecycle 方法刪除儲存空間的生命週期規則
    result = client.delete_bucket_lifecycle(
        oss.DeleteBucketLifecycleRequest(
            bucket=args.bucket,  # 指定目標儲存空間的名稱
        )
    )

    # 列印操作結果的狀態代碼和請求 ID
    print(f'status code: {result.status_code}, '  # HTTP 狀態代碼，表示請求是否成功
          f'request id: {result.request_id}')    # 請求 ID，用於追蹤請求日誌和調試


if __name__ == "__main__":
    # 程式入口，調用 main 函數執行邏輯
    main()

相關文檔

• 關於設定生命週期規則的完整範例程式碼，請參見put_bucket_lifecycle.py。

• 關於查看生命週期規則的完整範例程式碼，請參見get_bucket_lifecycle.py。

• 關於清空生命週期規則的完整範例程式碼，請參見delete_bucket_lifecycle.py。