第4章 エントリーポイント
ホスト と ベース で構成されるエントリーポイント URI に対して
GET 要求を実行して、API との対話を開始します。
例4.1 API エントリーポイントへのアクセス
ホスト が
www.example.com で、ベース が /api の場合は、要求ではエントリーポイントが以下のように表示されます。
GET /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="/api/hosts"/>
<link rel="vms" href="/api/vms"/>
...
<product_info>
<name>Red Hat Enterprise Virtualization</name>
<vendor>Red Hat</vendor>
<version revision="0" build="0" minor="1" major="3"/>
</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>
</api>
注記
記載内容をわかりやすくするために、これ以降の例ではすべて
Host: と Authorization: の要求ヘッダーを省略しています。 また、base はデフォルトの /api パスであることを前提としています。実際のベースパスは、実装によって異なります。
4.1. 製品情報 リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Enterprise Virtualization 環境が適切であるかどうかを判断できるように、エントリーポイントには
product_info 要素が記載されています。これには、製品の name、vendor、version などが含まれます。
例4.2 正規の Red Hat Enterprise Virtualization 環境の確認
次の要素は、正規の Red Hat Enterprise Virtualization 3.2 環境を識別します。
<api>
...
<product_info>
<name>Red Hat Enterprise Virtualization</name>
<vendor>Red Hat</vendor>
<version revision="0" build="0" minor="2" major="3"/>
</product_info>
...
</api>