第 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. 产品信息
入口点包含一个
product_info
元素,用于帮助 API 用户决定 Red Hat Virtualization 环境的 legitimacy。这包括产品 的名称
、vendor
和 version
。
例 4.2. 验证 genuine 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>