Object Storage Service:オブジェクトの解凍 (PHP SDK V2)

注意事項

• RestoreObject 操作を呼び出して解凍できるのは、アーカイブ、コールドアーカイブ、ディープコールドアーカイブストレージクラスのオブジェクトのみです。

• このトピックのサンプルコードでは、中国 (杭州) リージョンのリージョン ID cn-hangzhou を使用します。デフォルトではパブリックエンドポイントが使用されます。同じリージョン内の他の Alibaba Cloud サービスから OSS にアクセスする場合は、内部エンドポイントを使用できます。OSS がサポートするリージョンとエンドポイントの詳細については、「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], // 必須。バケットが配置されているリージョン。
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // オプション。エンドポイント。
    "bucket" => ['help' => 'The name of the bucket', 'required' => True], // 必須。バケットの名前。
    "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 = $options["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); // バケットが配置されているリージョンを設定します。
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // エンドポイントが指定されている場合は、エンドポイントを設定します。
}

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// RestoreObjectRequest オブジェクトを作成して、アーカイブオブジェクトを解凍します。
$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。リクエストのデバッグまたはトレースに使用されます。
);

一般的なシナリオ

<?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], // 必須。バケットが配置されているリージョン。
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // オプション。エンドポイント。
    "bucket" => ['help' => 'The name of the bucket', 'required' => True], // 必須。バケットの名前。
    "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 = $options["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); // バケットが配置されているリージョンを設定します。
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // エンドポイントが指定されている場合は、エンドポイントを設定します。
}

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// CleanRestoredObjectRequest オブジェクトを作成して、解凍されたアーカイブオブジェクトをクリーンアップします。
$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。リクエストのデバッグまたはトレースに使用されます。
);

関連情報

• 完全なサンプルコードについては、「GitHub の例」をご参照ください。

• API 操作の詳細については、「RestoreObject」をご参照ください。

• オブジェクトの解凍の詳細については、「オブジェクトの解凍」をご参照ください。