Object Storage Service：解凍檔案（Python SDK V2）

注意事項

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

• 要解凍檔案，您必須有oss:RestoreObject許可權。具體操作，請參見為RAM使用者授予自訂的權限原則。

範例程式碼

您可以使用以下代碼解凍歸檔、冷歸檔或者深度冷歸檔檔案：

import time
import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，並描述指令碼用途：解凍對象樣本
parser = argparse.ArgumentParser(description="restore object 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')
# 添加命令列參數 --key，表示對象的名稱，必需參數
parser.add_argument('--key', help='The name of the object.', required=True)
# 添加命令列參數 --version_id，表示對象的版本ID，必需參數
parser.add_argument('--version_id', help='The version ID of the object.', required=True)

def main():
    # 解析命令列提供的參數，擷取使用者輸入的值
    args = parser.parse_args()

    # 從環境變數中載入訪問OSS所需的認證資訊，用於身分識別驗證
    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.restore_object(oss.RestoreObjectRequest(
        bucket=args.bucket,           # 指定儲存空間名稱
        key=args.key,                 # 指定對象名稱
        version_id=args.version_id,   # 指定對象的版本ID
        restore_request=oss.RestoreRequest(
            days=1,                    # 指定解凍後對象的保留天數
            # 可選：設定冷歸檔、深度冷歸檔的解凍優先順序，可設定為:Expedited、Standard、Bulk，預設值為Standard
            # tier="Expedited",
        )
    ))

    # 列印操作結果的狀態代碼、請求ID、版本ID以及解凍優先順序等資訊，以便確認請求狀態
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' version id: {result.version_id},'
          f' restore priority: {result.restore_priority},'  # 解凍優先順序（如果有）
          )

    # 迴圈檢查對象是否已經完成解凍
    while True:
        # 擷取對象頭部資訊
        result = client.head_object(oss.HeadObjectRequest(
            bucket=args.bucket,
            key=args.key,
            version_id=args.version_id,
        ))

        # 檢查解凍狀態
        if result.restore and result.restore != 'ongoing-request="true"':
            print('restore is success')  # 解凍成功
            break
        else:
            # 暫停5秒後再次檢查
            time.sleep(5)
            print(result.restore)  # 列印當前解凍狀態

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

相關文檔

• 關於解凍檔案的完整範例程式碼，請參見restore_object.py。

• 關於解凍檔案的更多操作資訊，請參見解凍檔案。