如何使用Python SDK V2進行歸檔直讀 - Object Storage Service

本文介紹如何使用Python SDK V2管理Bucket的歸檔直讀功能。

注意事項

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

方法定義

開啟Bucket歸檔直讀

put_bucket_archive_direct_read(request: PutBucketArchiveDirectReadRequest, **kwargs) → PutBucketArchiveDirectReadResult

查看Bucket是否開啟歸檔直讀

get_bucket_archive_direct_read(request: GetBucketArchiveDirectReadRequest, **kwargs) → GetBucketArchiveDirectReadResult

請求參數列表

參數名	類型	說明
request	PutBucketArchiveDirectReadRequest	佈建要求參數，具體請參見PutBucketArchiveDirectReadRequest
request	GetBucketArchiveDirectReadRequest	佈建要求參數，具體請參見GetBucketArchiveDirectReadRequest

傳回值列表

類型	說明
PutBucketArchiveDirectReadResult	傳回值，具體請參見PutBucketArchiveDirectReadResult
GetBucketArchiveDirectReadResult	傳回值，具體請參見GetBucketArchiveDirectReadResult

關於開啟Bucket歸檔直讀方法的完整定義，請參見put_bucket_archive_direct_read。

關於查看Bucket是否開啟歸檔直讀方法的完整定義，請參見get_bucket_archive_direct_read。

範例程式碼

開啟Bucket歸檔直讀

您可以使用以下代碼開啟Bucket歸檔直讀。

import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，並描述指令碼用途：設定儲存空間歸檔直讀配置（Archive Direct Read）
parser = argparse.ArgumentParser(description="put bucket archive direct read 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')
parser.add_argument('--enabled', help='Specifies whether to enable real-time access of Archive objects for a bucket. Valid values: "true" or "false".', required=True)

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_archive_direct_read(oss.PutBucketArchiveDirectReadRequest(
            bucket=args.bucket,  # 儲存空間名
            archive_direct_read_configuration=oss.ArchiveDirectReadConfiguration(
                enabled=args.enabled.lower() == 'true',  # 將字串形式的布爾值轉換為Python布爾類型
            ),
    ))

    # 列印操作結果的狀態代碼和請求ID，以便確認請求狀態
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
    )

# 當此指令碼被直接執行時，調用main函數開始處理邏輯
if __name__ == "__main__":
    main()  # 指令碼進入點，控製程序流程從這裡開始

查看Bucket是否開啟歸檔直讀

您可以使用以下代碼查看Bucket是否開啟歸檔直讀。

import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，並描述指令碼用途：擷取儲存空間歸檔直讀配置（Archive Direct Read）
parser = argparse.ArgumentParser(description="get bucket archive direct read 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_archive_direct_read(oss.GetBucketArchiveDirectReadRequest(
            bucket=args.bucket,  # 儲存空間名
    ))

    # 列印操作結果的狀態代碼和請求ID，以便確認請求狀態
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' enabled: {result.archive_direct_read_configuration.enabled if hasattr(result.archive_direct_read_configuration, "enabled") else "Not set"},'  # 歸檔直讀是否啟用，如果沒有設定則顯示"Not set"
    )

# 當此指令碼被直接執行時，調用main函數開始處理邏輯
if __name__ == "__main__":
    main()  # 指令碼進入點，控製程序流程從這裡開始