7.3.7. クエリーの構文
API は URI テンプレートを使用して
GET リクエストで検索 クエリー を実行します。
GET /ovirt-engine/api/collection?search={query} HTTP/1.1
Accept: application/xml
クエリー テンプレートの値は、API が コレクション に転送する検索クエリーを参照します。この クエリー は、Red Hat Virtualization クエリー言語と同じ形式を使用します。
(criteria)[sortby (element) asc|desc]
sortby 句はオプションで、結果を順序付ける場合にのみ必要です。
| コレクション | 基準 | 結果 |
|---|---|---|
hosts | vms.status=up | が 稼働 している仮想マシンを実行しているすべてのホストの一覧を表示します。 |
vms | domain=qa.company.com | 指定されたドメインで稼働しているすべての仮想マシンの一覧を表示します。 |
vms | users.name=mary | ユーザー名が mary のユーザーに属するすべての仮想マシンの一覧を表示します。 |
events | severity>normal sortby time | 重大度が normal よりも高いすべての イベント のリストを表示し、time 要素の値で並べ替えます。 |
events | severity>normal sortby time desc | 重大度が normal よりも高いすべての イベント のリストを表示し、time 要素の値で降順でソートします。 |
API では、演算子やスペースなどの予約済み文字を変換するために、
クエリー テンプレートを URL エンコードする必要があります。
例7.3 URL でエンコードされた検索クエリー
GET /ovirt-engine/api/vms?search=name%3Dvm1 HTTP/1.1 Accept: application/xml
