Chapter 7. Common Features
The API structures resource representations in the following XML document structure:
<resource id="resource_id" href="/api/collection/resource_id">
<name>Resource-Name</name>
<description>A description of the resource</description>
...
</resource>
In the context of a virtual machine, the representation appears as follows:
<vm id="5b9bbce5-0d72-4f56-b931-5d449181ee06"
href="/api/vms/5b9bbce5-0d72-4f56-b931-5d449181ee06">
<name>RHEL6-Machine</name>
<description>Red Hat Enterprise Linux 6 Virtual Machine</description>
...
</vm>
All resource representations contain a set of common attributes
Table 7.2. Common attributes to resource representations
Attribute
|
Type
|
Description
|
Properties
|
---|
id
|
GUID
|
Each resource in the virtualization infrastructure contains an id , which acts as a globally unique identifier (GUID). The GUID is the primary method of resource identification.
|
|
href
|
string
|
The canonical location of the resource as an absolute path.
|
|
All resource representations contain a set of common elements.
Table 7.3. Common elements to resource representations
Element
|
Type
|
Description
|
Properties
|
---|
name
|
string
|
A user-supplied human readable name for the resource. The name is unique across all resources of its type.
|
|
description
|
string
|
A free-form user-supplied human readable description of the resource.
|
|