Object Storage Service:OSS SDK for PHP 2.0

クイック統合

前提条件

OSS SDK for PHP 2.0 は PHP 7.4 以降をサポートしています。このドキュメントのサンプルコードでは PHP 8 の名前付き引数を使用しているため、PHP 8.0 以降が必要です。パッケージ管理のために Composer をダウンロードしてください。

php -version コマンドを実行して PHP のバージョンを確認します。PHP がインストールされていない場合、またはバージョンが 8.0 より前の場合は、PHP をダウンロードしてインストールしてください。

SDK のインストール

1. プロジェクトディレクトリを作成し、次のコマンドを実行して Composer 経由で OSS SDK for PHP 2.0 をインストールします。サンプルコードとの互換性を確保するために、最新バージョンを使用してください。

   mkdir oss-php-example && cd oss-php-example && composer require alibabacloud/oss-v2

2. OSS SDK for PHP 2.0 パッケージをインポートします。

   require_once __DIR__ . '/../vendor/autoload.php';
   
   use AlibabaCloud\Oss\V2 as Oss;

アクセス認証情報の設定

RAM ユーザーの AccessKey ペアを使用してアクセス認証情報を設定します。

1. RAM コンソールで、永続的な AccessKey ペア を持つ RAM ユーザーを作成します。AccessKey ペアを保存し、RAM ユーザーに AliyunOSSFullAccess 権限を付与します。

2. RAM ユーザーの AccessKey ペアを使用して環境変数を設定します。

   Linux

   1. 次のコマンドを実行して、環境変数の設定を ~/.bashrc ファイルに追加します。

      echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bashrc
      echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bashrc

      1. 次のコマンドを実行して変更を適用します。

         source ~/.bashrc

      2. 次のコマンドを実行して、環境変数が設定されているか確認します。

         echo $OSS_ACCESS_KEY_ID
         echo $OSS_ACCESS_KEY_SECRET

   macOS

   1. ターミナルで次のコマンドを実行して、デフォルトのシェルタイプを表示します。

      echo $SHELL

      1. デフォルトのシェルタイプに基づいて、次の手順を実行します。

         Zsh

         1. 次のコマンドを実行して、環境変数の設定を ~/.zshrc ファイルに追加します。

            echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.zshrc
            echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.zshrc

         2. 次のコマンドを実行して変更を適用します。

            source ~/.zshrc

         3. 次のコマンドを実行して、環境変数が設定されているか確認します。

            echo $OSS_ACCESS_KEY_ID
            echo $OSS_ACCESS_KEY_SECRET

         Bash

         1. 次のコマンドを実行して、環境変数の設定を ~/.bash_profile ファイルに追加します。

            echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bash_profile
            echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bash_profile

         2. 次のコマンドを実行して変更を適用します。

            source ~/.bash_profile

         3. 次のコマンドを実行して、環境変数が設定されているか確認します。

            echo $OSS_ACCESS_KEY_ID
            echo $OSS_ACCESS_KEY_SECRET

   Windows

   CMD

   1. コマンドプロンプトウィンドウで次のコマンドを実行します。

      setx OSS_ACCESS_KEY_ID "YOUR_ACCESS_KEY_ID"
      setx OSS_ACCESS_KEY_SECRET "YOUR_ACCESS_KEY_SECRET"

      1. 次のコマンドを実行して、環境変数が設定されているか確認します。

         echo %OSS_ACCESS_KEY_ID%
         echo %OSS_ACCESS_KEY_SECRET%

   PowerShell

   1. PowerShell で次のコマンドを実行します。

      [Environment]::SetEnvironmentVariable("OSS_ACCESS_KEY_ID", "YOUR_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
      [Environment]::SetEnvironmentVariable("OSS_ACCESS_KEY_SECRET", "YOUR_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)

      1. 次のコマンドを実行して、環境変数が設定されているか確認します。

         [Environment]::GetEnvironmentVariable("OSS_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
         [Environment]::GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)

クライアントの初期化

サンプルコードを実行する前に、<region-id> などのプレースホルダーを、リージョンとエンドポイントの実際値 (例: ap-southeast-1) に置き換えてください。

<?php

/**
 * OSS SDK for PHP 2.0 クライアント設定の完全ガイド
 *
 * ===========================================
 * V4 署名とリージョン設定
 * ===========================================
 * • OSS SDK for PHP 2.0 は、デフォルトで V4 署名アルゴリズムを使用します。
 * • クライアントを初期化する際に、Alibaba Cloud のリージョン ID を指定する必要があります。
 * • リージョン ID のリストについては、「リージョンとエンドポイント」をご参照ください。
 *
 * ===========================================
 * エンドポイント設定
 * ===========================================
 * • SDK では、endpoint パラメーターを使用してサービスエンドポイントをカスタマイズできます。
 * • endpoint を省略すると、SDK はリージョン情報から自動的にパブリックエンドポイントを構築します。
 * • たとえば、リージョンが '<region-id>' の場合、構築されるエンドポイントは 'https://oss-<region-id>.aliyuncs.com' です。
 *
 * ===========================================
 * プロトコルの選択
 * ===========================================
 * • SDK は、デフォルトで HTTPS を使用してエンドポイントを構築します。これは推奨されるプロトコルです。
 * • HTTP プロトコルを使用するには、エンドポイントに http:// を含めます。
 * • HTTPS の例: 'https://oss-<region-id>.aliyuncs.com'
 * • HTTP の例: 'http://oss-<region-id>.aliyuncs.com'
 */

// 依存関係を正しくロードするためにオートローダーをインポートします。
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// EnvironmentVariableCredentialsProvider は、環境変数から AccessKey ID と AccessKey Secret を読み取ります。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

# デフォルトの SDK 設定をロードし、認証情報プロバイダーを設定します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider(credentialsProvider: $credentialsProvider);

// 方法 1: リージョンのみを指定します (推奨)。SDK は自動的に HTTPS エンドポイントを構築します。
$cfg->setRegion(region: "<region-id>");

// // 方法 2: リージョンとエンドポイントの両方を指定します。
// $cfg->setRegion(region: '<region-id>')->setEndpoint(endpoint: 'https://oss-<region-id>.aliyuncs.com');

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// アップロードするデータ。
$data = 'Hello OSS';

// オブジェクトをアップロードするために PutObjectRequest オブジェクトを作成します。
$request = new Oss\Models\PutObjectRequest(
                bucket: "Your Bucket Name",
                key: "Your Object Key",
            );
$request->body = Oss\Utils::streamFor($data); // リクエストボディをデータストリームに設定します。

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

// アップロード結果を出力します。
printf(
    'status code: %s' . PHP_EOL . // HTTP ステータスコード。
    'request id: %s' . PHP_EOL .  // リクエスト ID。
    'etag: %s' . PHP_EOL,         // オブジェクトの ETag。
    $result->statusCode,
    $result->requestId,
    $result->etag
);

アップロード成功時の期待される出力：

status code: 200
request id: 687F2BEEDC44E0313527BA07
etag: "F0F18C2C66AE1DD512BDCD4366F76DA3"

クライアント設定

カスタムドメインの使用

ブラウザでのファイルプレビューや CDN アクセラレーションを有効にするには、バケットにカスタムドメインをバインドします。

EnvironmentVariableCredentialsProviderAccessKey IDAccessKey シークレットsetUseCnametrue<?php

// 依存関係をロードするためにオートローダーファイルをインクルードします。
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// <code data-tag="inlineCode" id="d5d25f3951tix">EnvironmentVariableCredentialsProvider

タイムアウト制御

<?php

// autoload ファイルから依存関係をロードします。
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// 環境変数から AccessKey ID と AccessKey Secret を読み取ります。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

# デフォルトの SDK 設定をロードします。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider(credentialsProvider: $credentialsProvider); // 認証情報プロバイダーを設定します。

$cfg->setRegion(region: "<region-id>");

# 接続タイムアウトを設定します。
$cfg->setConnectTimeout(connectTimeout: 30);

# 読み書きタイムアウトを設定します。
$cfg->setReadwriteTimeout(readwriteTimeout:30);

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// 作成したクライアントを後続の操作で使用します...

最大リトライ回数

OSSClient は、失敗したリクエストをデフォルトで 3 回リトライします。

高同時実行数または不安定なネットワークシナリオでは、setRetryMaxAttempts を使用してリトライ回数を増やします。

<?php

// 依存関係が正しくロードされるように、autoload ファイルをインクルードします。
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// EnvironmentVariableCredentialsProvider を使用して、環境変数から AccessKey ID と AccessKey Secret を読み取ります。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

# デフォルトの SDK 設定をロードし、認証情報プロバイダーを設定します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider(credentialsProvider: $credentialsProvider);

$cfg->setRegion(region: "<region-id>");

// HTTP リクエストの最大試行回数を設定します。デフォルト値は 3 です。
$cfg->setRetryMaxAttempts(5);

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// 作成したクライアントを後続の操作で使用します...

HTTP/HTTPS プロトコル

setDisableSSL(true) を使用して HTTPS プロトコルを無効にできます。

<?php

// 依存関係をロードするために autoload ファイルをインポートします。
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// 環境変数から Access Key ID と Access Key Secret を読み取る認証情報プロバイダーを作成します。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

// デフォルト設定をロードし、認証情報プロバイダーを設定します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider(credentialsProvider: $credentialsProvider);

$cfg->setRegion(region: "<region-id>");

// SSL を無効にします。
$cfg->setDisableSSL(true);

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// OSS 操作にクライアントを使用します。

Swoole フレームワークでのコルーチンの使用

次のコードは、Swoole フレームワークに基づいてコルーチンをサポートする OSS クライアントを作成する方法の例です。

<?php
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;
use GuzzleHttp\HandlerStack;
use Hyperf\Guzzle\CoroutineHandler;
use function Hyperf\Coroutine\co;

// OSS クライアントを設定します。
$region = '<region-id>'; // OSS リージョン。
$bucket = 'bucket-name'; // 送信先バケット。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider(); // 環境変数から認証情報をロードします。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider(credentialsProvider: $credentialsProvider); // 認証情報プロバイダーを設定します。
$cfg->setRegion(region: $region); // リージョンを設定します。
$cfg->setEndpoint(endpoint: 'http://oss-<region-id>.aliyuncs.com'); // エンドポイントを設定します。

// コルーチンをサポートする OSS クライアントを作成します。
$client = new Oss\Client(config: $cfg, options: ['handler' => HandlerStack::create(handler: new CoroutineHandler())]);

// コルーチンタスク 1: swoole.txt をアップロードします。
co(function () use ($client, $bucket) {
    try {
        $key = 'swoole.txt'; // オブジェクト名。
        $data = 'Hello OSS'; // オブジェクトのコンテンツ。
        $request = new Oss\Models\PutObjectRequest($bucket, $key); // アップロードリクエストを作成します。
        $request->body = Oss\Utils::streamFor($data); // リクエストボディを設定します。
        $result = $client->putObject(request: $request); // アップロードを実行します。
        echo "Task 1 Result:\n" . var_export($result, true) . "\n"; // 結果を出力します。
    } catch (\Exception $e) {
        echo "Task 1 Error: " . $e->getMessage() . "\n"; // 例外をキャッチします。
    }
});

// コルーチンタスク 2: hyperf.txt をアップロードします。
co(function () use ($client, $bucket) {
    try {
        $key = 'hyperf.txt'; // オブジェクト名。
        $data = 'Hello OSS'; // オブジェクトのコンテンツ。
        $request = new Oss\Models\PutObjectRequest($bucket, $key); // アップロードリクエストを作成します。
        $request->body = Oss\Utils::streamFor($data); // リクエストボディを設定します。
        $result = $client->putObject($request); // アップロードを実行します。
        echo "Task 2 Result:\n" . var_export($result, true) . "\n"; // 結果を出力します。
    } catch (\Exception $e) {
        echo "Task 2 Error: " . $e->getMessage() . "\n"; // 例外をキャッチします。
    }
});

内部エンドポイントの使用

アプリケーションが Alibaba Cloud Elastic Compute Service (ECS) インスタンスにデプロイされており、同じリージョン内の OSS リソースに頻繁にアクセスする必要がある場合は、内部エンドポイントを使用してトラフィックコストを削減し、アクセス速度を向上させることができます。

<?php

// 依存関係を正しくロードするために autoload ファイルをインクルードします。
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// 環境変数から AccessKey ID と AccessKey Secret を読み取る認証情報プロバイダーを作成します。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

# デフォルトの SDK 設定をロードし、認証情報プロバイダーを設定します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider(credentialsProvider: $credentialsProvider);

// 方法 1: リージョンを指定し、setUseInternalEndpoint を true に設定します。
$cfg->setRegion('<region-id>')->setUseInternalEndpoint(true);

// // 方法 2: リージョンとエンドポイントを直接指定します。
// // バケットが配置されているリージョンの内部エンドポイントを指定します。
// // HTTP プロトコルを使用するには、エンドポイントを 'http://oss-<region-id>-internal.aliyuncs.com' に設定します。
// $cfg->setRegion('<region-id>')->setEndpoint('https://oss-<region-id>-internal.aliyuncs.com');

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// 作成したクライアントを後続の操作で使用します...

アクセラレーションエンドポイントの使用

<?php

// プロジェクトの依存関係をロードします。
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// 環境変数から AccessKey ID と AccessKey Secret を読み取ります。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

# デフォルトの SDK 設定をロードし、認証情報プロバイダーを設定します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider(credentialsProvider: $credentialsProvider);

// 方法 1: リージョンを指定し、setUseAccelerateEndpoint を true に設定します。
$cfg->setRegion('<region-id>')->setUseAccelerateEndpoint(true);

// // 方法 2: リージョンとエンドポイントを直接指定します。
// // リージョンのアクセラレーションエンドポイントを指定します。
// $cfg->setRegion('<region-id>')->setEndpoint('https://oss-accelerate.aliyuncs.com');

// OSS クライアントを作成します。
$client = new Oss\Client($cfg);

// このクライアントを後続の操作で使用します。

プライベートドメインの使用

<?php

// 依存関係をロードするために autoload ファイルをインポートします。
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// 環境変数から AccessKey ID と AccessKey Secret を読み取る認証情報プロバイダーを作成します。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

# デフォルトの SDK 設定をロードし、認証情報プロバイダーを設定します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider(credentialsProvider: $credentialsProvider);

// リージョンを指定し、エンドポイントをプライベートドメインに設定します。
$cfg->setRegion('<region-id>')->setEndpoint('https://service.corp.example.com');

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// 作成したクライアントを後続の操作で使用します...

Alibaba Gov Cloud エンドポイントの使用

次のコードは、Gov cloud エンドポイントを使用して OSSClient を設定する方法の例です。

<?php

// 依存関係が正しくロードされるように、autoload ファイルをインポートします。
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// EnvironmentVariableCredentialsProvider を使用して、環境変数から AccessKey ID と AccessKey Secret を読み取ります。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

# デフォルトの SDK 設定をロードし、認証情報プロバイダーを設定します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider(credentialsProvider: $credentialsProvider); // 認証情報プロバイダーを設定します。

// バケットが配置されているリージョンを指定します。たとえば、中国 (北京) Alibaba Gov Cloud 1 の場合、リージョンを cn-north-2-gov-1 に設定します。
// バケットのリージョンの内部エンドポイントを指定します。たとえば、中国 (北京) Alibaba Gov Cloud 1 の場合、エンドポイントを 'https://oss-cn-north-2-gov-1-internal.aliyuncs.com' に設定します。
// HTTP プロトコルを使用するには、エンドポイントを 'http://oss-cn-north-2-gov-1-internal.aliyuncs.com' に設定します。
$cfg->setRegion('cn-north-2-gov-1')->setEndpoint('https://oss-cn-north-2-gov-1-internal.aliyuncs.com');

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// 作成したクライアントを後続の操作で使用します。

アクセス認証情報の設定

認証要件に基づいて認証情報メソッドを選択します。

RAM ユーザーの AccessKey ペアの使用

Alibaba Cloud アカウントまたは RAM ユーザーの AccessKey ペアで認証情報プロバイダーを初期化します。頻繁な認証情報ローテーションなしで OSS への長期アクセスが必要な安全な環境に適しています。この方法では手動での AccessKey のメンテナンスが必要となり、セキュリティリスクが高まります。

<?php

// 依存関係が正しくロードされるように、autoload ファイルをインクルードします。
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

$region = "<region-id>";

# 静的認証情報プロバイダーを作成し、RAM ユーザーの AccessKey ID と AccessKey Secret を設定します。
$credentialsProvider = new Oss\Credentials\StaticCredentialsProvider("RAM AccessKey ID","RAM AccessKey Secret");

// デフォルトの SDK 設定を使用します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 認証情報プロバイダーを設定します。
$cfg->setRegion($region); // バケットのリージョンを設定します。

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// 作成したクライアントを後続の操作で使用します...

STS トークンの使用

アプリケーションが OSS への一時的なアクセスを必要とする場合、Security Token Service (STS) から取得した一時的な認証情報 (AccessKey ID、AccessKey Secret、および STS トークン) を使用して認証情報プロバイダーを初期化できます。この方法では STS トークンを手動で維持する必要があり、セキュリティリスクとメンテナンスの複雑さが増すことに注意してください。さらに、OSS に複数回一時的にアクセスする場合は、STS トークンを手動で更新する必要があります。

<?php

// 依存関係が正しくロードされるように、autoload ファイルをインポートします。
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

$region = "<region-id>";

# 一時的な AccessKey ID と AccessKey Secret を指定します。Alibaba Cloud アカウントの AccessKey ペアは使用しないでください。
# STS からの AccessKey ID は「STS.」で始まります。
$stsAccessKeyId = 'STS.****************';
$stsAccessKeySecret = 'yourAccessKeySecret';
# セキュリティトークンを指定します。
$stsSecurityToken = 'yourSecurityToken';

# 静的認証情報プロバイダーを作成し、一時的な AccessKey ID、AccessKey Secret、およびセキュリティトークンを明示的に設定します。
$credentialsProvider = new Oss\Credentials\StaticCredentialsProvider($stsAccessKeyId, $stsAccessKeySecret, $stsSecurityToken);

// デフォルトの SDK 設定を使用します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 認証情報プロバイダーを設定します。
$cfg->setRegion($region); // バケットが配置されているリージョンを設定します。

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// 作成したクライアントを後続の操作で使用します...

RAM ロール ARN の使用

クロスアカウントアクセスや委任された権限付与には、RAM ロール ARN を使用して認証情報プロバイダーを初期化します。Credentials ツールは AssumeRole を呼び出すことで、STS トークンを自動的に取得および更新します。オプションで policy パラメーターを割り当てて、ロールの権限を制限できます。

1. Alibaba Cloud 認証情報ライブラリ credentials-php を追加します。

   composer require alibabacloud/credentials

2. AccessKey ペアと RAM ロール ARN をアクセス認証情報として設定します。

   <?php
   
   // 依存関係が正しくロードされるように、autoload ファイルをインクルードします。
   require_once __DIR__ . '/../vendor/autoload.php';
   
   use AlibabaCloud\Oss\V2 as Oss;
   use AlibabaCloud\Credentials\Credential;
   
   // 認証情報の種類と関連情報を定義するための設定オブジェクトを作成します。
   $config = new Credential\Config([
       // 認証情報の種類を指定します。この例では、RAM ロール ARN タイプを使用します。
       'type' => 'ram_role_arn',
   
       // Alibaba Cloud アカウントの AccessKey ID。
       'accessKeyId' => 'AccessKeyId',
   
       // Alibaba Cloud アカウントの AccessKey Secret。
       'accessKeySecret' => 'AccessKeySecret',
   
       // RAM ロールの ARN。例: acs:ram::USER_Id:role/ROLE_NAME。
       'roleArn' => 'RoleArn',
   
       // ロールセッション名。セッションを識別するために使用されます。
       'roleSessionName' => 'yourRoleSessionName',
   
       // オプション。STS トークンの権限を制限するために使用されるポリシー。
       'policy' => 'Policy',
   ]);
   
   // 設定オブジェクトで認証情報インスタンスを初期化します。
   $credential = new Credential($config);
   
   // デフォルトの SDK 設定をロードします。
   $cfg = Oss\Config::loadDefault();
   
   // コールバック関数で動的に認証情報を生成するように認証情報プロバイダーを設定します。
   $cfg->setCredentialsProvider(new Oss\Credentials\CredentialsProviderFunc(function () use ($credential) {
       // 一時的な認証情報 (STS トークン) を取得します。
       $cred = $credential->getCredential();
   
       // AccessKey ID、AccessKey Secret、およびセキュリティトークンを含む認証情報オブジェクトを返します。
       return new Oss\Credentials\Credentials(
           accessKeyId: $cred->getAccessKeyId(),       // 一時的な AccessKey ID。
           accessKeySecret: $cred->getAccessKeySecret(),   // 一時的な AccessKey Secret。
           securityToken: $cred->getSecurityToken()      // セキュリティトークン (STS トークン)。
       );
   }));
   
   $region = '<region-id>';
   $cfg->setRegion($region);
   
   // OSS クライアントインスタンスを作成します。
   $client = new Oss\Client($cfg);
   
   // クライアントを後続の操作で使用します...

RAM ロールの使用

ECS インスタンス、ECI インスタンス、または Container Service for Kubernetes (ACK) ワーカーノード上のアプリケーションには、RAM ロールを使用します。この方法では、AccessKey ペアを必要とせず、ご利用の Container Service for Kubernetes インスタンス内で STS トークンが自動的に更新されます。CreateRole。

1. Alibaba Cloud 認証情報ライブラリ credentials-php を追加します。

   composer require alibabacloud/credentials

2. RAM ロールをアクセス認証情報として設定します。

   <?php
   
   // 依存関係が正しくロードされるように、autoload ファイルをインポートします。
   require_once 'vendor/autoload.php';
   
   use AlibabaCloud\Oss\V2 as Oss;
   use AlibabaCloud\Credentials\Credential;
   
   // 認証情報タイプの設定オブジェクトを作成します。
   $config = new Credential\Config([
       // 認証情報タイプを設定します。RAM ロールの場合、この値は 'ecs_ram_role' である必要があります。
       'type' => 'ecs_ram_role',
   
       // インスタンスにアタッチされた RAM ロールの名前。
       'roleName' => "<role_name>",  // 実際の RAM ロール名に置き換えてください。
   ]);
   
   // 認証情報インスタンスを初期化します。
   $credential = new Credential($config);
   
   // デフォルトの OSS 設定をロードします。
   $cfg = Oss\Config::loadDefault();
   
   // 認証情報プロバイダーを、動的に認証情報を生成する関数に設定します。
   $cfg->setCredentialsProvider(new Oss\Credentials\CredentialsProviderFunc(function () use ($credential) {
       // 一時的な STS トークンを取得します。
       $cred = $credential->getCredential();
   
       // AccessKey ID、AccessKey Secret、およびセキュリティトークンを含む新しい認証情報オブジェクトを返します。
       return new Oss\Credentials\Credentials(
           accessKeyId: $cred->getAccessKeyId(),       // 一時的な AccessKey ID
           accessKeySecret: $cred->getAccessKeySecret(), // 一時的な AccessKey Secret
           securityToken: $cred->getSecurityToken()   // セキュリティトークン
       );
   }));
   
   $region = '<region-id>';
   $cfg->setRegion($region);
   
   // OSS クライアントインスタンスを作成します。
   $client = new Oss\Client($cfg);
   
   // 作成したクライアントを後続の操作で使用します...
   

OIDC ロール ARN の使用

ワーカーノードの RAM ロールにアクセスすべきでない、Container Service for Kubernetes (ACK) Pod 内の信頼できないアプリケーションには、RAM Roles for Service Account (RRSA) を使用します。ACK は Pod ごとに OIDC トークンファイルをマウントし、環境変数に設定を注入します。Credentials ツールはこれらの変数を読み取り、AssumeRoleWithOIDC を呼び出して最小限の権限を持つ STS トークンを取得します。AccessKey ペアは不要です。RRSA を使用して ServiceAccount の RAM 権限を設定し、Pod の権限を分離する。

カスタムアクセス認証情報の使用

上記の認証情報設定方法が要件を満たさない場合、認証情報を取得する方法をカスタマイズできます。SDK は複数の実装方法をサポートしています。

1. Oss\Credentials\CredentialsProviderFunc の使用

   Oss\Credentials\CredentialsProviderFunc は、Oss\Credentials\CredentialsProvider のユーザビリティラッパーです。

   <?php
   
   // 依存関係が正しくロードされるように、autoload ファイルをインポートします。
   require_once 'vendor/autoload.php';
   
   // 必要な名前空間をインポートします。
   use AlibabaCloud\Oss\V2 as Oss;
   use AlibabaCloud\Oss\V2\Credentials\Credentials;
   
   // 無名関数を使用して動的に認証情報を生成する認証情報プロバイダーを作成します。
   $provider = new Oss\Credentials\CredentialsProviderFunc(
       function () {
           // 長期的な認証情報を返します。これには AccessKey ID と AccessKey Secret のみが含まれます。
           return new Credentials(
               accessKeyId: 'id',         // 実際の RAM AccessKey ID に置き換えてください。
               accessKeySecret: 'secret'  // 実際の RAM AccessKey Secret に置き換えてください。
           );
   
           // セキュリティトークンを含む一時的な認証情報を返すには、次のコードのコメントを解除し、値を置き換えてください。
           /*
           return new Credentials(
               accessKeyId: 'id',          // 実際の STS 一時認証情報の AccessKey ID に置き換えてください。
               accessKeySecret: 'secret', // 実際の STS 一時認証情報の AccessKey Secret に置き換えてください。
               securityToken: 'token'     // 実際の STS セキュリティトークンに置き換えてください。
           );
           */
       }
   );
   
   // デフォルト設定をロードし、OSS 設定オブジェクトを取得します。
   $cfg = Oss\Config::loadDefault();
   
   // 認証情報プロバイダーを動的に生成されたプロバイダーに設定します。
   $cfg->setCredentialsProvider($provider);
   
   $region = '<region-id>';
   $cfg->setRegion($region);
   
   // OSS クライアントインスタンスを作成します。
   $client = new Oss\Client($cfg);
   
   // 作成したクライアントを後続の操作で使用します...
   

2. Oss\Credentials\CredentialsProvider の実装

   <?php
   
   // 依存関係が正しくロードされるように、autoload ファイルをインポートします。
   require_once 'vendor/autoload.php';
   
   // 必要な名前空間をインポートします。
   use AlibabaCloud\Oss\V2 as Oss;
   use AlibabaCloud\Oss\V2\Credentials\Credentials;
   
   // CredentialsProvider インターフェイスを実装するカスタム認証情報プロバイダークラス。
   class CustomerCredentialsProvider implements Oss\Credentials\CredentialsProvider
   {
       /**
        * 認証情報オブジェクトを取得します。
        *
        * @return Credentials 認証情報オブジェクトを返します。
        */
       public function getCredentials(): Credentials
       {
           // 長期的な認証情報を返します。これには AccessKey ID と AccessKey Secret のみが含まれます。
           return new Credentials(
               accessKeyId: 'id',         // 実際の RAM AccessKey ID に置き換えてください。
               accessKeySecret: 'secret'  // 実際の RAM AccessKey Secret に置き換えてください。
           );
   
           // セキュリティトークンを含む一時的な認証情報を返すには、次のコードのコメントを解除し、値を置き換えてください。
           /*
           return new Credentials(
               accessKeyId: 'id',          // 実際の STS 一時認証情報の AccessKey ID に置き換えてください。
               accessKeySecret: 'secret', // 実際の STS 一時認証情報の AccessKey Secret に置き換えてください。
               securityToken: 'token'     // 実際の STS セキュリティトークンに置き換えてください。
           );
           */
       }
   }
   
   // カスタム認証情報プロバイダーをインスタンス化します。
   $provider = new CustomerCredentialsProvider();
   
   // デフォルト設定をロードし、OSS 設定オブジェクトを取得します。
   $cfg = Oss\Config::loadDefault();
   
   // 認証情報プロバイダーをカスタムプロバイダーインスタンスに設定します。
   $cfg->setCredentialsProvider($provider);
   
   $region = '<region-id>';
   $cfg->setRegion($region);
   
   // OSS クライアントインスタンスを作成します。
   $client = new Oss\Client($cfg);
   
   // 作成したクライアントを後続の操作で使用します...
   

エラーのトラブルシューティング

エラーが発生すると、OSS は HTTP ステータスコード、メッセージ、リクエスト ID、およびエラーコード (EC) を返します。EC を使用して問題を診断します。

サンプルコード

次の表は、一般的な操作のサンプルコードをリストしています。