すべてのプロダクト
Search
ドキュメントセンター

Object Storage Service:PHP 用 OSS SDK を使用して追記アップロードを実行する

最終更新日:Aug 06, 2025

既存の追記可能なオブジェクトにコンテンツを追記できます。このトピックでは、Object Storage Service (OSS) SDK for PHP を使用して追記アップロードを実行する方法について説明します。

注意事項

  • このトピックのサンプルコードでは、中国 (杭州) リージョンのリージョン ID cn-hangzhou を使用しています。デフォルトでは、パブリックエンドポイントを使用してバケット内のリソースにアクセスします。バケットが配置されているのと同じリージョン内の他の Alibaba Cloud サービスからバケット内のリソースにアクセスする場合は、内部エンドポイントを使用します。サポートされているリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。

  • 単純なアップロードには、oss:PutObject 権限が必要です。詳細については、「RAM ユーザーにカスタムポリシーをアタッチする」をご参照ください。

  • コンテンツを追記するオブジェクトが存在しない場合は、この操作を呼び出すと、追記可能なオブジェクトが作成されます。

  • コンテンツを追記するオブジェクトが存在する場合:

    • オブジェクトが追記可能なオブジェクトで、追記操作の開始位置として指定された位置が現在の長さと等しい場合、コンテンツはオブジェクトの末尾に追記されます。

    • オブジェクトが追記可能なオブジェクトで、追記操作の開始位置として指定された位置がこのオブジェクトの現在の長さと等しくない場合、PositionNotEqualToLength エラーが返されます。

    • オブジェクトが追記可能なオブジェクトでない場合、ObjectNotAppendable エラーが返されます。

  • このトピックでは、アクセス認証情報は環境変数から取得されます。詳細については、「アクセス認証情報を構成する」をご参照ください。

サンプルコード

AppendObject メソッドの使用

<?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], // (必須) オブジェクトの名前を指定します。
];

// 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 を使用して、環境変数から 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);

// 追記するコンテンツを指定します。
$data='Hello Append Object'; // サンプルデータを実際のコンテンツに置き換えます。

// AppendObjectRequest オブジェクトを作成して、特定のオブジェクトにデータを追記します。
$request = new Oss\Models\AppendObjectRequest(bucket: $bucket, key: $key);
$request->body = Oss\Utils::streamFor($data); // HTTP リクエスト本文がバイナリストリームであることを指定します。
$request->position = 0; // 最初の追記操作の開始位置を 0 に設定します。

// 追記アップロード操作を実行します。
$result = $client->appendObject($request);

// 結果を表示します。
// HTTP ステータスコードとリクエスト ID を表示して、リクエストが成功したかどうかを確認します。
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP ステータスコード。たとえば、HTTP ステータスコード 200 は、リクエストが成功したことを示します。
    'request id:' . $result->requestId . PHP_EOL .    // リクエスト ID。リクエストのデバッグまたは追跡に使用されます。
    'next append position:' . $result->nextPosition . PHP_EOL // 次の追記操作の開始位置を指定します。
);

参考資料

  • 追記アップロードの完全なサンプルコードについては、GitHub にアクセスしてください。