Questo contenuto non è disponibile nella lingua selezionata.

Chapter 4. Entry Point


A user begins interacting with the API through a GET request on the entry point URI consisting of a host and base.

Example 4.1. Accessing the API Entry Point

If the host is www.example.com and the base is /ovirt-engine/api, the entry point appears with the following request:
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>

Note

For simplicity, all other examples omit the Host: and Authorization: request headers and assume the base is the default /ovirt-engine/api path. This base path differs depending on your implementation.

4.1. Product Information

The entry point contains a product_info element to help an API user determine the legitimacy of the Red Hat Virtualization environment. This includes the name of the product, the vendor and the version.

Example 4.2. Verify a genuine Red Hat Virtualization environment

The follow elements identify a genuine Red Hat Virtualization 4.0 environment:
<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>
Red Hat logoGithubRedditYoutube

Informazioni sulla documentazione di Red Hat

Aiutiamo gli utenti Red Hat a innovarsi e raggiungere i propri obiettivi con i nostri prodotti e servizi grazie a contenuti di cui possono fidarsi.

Rendiamo l’open source più inclusivo

Red Hat si impegna a sostituire il linguaggio problematico nel codice, nella documentazione e nelle proprietà web. Per maggiori dettagli, visita ilBlog di Red Hat.

Informazioni su Red Hat

Forniamo soluzioni consolidate che rendono più semplice per le aziende lavorare su piattaforme e ambienti diversi, dal datacenter centrale all'edge della rete.

© 2024 Red Hat, Inc.