OSS では、オブジェクトを直接名前変更することはできません。同じバケット内のオブジェクトの名前を変更するには、CopyObject 操作を使用して、ソースオブジェクトを新しい名前の宛先オブジェクトにコピーします。
考慮事項
このトピックのサンプルコードでは、デフォルトで中国 (杭州) リージョン (
cn-hangzhou) のパブリックエンドポイントを使用します。同じリージョン内の別の Alibaba Cloud プロダクトから OSS にアクセスする場合は、内部エンドポイントを使用します。OSS がサポートするリージョンとエンドポイントの詳細については、「OSS のリージョンとエンドポイント」をご参照ください。
サンプルコード
シンプルコピー (CopyObject) メソッドを使用したオブジェクトの名前変更
シンプルコピー CopyObject メソッドを使用して、オブジェクトの名前を変更できます。
<?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], // 宛先オブジェクトの名前。(必須)
"src-bucket" => ['help' => 'The name of the source bucket', 'required' => False], // ソースバケットの名前。(オプション)
"src-key" => ['help' => 'The name of the source 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"]; // 宛先オブジェクトの名前。
$srcKey = $options["src-key"]; // ソースオブジェクトの名前。
// 環境変数から認証情報をロードします。
// EnvironmentVariableCredentialsProvider を使用して、環境変数からアクセスキー ID とアクセスキーシークレットを読み取ります。
$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);
// オブジェクトをコピーするための CopyObjectRequest オブジェクトを作成します。
$request = new Oss\Models\CopyObjectRequest(
bucket: $bucket,
key: $key,
sourceKey: $srcKey,
sourceBucket: $bucket);
if (!empty($options["src-bucket"])) {
$request->sourceBucket = $options["src-bucket"]; // ソースバケット名が指定されている場合は、sourceBucket を設定します。
}
$request->sourceKey = $srcKey; // ソースオブジェクト名を設定します。
// オブジェクトのコピー操作を実行します。
$result = $client->copyObject($request);
// コピー結果を出力します。
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP ステータスコード。たとえば、200 は成功を示します。
'request id:' . $result->requestId . PHP_EOL // リクエスト ID。リクエストのデバッグや追跡に使用されます。
);
コピーマネージャー (Copier) を使用したオブジェクトの名前変更
次のコードは、コピーマネージャーの Copier.Copy メソッドを使用してオブジェクトの名前を変更する方法を示しています。
<?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], // 宛先オブジェクトの名前。(必須)
"src-key" => ['help' => 'The name of the source 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"]; // 宛先オブジェクトの名前。
$srcKey = $options["src-key"]; // ソースオブジェクトの名前。
// 環境変数から認証情報をロードします。
// EnvironmentVariableCredentialsProvider を使用して、環境変数からアクセスキー ID とアクセスキーシークレットを読み取ります。
$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);
// コピー操作を実行するための Copier インスタンスを作成します。
$copier = $client->newCopier();
$dstKey = $key; // 宛先オブジェクトの名前。
$copyRequest = new Oss\Models\CopyObjectRequest(
bucket: $bucket,
key: $dstKey,
sourceBucket: $bucket,
sourceKey: $srcKey);
$result = $copier->copy(
request: $copyRequest,
);
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP ステータスコード。たとえば、200 は成功を示します。
'request id:' . $result->requestId . PHP_EOL // リクエスト ID。リクエストのデバッグや追跡に使用されます。
);