このトピックでは、範囲のダウンロードメソッドを使用してオブジェクトの特定の部分を効率的に取得する方法について説明します。
前提条件
このトピックのサンプルコードでは、中国 (杭州) (
cn-hangzhou) リージョンのパブリックエンドポイントを例として使用しています。同じリージョン内の別の Alibaba Cloud サービスから OSS にアクセスする場合は、内部エンドポイントを使用します。OSS がサポートするリージョンとエンドポイント間のマッピングの詳細については、「OSS のリージョンとエンドポイント」をご参照ください。範囲のダウンロードを使用するには、
oss:GetObject権限が必要です。詳細については、「RAM ユーザーへのカスタムアクセスポリシーの付与」をご参照ください。
サイズが 1,000 バイトのオブジェクトがあるとします。有効なダウンロード範囲は 0 から 999 です。無効な範囲を指定した場合、Range ヘッダーは有効になりません。200 OK ステータスコードが返され、オブジェクト全体が転送されます。以下に、無効なリクエストとその応答の例を示します。
`Range: bytes=500-2000` を指定した場合、範囲の終点が無効です。オブジェクト全体が返され、HTTP ステータスコードは 200 になります。
`Range: bytes=1000-2000` を指定した場合、範囲の始点が無効です。オブジェクト全体が返され、HTTP ステータスコードは 200 になります。
x-oss-range-behavior:standard リクエストヘッダーを追加して、無効な範囲が指定された場合の OSS のダウンロード動作を変更できます。サイズが 1,000 バイトのオブジェクトがあるとします。
`Range: bytes=500-2000` を指定した場合、範囲の終点が無効です。500 から 999 バイトの範囲のコンテンツが返され、HTTP ステータスコードは 206 になります。
`Range: bytes=1000-2000` を指定した場合、範囲の始点が無効です。HTTP ステータスコード 416 が返され、エラーコードは InvalidRange になります。
サンプルコード
次のサンプルコードは、RangeBehavior:standard リクエストヘッダーを追加して、オブジェクトの指定された範囲からデータをダウンロードする方法を示しています。
<?php
// 依存関係ライブラリが正しくロードされるように、オートローダーファイルをインポートします。
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
// コマンドライン引数の説明を定義します。
$optsdesc = [
"region" => ['help' => 'バケットが配置されているリージョン。', 'required' => True], // バケットが配置されているリージョン。このパラメーターは必須です。
"endpoint" => ['help' => '他のサービスが OSS にアクセスするために使用できるドメイン名。', 'required' => False], // エンドポイント。このパラメーターはオプションです。
"bucket" => ['help' => 'バケットの名前', 'required' => True], // バケット名。このパラメーターは必須です。
"key" => ['help' => 'オブジェクトの名前', '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);
// 標準のダウンロード動作を指定します。この例では、値は 'standard' に設定されています。
$rangeBehavior = 'standard';
// Range リクエストヘッダーを指定して、オブジェクトの一部を取得します。
$rangeHeader = 'bytes=0-10';
// GetObjectRequest オブジェクトを作成して、指定されたオブジェクトのコンテンツを取得します。
$request = new Oss\Models\GetObjectRequest(
bucket: $bucket,
key: $key,
rangeBehavior: $rangeBehavior,
rangeHeader: $rangeHeader);
// GetObject 操作を実行します。
$result = $client->getObject($request);
// 結果を出力します。
// HTTP ステータスコード、リクエスト ID、およびオブジェクトのコンテンツを出力します。
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP ステータスコード。たとえば、200 はリクエストが成功したことを示します。
'request id:' . $result->requestId . PHP_EOL . // リクエスト ID。デバッグやリクエストの追跡に使用されます。
'object content:' . $result->body->getContents() . PHP_EOL // オブジェクトのコンテンツ。
);