PHP SDK V1 を使用したバケット間のファイルコピー - Object Storage Service

このトピックでは、同一リージョン内のソースバケットから、同じまたは別の宛先バケットにオブジェクトをコピーする方法について説明します。

注意事項

このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。同一リージョン内の他の Alibaba Cloud サービスから OSS にアクセスするには、内部エンドポイントを使用します。サポートされているリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。
このトピックでは、OSS エンドポイントを使用して OSSClient インスタンスを作成します。カスタムドメイン名または Security Token Service (STS) を使用して OSSClient インスタンスを作成する場合は、「OssClient の作成」をご参照ください。
Resource Access Management (RAM) ユーザーがコピー操作を実行する場合、その RAM ユーザーはソースオブジェクトに対する oss:GetObject 権限を持っている必要があります。また、宛先バケットに対する oss:PutObject および oss:GetObject 権限も必要です。RAM ユーザーにカスタムポリシーを付与する方法の詳細については、「RAM ポリシーの一般的な例」をご参照ください。
ソースバケットと宛先バケットに保持ポリシーが設定されていないことを確認してください。設定されている場合、The object you specified is immutable. というエラーメッセージが返されます。
ソースバケットと宛先バケットは、同じリージョンにある必要があります。たとえば、中国 (杭州) リージョンにあるバケットから中国 (青島) リージョンにある別のバケットにオブジェクトをコピーすることはできません。

小さいファイルのコピー

次のサンプルコードは、$ossClient->copyObject メソッドを使用して 1 GB 未満のオブジェクトをコピーする方法を示しています。

<?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// この例では、中国 (杭州) リージョンのエンドポイントを使用します。実際の値に置き換えてください。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// ソースバケットの名前を指定します。例：srcexamplebucket。
$from_bucket = "srcexamplebucket";
// ソースオブジェクトの完全なパスを指定します。完全なパスにバケット名を含めることはできません。例：srcdir/exampleobject.txt。
$from_object = "srcdir/exampleobject.txt";
// ソースバケットと同じリージョンにある宛先バケットの名前を指定します。例：destexamplebucket。
// 同じバケット内でオブジェクトをコピーする場合は、ソースバケットと宛先バケットの名前が同じであることを確認してください。
$to_bucket = "destexamplebucket";
// 宛先オブジェクトの完全なパスを指定します。完全なパスにバケット名を含めることはできません。例：destdir/exampleobject.txt。
$to_object = "destdir/exampleobject.txt";

$options = array(
    'headers'=>array(
      // 同じ名前の宛先オブジェクトを上書きするかどうかを指定します。この例では、このパラメーターは true に設定され、上書きを防ぎます。
      // 'x-oss-forbid-overwrite' => 'true',
      // ソースオブジェクトの ETag が指定した ETag と一致する場合、OSS はオブジェクトをコピーし、200 OK を返します。
      // 'x-oss-copy-source-if-match' => '5B3C1A2E053D763E1B002CC****',
      // ソースオブジェクトの ETag が指定した ETag と一致しない場合、OSS はオブジェクトをコピーし、200 OK を返します。
      // 'x-oss-copy-source-if-none-match' => '5B3C1A2E053D763E1B002CC****',
      // 指定した時刻がオブジェクトの実際の変更時刻と同じかそれ以降である場合、OSS はオブジェクトをコピーし、200 OK を返します。
      // 'x-oss-copy-source-if-unmodified-since' => gmdate('2021-12-09T07:01:56.000Z'),
      // 指定した時刻がオブジェクトの実際の変更時刻より前である場合、OSS はオブジェクトをコピーし、200 OK を返します。
      // 'x-oss-copy-source-if-modified-since' => gmdate('2021-12-09T07:01:56.000Z'),
      // 宛先オブジェクトのメタデータをどのように設定するかを指定します。この例では、このパラメーターは COPY に設定され、ソースオブジェクトから宛先オブジェクトにメタデータをコピーします。
      // 'x-oss-metadata-directive' => 'COPY',
      // OSS が宛先オブジェクトを作成するために使用するサーバ側暗号化アルゴリズムを指定します。
      // 'x-oss-server-side-encryption' => 'KMS',
      // KMS によって管理されるカスタマーマスターキー (CMK)。このパラメーターは、x-oss-server-side-encryption が KMS に設定されている場合にのみ有効です。
      // 'x-oss-server-side-encryption-key-id' => '9468da86-3509-4f8d-a61e-6eab****',
      // 宛先オブジェクトのアクセス権限を指定します。この例では、このパラメーターは private に設定されています。これは、オブジェクト所有者と承認されたユーザーのみが読み取りおよび書き込み権限を持ち、他のユーザーはオブジェクトにアクセスできないことを意味します。
      // 'x-oss-object-acl' => 'private',
      // オブジェクトのストレージクラスを指定します。この例では、このパラメーターは Standard に設定されています。
      // 'x-oss-storage-class' => 'Standard',
      // オブジェクトのタグを指定します。複数のタグを指定できます。
      // 'x-oss-tagging' => 'k1=v1&k2=v2&k3=v3',
      // 宛先オブジェクトのタグをどのように設定するかを指定します。この例では、このパラメーターは COPY に設定され、ソースオブジェクトから宛先オブジェクトにタグをコピーします。
      // 'x-oss-tagging-directive' => 'COPY',
    ),
);

try{
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);

    $ossClient->copyObject($from_bucket, $from_object, $to_bucket, $to_object);
} catch(OssException $e) {
    printf(__FUNCTION__ . ": FAILED\n");
    printf($e->getMessage() . "\n");
    return;
}
print(__FUNCTION__ . ": OK" . "\n");

大きいファイルのコピー

サイズが 1 GB を超えるオブジェクトをコピーするには、オブジェクトをパートに分割し、UploadPartCopy を使用してパートを順番にコピーする必要があります。マルチパートコピーを実装するには、次の手順を実行します。

$ossClient->initiateMultipartUpload を呼び出して、マルチパートコピータスクを初期化します。
$ossClient->uploadPartCopy を呼び出して、パートをコピーします。最後のパートを除くすべてのパートは 100 KB より大きい必要があります。
$ossClient->completeMultipartUpload を呼び出して、マルチパートコピータスクをコミットします。

次のサンプルコードは、マルチパートコピーを実行する方法を示しています。

<?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
$provider = new EnvironmentVariableCredentialsProvider();
// この例では、中国 (杭州) リージョンのエンドポイントを使用します。実際の値に置き換えてください。
$endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
// ソースバケットの名前を指定します。
$from_bucket = "yourSrcBucketName";
// ソースオブジェクトの完全なパスを指定します。完全なパスにバケット名を含めることはできません。例：srcdir/exampleobject.txt。
$from_object = "yourSrcObjectName";
// ソースバケットと同じリージョンにある宛先バケットの名前を指定します。
$to_bucket = "yourDestBucketName";
// 宛先オブジェクトの完全なパスを指定します。完全なパスにバケット名を含めることはできません。例：destdir/exampleobject.txt。
$to_object = 'yourDestObjectName';

// 必要に応じてパートサイズをバイト単位で設定します。
$part_size = 256*1024*1024;

try{
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);

    $objectMeta = $ossClient->getObjectMeta($from_bucket, $from_object);

    $length = $objectMeta['content-length'] + 0;

    // マルチパートコピータスクを初期化します。
    $upload_id = $ossClient->initiateMultipartUpload($to_bucket, $to_object);

    // パートをコピーします。
    $pieces = $ossClient->generateMultiuploadParts($length, $part_size);
    $response_upload_part = array();
    $copyId = 1;
    $upload_position = 0;

    foreach ($pieces as $i => $piece) {
        $from_pos = $upload_position + (integer)$piece['seekTo'];
        $to_pos = (integer)$piece['length'] + $from_pos - 1;
        $up_options = array(
            'start' => $from_pos,
            'end' => $to_pos,
              'headers'=>array(
                // ソースオブジェクトの ETag が指定した ETag と一致する場合、OSS はオブジェクトをコピーし、200 OK を返します。
                // 'x-oss-copy-source-if-match' => '5B3C1A2E053D763E1B002CC****',
                // ソースオブジェクトの ETag が指定した ETag と一致しない場合、OSS はオブジェクトをコピーし、200 OK を返します。
                // 'x-oss-copy-source-if-none-match' => '5B3C1A2E053D763E1B002CC****',
                // 指定した時刻がオブジェクトの実際の変更時刻と同じかそれ以降である場合、OSS はオブジェクトをコピーし、200 OK を返します。
                // 'x-oss-copy-source-if-unmodified-since' => gmdate('2021-12-09T07:01:56.000Z'),
                // 指定した時刻がオブジェクトの実際の変更時刻より前である場合、OSS はオブジェクトをコピーし、200 OK を返します。
                // 'x-oss-copy-source-if-modified-since' => gmdate('2021-12-09T07:01:56.000Z'),
          ),
        );
        $response_upload_part[] = $ossClient->uploadPartCopy( $from_bucket, $from_object, $to_bucket, $to_object, $copyId, $upload_id, $up_options);
        $copyId = $copyId + 1;
    }

    // マルチパートコピーを完了します。
    $upload_parts = array();
    foreach ($response_upload_part as $i => $etag) {
        $upload_parts[] = array(
            'PartNumber' => ($i + 1),
            'ETag' => $etag,
        );
    }
    $result = $ossClient->completeMultipartUpload($to_bucket, $to_object, $upload_id, $upload_parts);
} catch(OssException $e) {
    printf(__FUNCTION__ . ": FAILED\n");
    printf($e->getMessage() . "\n");
    return;
}
print(__FUNCTION__ . ": OK" . "\n");

Object Storage Service:ファイルのコピー (PHP SDK V1)

注意事項

小さいファイルのコピー

大きいファイルのコピー

関連ドキュメント