PHP 2.0 向け OSS SDK を使用してオブジェクトを一覧表示する方法 - Object Storage Service

このトピックでは、PHP 向け Object Storage Service (OSS) SDK を使用して、バケット内のすべてのオブジェクトを一覧表示する方法について説明します。

注意事項

このトピックのサンプルコードでは、中国 (杭州) リージョンのリージョン ID cn-hangzhou を使用しています。デフォルトでは、パブリックエンドポイントを使用してバケット内のリソースにアクセスします。バケットが配置されているのと同じリージョン内の他の Alibaba Cloud サービスを使用してバケット内のリソースにアクセスする場合は、内部エンドポイントを使用します。 OSS のリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。
オブジェクトを一覧表示するには、oss:ListObjects 権限が必要です。詳細については、「RAM ユーザーへのカスタムポリシーのアタッチ」をご参照ください。

サンプルコード

次のサンプルコードは、ListObjectsV2 オペレーションを呼び出してバケット内のすべてのオブジェクトを一覧表示する例を示しています。

<?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], // (必須) バケットの名前を指定します。
];

// パラメータの説明を、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"]; // バケットの名前。

// 環境変数からアクセス認証情報を取得します。
// 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);

// ページごとにオブジェクトを一覧表示するための Paginator オブジェクトを作成します。
// ListObjectsV2Paginator オブジェクトを使用して、ページごとにオブジェクトを一覧表示します。
$paginator = new Oss\Paginator\ListObjectsV2Paginator(client: $client);
$iter = $paginator->iterPage(new Oss\Models\ListObjectsV2Request(bucket: $bucket)); // ページネーターを初期化します。

// 一覧表示されたオブジェクトをトラバースします。
foreach ($iter as $page) {
    foreach ($page->contents ??  [] as $object) {
        // ページ上の各オブジェクトに関する情報を表示します。
        // 各オブジェクトの名前、タイプ、サイズを表示します。
        print("Object: $object->key, $object->type, $object->size\n");
    }
}

一般的なシナリオ

ディレクトリ内のすべてのオブジェクトを一覧表示する

次のサンプルコードは、prefix パラメータを指定して、特定のディレクトリ内のすべてのオブジェクトに関する情報 (オブジェクトのサイズ、タイプ、名前を含む) を一覧表示する例を示しています。

<?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], // (必須) バケットの名前を指定します。
];

// パラメータの説明を、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"]; // バケットの名前。

// 環境変数からアクセス認証情報を取得します。
// 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);

// ページごとにオブジェクトを一覧表示するための Paginator オブジェクトを作成します。
// ListObjectsV2Paginator オブジェクトを使用して、ページごとにオブジェクトを一覧表示します。
$paginator = new Oss\Paginator\ListObjectsV2Paginator(client: $client);
$iter = $paginator->iterPage(new Oss\Models\ListObjectsV2Request(
                bucket: $bucket,
                prefix: "example/", // prefix パラメータを example/ に設定して、example/ ディレクトリ内のすべてのオブジェクトを一覧表示します。
            )); // ページネーターを初期化します。

// 一覧表示されたオブジェクトをトラバースします。
foreach ($iter as $page) {
    foreach ($page->contents ??  [] as $object) {
        // ページ上の各オブジェクトに関する情報を表示します。
        // 各オブジェクトの名前、タイプ、サイズを表示します。
        print("Object: $object->key, $object->type, $object->size\n");
    }
}

名前に特定のプレフィックスが含まれるオブジェクトを一覧表示する

次のサンプルコードは、prefix パラメータを指定して、名前に特定のプレフィックスが含まれるオブジェクトに関する情報 (オブジェクトのサイズ、タイプ、名前を含む) を一覧表示する例を示しています。

<?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], // (必須) バケットの名前を指定します。
];

// パラメータの説明を、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"]; // バケットの名前。

// 環境変数からアクセス認証情報を取得します。
// 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);

// ページごとにオブジェクトを一覧表示するための Paginator オブジェクトを作成します。
// ListObjectsV2Paginator オブジェクトを使用して、ページごとにオブジェクトを一覧表示します。
$paginator = new Oss\Paginator\ListObjectsV2Paginator(client: $client);
$iter = $paginator->iterPage(new Oss\Models\ListObjectsV2Request(
                bucket: $bucket,
                prefix: "my-object-", // prefix パラメータを my-object- に設定して、名前に my-object- プレフィックスが含まれるオブジェクトを一覧表示します。
            )); // ページネーターを初期化します。

// 一覧表示されたオブジェクトをトラバースします。
foreach ($iter as $page) {
    foreach ($page->contents ??  [] as $object) {
        // ページ上の各オブジェクトに関する情報を表示します。
        // 各オブジェクトの名前、タイプ、サイズを表示します。
        print("Object: $object->key, $object->type, $object->size\n");
    }
}

特定の数のオブジェクトを一覧表示する

次のサンプルコードは、maxKeys パラメータを指定して、特定の数のオブジェクトに関する情報 (オブジェクトのサイズ、タイプ、名前を含む) を一覧表示する例を示しています。

<?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], // (必須) バケットの名前を指定します。
];

// パラメータの説明を、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"]; // バケットの名前。

// 環境変数からアクセス認証情報を取得します。
// 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);

// ページごとにオブジェクトを一覧表示するための Paginator オブジェクトを作成します。
// ListObjectsV2Paginator オブジェクトを使用して、ページごとにオブジェクトを一覧表示します。
$paginator = new Oss\Paginator\ListObjectsV2Paginator(client: $client);
$iter = $paginator->iterPage(new Oss\Models\ListObjectsV2Request(
                bucket: $bucket,
                maxKeys: 10, // 一覧表示操作で一覧表示できるオブジェクトの最大数を 10 に設定します。
            )); // ページネーターを初期化します。

// 一覧表示されたオブジェクトをトラバースします。
foreach ($iter as $page) {
    foreach ($page->contents ??  [] as $object) {
        // ページ上の各オブジェクトに関する情報を表示します。
        // 各オブジェクトの名前、タイプ、サイズを表示します。
        print("Object: $object->key, $object->type, $object->size\n");
    }
}

特定の位置からすべてのオブジェクトを一覧表示する

次のサンプルコードは、StartAfter パラメータを設定して、一覧表示操作の開始位置を指定する例を示しています。名前が StartAfter パラメータの値よりもアルファベット順で後のすべてのオブジェクトが返されます。

<?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], // (必須) バケットの名前を指定します。
];

// パラメータの説明を、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"]; // バケットの名前。

// 環境変数からアクセス認証情報を取得します。
// 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);

// ページごとにオブジェクトを一覧表示するための Paginator オブジェクトを作成します。
// ListObjectsV2Paginator オブジェクトを使用して、ページごとにオブジェクトを一覧表示します。
$paginator = new Oss\Paginator\ListObjectsV2Paginator(client: $client);
$iter = $paginator->iterPage(new Oss\Models\ListObjectsV2Request(
                bucket: $bucket,
                startAfter:"my-object-", // startAfter パラメータを my-object- に設定して、名前が my-object- よりもアルファベット順で後のすべてのオブジェクトを一覧表示します。
            )); // ページネーターを初期化します。

// 一覧表示されたオブジェクトをトラバースします。
foreach ($iter as $page) {
    foreach ($page->contents ??  [] as $object) {
        // ページ上の各オブジェクトに関する情報を表示します。
        // 各オブジェクトの名前、タイプ、サイズを表示します。
        print("Object: $object->key, $object->type, $object->size\n");
    }
}

ルートディレクトリ内のすべてのサブディレクトリを一覧表示する

<?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], // (必須) バケットの名前を指定します。
];


// 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"]; // バケットの名前。

// 環境変数からアクセス認証情報をロードします。
// 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);

// ページごとにオブジェクトを一覧表示するための Paginator オブジェクトを作成します。
// ListObjectsV2Paginator オブジェクトを使用して、ページごとにオブジェクトを一覧表示します。
$paginator = new Oss\Paginator\ListObjectsV2Paginator(client: $client);
$iter = $paginator->iterPage(request: new Oss\Models\ListObjectsV2Request(
                bucket: $bucket,
                prefix:"",
                delimiter: "/",
            )); // ページネーターを初期化します。

// 一覧表示されたオブジェクトをトラバースします。
foreach ($iter as $page) {
    # 各ページのサブディレクトリを出力します。
    foreach ($page->commonPrefixes ??  [] as $prefixObject) {
        echo "SubPrefix: " . $prefixObject->prefix . PHP_EOL;
    }
}

Object Storage Service:PHP 2.0 向け OSS SDK を使用したオブジェクトの一覧表示