通過PHP SDK V2解凍歸檔、冷歸檔和深度冷歸檔Object - Object Storage Service

歸檔、冷歸檔以及深度冷歸檔類型的檔案需要解凍之後才能讀取。檔案解凍後，會產生一個標準儲存類型的檔案副本，即同時存在標準儲存類型的檔案副本和歸檔、冷歸檔或深度冷歸檔的原檔案。在檔案解凍的有效期間過後，標準儲存類型的檔案副本會自動刪除。本文介紹如何使用OSS Go SDK解凍歸檔、冷歸檔以及深度冷歸檔檔案。

注意事項

僅歸檔、冷歸檔以及深度冷歸檔類型的Object支援調用RestoreObject方法。
本文範例程式碼以華東1（杭州）的地區IDcn-hangzhou為例，預設使用外網Endpoint，如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。
要解凍檔案，您必須有oss:RestoreObject許可權。具體操作，請參見為RAM使用者授予自訂的權限原則。

範例程式碼

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

<?php

// 引入自動負載檔案，確保依賴庫能夠正確載入
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// 定義命令列參數的描述資訊
$optsdesc = [
    "region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // Bucket所在的地區（必填）
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 訪問網域名稱（可選）
    "bucket" => ['help' => 'The name of the bucket', 'required' => True], // Bucket名稱（必填）
    "key" => ['help' => 'The name of the object', 'required' => True], // 對象名稱（必填）
];

// 將參數描述轉換為getopt所需的長選項格式
// 每個參數後面加上":"表示該參數需要值
$longopts = \array_map(function ($key) {
    return "$key:";
}, array_keys($optsdesc));

// 解析命令列參數
$options = getopt("", $longopts);

// 驗證必填參數是否存在
foreach ($optsdesc as $key => $value) {
    if ($value['required'] === True && empty($options[$key])) {
        $help = $value['help']; // 擷取參數的協助資訊
        echo "Error: the following arguments are required: --$key, $help" . PHP_EOL;
        exit(1); // 如果必填參數缺失，則退出程式
    }
}

// 從解析的參數中提取值
$region = $options["region"]; // Bucket所在的地區
$bucket = $options["bucket"]; // Bucket名稱
$key = $options["key"];       // 對象名稱

// 載入環境變數中的憑證資訊
// 使用EnvironmentVariableCredentialsProvider從環境變數中讀取Access Key ID和Access Key Secret
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

// 使用SDK的預設配置
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 設定憑證提供者
$cfg->setRegion($region); // 設定Bucket所在的地區
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // 如果提供了訪問網域名稱，則設定endpoint
}

// 建立OSS用戶端執行個體
$client = new Oss\Client($cfg);

// 建立RestoreObjectRequest對象，用於恢複Archive Storage類型對象
$request = new Oss\Models\RestoreObjectRequest(bucket: $bucket, key: $key);

// 執行恢複對象操作
$result = $client->restoreObject($request);

// 列印恢複結果
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP狀態代碼，例如200表示成功
    'request id:' . $result->requestId . PHP_EOL     // 請求ID，用於調試或追蹤請求
);

常見使用情境

使用CleanRestoredObject方法清理檔案副本

冷歸檔或者深度冷Archive Storage類型檔案（Object）在資料解凍時會產生一份標準儲存類型的檔案副本用於訪問，檔案副本在解凍時間結束前會收取臨時儲存費用。如果您希望提前結束解凍狀態，且檔案副本不再產生臨時儲存費用，您可以發起CleanRestoredObject請求。請求完成後，Object將恢複為冷凍狀態，不能直接讀取。

<?php

// 引入自動負載檔案，確保依賴庫能夠正確載入
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// 定義命令列參數的描述資訊
$optsdesc = [
    "region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // Bucket所在的地區（必填）
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 訪問網域名稱（可選）
    "bucket" => ['help' => 'The name of the bucket', 'required' => True], // Bucket名稱（必填）
    "key" => ['help' => 'The name of the object', 'required' => True], // 對象名稱（必填）
];

// 將參數描述轉換為getopt所需的長選項格式
// 每個參數後面加上":"表示該參數需要值
$longopts = \array_map(function ($key) {
    return "$key:";
}, array_keys($optsdesc));

// 解析命令列參數
$options = getopt("", $longopts);

// 驗證必填參數是否存在
foreach ($optsdesc as $key => $value) {
    if ($value['required'] === True && empty($options[$key])) {
        $help = $value['help']; // 擷取參數的協助資訊
        echo "Error: the following arguments are required: --$key, $help" . PHP_EOL;
        exit(1); // 如果必填參數缺失，則退出程式
    }
}

// 從解析的參數中提取值
$region = $options["region"]; // Bucket所在的地區
$bucket = $options["bucket"]; // Bucket名稱
$key = $options["key"];       // 對象名稱

// 載入環境變數中的憑證資訊
// 使用EnvironmentVariableCredentialsProvider從環境變數中讀取Access Key ID和Access Key Secret
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

// 使用SDK的預設配置
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 設定憑證提供者
$cfg->setRegion($region); // 設定Bucket所在的地區
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // 如果提供了訪問網域名稱，則設定endpoint
}

// 建立OSS用戶端執行個體
$client = new Oss\Client($cfg);

// 建立CleanRestoredObjectRequest對象，用於清理已恢複的Archive Storage類型對象
$request = new Oss\Models\CleanRestoredObjectRequest($bucket, $key);

// 執行清理已恢複對象的操作
$result = $client->cleanRestoredObject($request);

// 列印清理結果
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP狀態代碼，例如200表示成功
    'request id:' . $result->requestId . PHP_EOL     // 請求ID，用於調試或追蹤請求
);

Object Storage Service：PHP解凍檔案

注意事項

範例程式碼

常見使用情境

使用CleanRestoredObject方法清理檔案副本

相關文檔