4.2. リンクの要素
エントリーポイントにアクセスすると、API が公開するすべてのリソースコレクションの
link
要素と URI が提供されます。コレクションには、リレーションタイプを使用して、クライアントが必要とする URI を特定します。
リレーションシップ | 説明 |
---|---|
capabilities | Red Hat Enterprise Virtualization Manager がサポートする機能 |
datacenters | データセンター |
clusters | ホストクラスター |
networks | 仮想ネットワーク |
storagedomains | ストレージドメイン |
hosts | ホスト |
vms | 仮想マシン |
disks | 仮想マシンのディスク |
templates | テンプレート |
vmpools | 仮想マシンのプール |
domains | ID サービスドメイン |
groups | インポートした ID サービスグループ |
roles | ロール |
users | ユーザー |
tags | タグ |
events | イベント |
図4.1 API エントリーポイントと、API によって公開されるリソースコレクションとの間のリレーションシップ
注記
応答例に記載されている URI はすべて、例示を目的としています。サーバーが返す全 URI の形式は不透明です。クライアントはエントリーポイント URI を使って特定のリソースにナビゲートし、リレーションシップタイプを使って URI にアクセスします。
link
要素には、 特定のコレクションの search
URI セットも含まれます。これらの URI は URI テンプレート [4] を使って検索クエリーを統合します。URI テンプレートの目的はクエリーパラメーターの自然な HTTP パターンを使って検索式を受け入れることです。クライアントには、URI 構造に関する予備知識は必要ありません。したがって、クライアントはこれらのテンプレートが不透明であるものとして扱い、URI テンプレートライブラリーを使用してアクセスする必要があります。
各検索クエリーの URI テンプレートは、
"collection/search"
の形式を使用したリレーションタイプで特定されます。
リレーションシップ | 説明 |
---|---|
datacenters/search | データセンターに対してクエリーを実行します。 |
clusters/search | ホストのクラスターに対してクエリーを実行します。 |
storagedomains/search | ストレージドメインに対してクエリーを実行します。 |
hosts/search | ホストに対してクエリーを実行します。 |
vms/search | 仮想マシンに対してクエリーを実行します。 |
disks/search | ディスクに対してクエリーを実行します。 |
templates/search | テンプレートに対してクエリーを実行します。 |
vmpools/search | 仮想マシンのプールに対してクエリーを実行します。 |
events/search | イベントに対してクエリーを実行します。 |
users/search | ユーザーに対してクエリーを実行します。 |
[3]
これらの形式の相違点については、Uniform Resource Locator Generic Syntax について解説した RFC 文書を参照してください (Collected ABNF for URI)。
[4]
URI テンプレートの形式について解説したインターネットドラフトは、http://tools.ietf.org/html/draft-gregorio-uritemplate-03 に掲載されています。