このトピックでは、シンプルなアップロードを使用して、ローカルファイルを Object Storage Service (OSS) にすばやくアップロードする方法について説明します。 このメソッドはシンプルで、ローカルファイルをすばやくアップロードしたい場合に適しています。
使用上の注意
このトピックのサンプルコードでは、中国 (杭州) リージョンのリージョン ID
cn-hangzhouを使用しています。 デフォルトでは、パブリックエンドポイントを使用してバケット内のリソースにアクセスします。 バケットが配置されているのと同じリージョン内の他の Alibaba Cloud サービスを使用してバケット内のリソースにアクセスする場合は、内部エンドポイントを使用します。 OSS のリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。シンプルなアップロードを使用するには、
oss:PutObject権限が必要です。 詳細については、「カスタムポリシーを RAM ユーザーにアタッチする」をご参照ください。このトピックでは、アクセス認証情報は環境変数から取得されます。 詳細については、「PHP 用 OSS SDK のアクセス認証情報を構成する」をご参照ください。
サンプルコード
次のサンプルコードは、ローカルファイルをバケットにアップロードする方法の例を示しています。
<?php
// 依存ライブラリを読み込むために、autoload ファイルを導入します。
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
// コマンドラインパラメータの説明を指定します。
$optsdesc = [
"region" => ['help' => 'バケットが配置されているリージョン。', 'required' => True], // (必須) バケットが配置されているリージョンを指定します。
"endpoint" => ['help' => '他のサービスが OSS にアクセスするために使用できるドメイン名。', 'required' => False], // (オプション) 他のサービスが OSS にアクセスするために使用できるエンドポイントを指定します。
"bucket" => ['help' => 'バケットの名前。', 'required' => True], // (必須) バケットの名前を指定します。
"key" => ['help' => 'オブジェクトの名前。', 'required' => True], // (必須) オブジェクトの名前を指定します。
"file" => ['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"]; // オブジェクトの名前。
$file = $options["file"]; // ローカルファイルのパス。
// 環境変数からアクセス認証情報を取得します。
// EnvironmentVariableCredentialsProvider 環境変数から AccessKey ID と AccessKey シークレットを取得します。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// SDK のデフォルト構成を使用します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 認証プロバイダーを指定します。
$cfg->setRegion($region); // バケットが配置されているリージョンを指定します。
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]); // エンドポイントが提供されている場合は、エンドポイントを指定します。
}
// OSSClient インスタンスを作成します。
$client = new Oss\Client($cfg);
// ローカルファイルが存在するかどうかを確認します。
if (!file_exists($file)) {
echo "Error: The specified file does not exist." . PHP_EOL; // ローカルファイルが存在しない場合は、エラーメッセージが表示され、プログラムが終了します。
exit(1);
}
// ローカルファイルを開き、シンプルなアップロードタスクの準備をします。
// fopen を使用してローカルファイルを読み取り専用モードで開き、Utils::streamFor を使用してファイルをストリームに変換します。
$body = Oss\Utils::streamFor(fopen($file, 'r'));
// PutObjectRequest オブジェクトを作成して、ローカルファイルをアップロードします。
$request = new Oss\Models\PutObjectRequest(bucket: $bucket, key: $key);
$request->body = $body; // HTTP リクエスト本文がファイルストリームであることを指定します。
// シンプルなアップロードリクエストを実行します。
$result = $client->putObject($request);
// シンプルなアップロードリクエストの結果を表示します。
// リクエストが成功したかどうかを確認するために、HTTP ステータスコード、リクエスト ID、およびオブジェクトの ETag を表示します。
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP ステータスコード。たとえば、HTTP ステータスコード 200 は、リクエストが成功したことを示します。
'request id:' . $result->requestId. PHP_EOL . // リクエスト ID。リクエストのデバッグまたはトレースに使用されます。
'etag:' . $result->etag . PHP_EOL // オブジェクトの ETag。オブジェクトのコンテンツを識別するために使用されます。
);
一般的なシナリオ
参考資料
シンプルなアップロードの完全なサンプルコードについては、GitHub をご覧ください。