4.2. リンク要素
Entry Point へのアクセスは、API が公開するすべてのリソースコレクションの
リンク
要素と URI を提供します。各コレクションは関係タイプを使用して、クライアントが必要とする URI を識別します。
関係 | 説明 |
---|---|
capabilities | Red Hat Virtualization Manager でサポートされる機能。 |
datacenters | データセンター。 |
clusters | ホストクラスター。 |
networks | 仮想ネットワーク。 |
storagedomains | ストレージドメイン。 |
hosts | 準備中です。 |
vms | 仮想マシン。 |
disks | 仮想ディスク。 |
templates | テンプレート。 |
vmpools | 仮想マシンプール。 |
domains | Identity サービスドメイン。 |
groups | インポートされた ID サービスグループ。 |
roles | ロール。 |
users | ユーザー。 |
tags | タグ。 |
events | イベント。 |
図4.1 API エントリーポイントと API によって公開されるリソースコレクションの関係
注記
応答例で示されているすべての URI は分かりやすくなっています。サーバーによって返されるすべての URI の形式は不透明です。クライアントはエントリーポイント URI から特定のリソースに移動し、関係タイプを使用して URI にアクセスします。
リンク
要素には、特定のコレクションの 検索
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 は、これらのフォームの違いを説明する URI 用に Collected ABNF を提供します。
[4]
URI テンプレートの形式を説明するインターネットドラフトは http://tools.ietf.org/html/draft-gregorio-uritemplate-03 から入手できます。