2.3.4. リスト

list メソッドは、コレクション内の複数のオブジェクトの表現を取得します。

仮想マシンのコレクションの一覧表示

# Find the service that manages the collection of virtual
# machines:
vms_service = system_service.vms_service
vms = vms_service.list

結果は、対応するタイプのインスタンスを含む Ruby 配列です。上記の例では、Ruby のクラス Vm のインスタンスの一覧が応答として返されます。

一部のサービスの list メソッドは、追加のパラメーターをサポートします。

たとえば、ほとんどすべてのトップレベルコレクションは、結果をフィルターリングするための search パラメーターと、サーバーから返される結果の数を制限するための max パラメーターをサポートしています。

"my*" と呼ばれる 10 台の仮想マシンの一覧表示

vms = vms_service.list(search: 'name=my*', max: 10)

注記

すべての list メソッドが search または max パラメーターをサポートしているわけではありません。一部の list メソッドは、他のパラメーターをサポートする場合があります。詳細は、リファレンスドキュメントを参照してください。

結果のリストが空の場合、戻り値は空の Ruby 配列になります。nil になることはありません。

結果のリストを取得できない場合、SDK は失敗の詳細を含むエラー例外を発生させます。