第4章 エントリーポイント
ユーザーは、ホスト と ベース で設定されるエントリーポイント URI の
GET リクエストを介して API との対話を開始します。
例4.1 API エントリーポイントへのアクセス
ホスト が www.example.com で、ベース が /ovirt-engine/api の場合、エントリーポイントは以下の要求と共に表示されます。
GET /ovirt-engine/api HTTP/1.1
Accept: application/xml
Host: www.example.com
Authorization: [base64 encoded credentials]
HTTP/1.1 200 OK
Content-Type: application/xml
<api>
<link rel="hosts" href="/ovirt-engine/api/hosts"/>
<link rel="vms" href="/ovirt-engine/api/vms"/>
...
<product_info>
<name>Red Hat Virtualization</name>
<vendor>Red Hat</vendor>
<version revision="0" build="0" minor="0" major="4"/>
</product_info>
<special_objects>
<link rel="templates/blank" href="..."/>
<link rel="tags/root" href="..."/>
</special_objects>
<summary>
<vms>
<total>10</total>
<active>3</active>
</vms>
<hosts>
<total>2</total>
<active>2</active>
</hosts>
<users>
<total>8</total>
<active>2</active>
</users>
<storage_domains>
<total>2</total>
<active>2</active>
</storage_domains>
</summary>
</ovirt-engine/api>
注記
分かりやすくするために、他のすべての例では
Host: および Authorization: リクエストヘッダーを省略し、base がデフォルトの /ovirt-engine/api パスであると想定します。このベースパスは実装によって異なります。
4.1. 製品情報
エントリーポイントには、API ユーザーが Red Hat Virtualization 環境の正当性を判断するのに役立つ
product_info 要素が含まれています。これには、製品の 名前、vendor、および version が含まれます。
例4.2 本物の Red Hat Virtualization 環境を検証する
以下の要素は、本物の Red Hat Virtualization 4.0 環境を識別します。
<api>
...
<product_info>
<name>Red Hat Virtualization</name>
<vendor>Red Hat</vendor>
<version>
<build>2</build>
<full_version>4.0.2.3-0.1.el7ev</full_version>
<major>4</major>
<minor>0</minor>
<revision>0</revision>
</version>
</product_info>
...
</ovirt-engine/api>
