322 lines
16 KiB
Plaintext
322 lines
16 KiB
Plaintext
|
|
<!-- Extension List/Show Parameters -->
|
|
|
|
<!ENTITY extensionListShowParameters '
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="namespace" style="plain" type="xsd:string" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>Indicates namespace of the extension.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="name" style="plain" type="xsd:string" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>Indicates name of the extension.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="updated" style="plain" type="xsd:string" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>Indicates updated time of the extension.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="description" style="plain" type="xsd:string" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>Indicates description of the extension.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="alias" style="plain" type="xsd:string" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>Indicates alias of the extension.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="links" style="plain" type="xsd:list" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>A list of links for the extension.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
<!--
|
|
A collection of common faults, these are pretty much expected
|
|
in every request.
|
|
-->
|
|
<!ENTITY commonFaults
|
|
'
|
|
<response xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:computeFault"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:serviceUnavailable"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:badRequest"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:unauthorized"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:forbidden"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
<response status="405" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:badMethod"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
<response status="413" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:overLimit"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!--
|
|
Faults on GET
|
|
-->
|
|
<!ENTITY getFaults
|
|
'
|
|
<response status="404" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:itemNotFound"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>'>
|
|
<!--
|
|
Faults on POST/PUT
|
|
-->
|
|
<!ENTITY postPutFaults
|
|
'
|
|
<response status="415" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:badMediaType"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:NetworkNotFound"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>'>
|
|
<!ENTITY rebootFaults
|
|
'<response status="422" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:HTTPUnprocessableEntity"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!--
|
|
Faults that can occur when we are building servers or images.
|
|
-->
|
|
<!ENTITY buildFaults
|
|
'
|
|
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:serverCapacityUnavailable"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!--
|
|
Holds build in progress which occurs when an operation fails
|
|
because the server is in the process of being built.
|
|
-->
|
|
<!ENTITY inProgressFault
|
|
'
|
|
<response status="409" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:buildInProgress"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
|
|
|
|
<!-- Server Group List/Show Parameters -->
|
|
|
|
<!ENTITY serverGroupsParameters '
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="wrs-sg:project_id" required="true"
|
|
type="csapi:UUID">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN"><para>The tenant or project owning the server group.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="policies" required="true"
|
|
type="xsd:list">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN">
|
|
<para>A list of policies associated with the server group.</para>
|
|
<para>Titanium Cloud added <code>wrs-sg:affinity-hyperthread</code> policy to indicate that <code>only</code> the
|
|
members of this server group can share sibling threads with each other.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="metadata" required="true"
|
|
type="xsd:dict">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN">
|
|
<para>Associated metadata key-and-value pairs.</para>
|
|
<para>Titanium Cloud added a boolean valued <code>wrs-sg:best_effort</code> metadata key-and-value
|
|
pair to indicate whether the server groups policy should be strictly enforced
|
|
or not.</para>
|
|
<para>Titanium Cloud added an integer valued <code>wrs-sg:group_size</code> metadata key-and-value
|
|
pair to indicate the maximum number of members of the server group.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
<!-- Server List/Show Parameters -->
|
|
<!ENTITY serverParameters '
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="nics" style="plain" type="xsd:list" required="false">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN">
|
|
<para>A <code>nics</code> object. Contains the list of NICs provisioned on the server
|
|
instance.</para>
|
|
<para>Optionally, in Titanium Cloud, each NIC can contain:</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>A <code>wrs-if:vif_model</code> attribute specifying the NICs vif model;
|
|
where valid vif model values are: <code>e1000</code>,
|
|
<code>virtio</code>, <code>ne2k_pci</code>, <code>pcnet</code>,
|
|
<code>rtl8139</code>, <code>pci-passthrough</code>,
|
|
<code>pci-sriov</code>. If not specified,
|
|
a vif model of <code>virtio</code> is being used.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>A <code>wrs-if:vif_pci_address</code> attibute specifying the NICs PCI
|
|
address. If not specified, the PCI address in the guest is chosen by the
|
|
hypervisor and this value is empty.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="addresses" style="plain" type="xsd:list" required="false">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN">
|
|
<para>An <code>addresses</code> object. Contains
|
|
the list of addresses associated with the server instance.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="wrs-if:nics" style="plain" type="xsd:list" required="false">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN">
|
|
<para>An <code>wrs-if:nics</code> object. Contains
|
|
the list of NIC devices allocated for a VM instance. These
|
|
are a VM representation of the neutron port objects associated
|
|
to the VM. They are listed in the same order which the network
|
|
attachments were specified when the VM was launched.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="wrs-res:topology" style="plain" type="xsd:string" required="false">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN">
|
|
<para>This attribute specifies a number of resource details of the VM Server;
|
|
the number of numa nodes, the amount of memory and the memory page size,
|
|
and the current number of VCPUs.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="wrs-res:pci_devices" style="plain" type="xsd:string" required="false">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN">
|
|
<para>List of pci devices associated with the server instance;
|
|
indicates the numa node, pci address, type of device, vendor id,
|
|
product id.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="wrs-res:vcpus (min/cur/max)" style="plain" type="xsd:list" required="false">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN">
|
|
<para>This attribute specifies the minimum number of vcpus, current number of
|
|
vcpus and maximum number of vcpus of a VM Server.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="wrs-sg:server_group" style="plain" type="xsd:string" required="false">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN">
|
|
<para>This attribute specifies the server group which the
|
|
VM Server is in; a null-string if the VM Server is not in a
|
|
server group.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
|
|
|
|
<!-- Flavor Extra Spec List/Show Parameters -->
|
|
<!ENTITY flavorextraspecListShowParameters '
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="sw:wrs:guest:heartbeat" style="plain" type="xsd:boolean" required="false">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN">
|
|
<para>Indicates whether or not the guest applications running in the virtual
|
|
machine make use of the Titanium Cloud Heartbeat client API.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="sw:wrs:vtpm" style="plain" type="xsd:boolean" required="false">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN">
|
|
<para>Indicates whether or not to expose a TPM device to the Guest.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="hw:wrs:shared_vcpu" style="plain" type="xsd:integer" required="false">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN">
|
|
<para>Indicates the vCPU of the guest virtual machine that will be scheduled
|
|
to run on a shared CPU of the host. Note, this can be specified even if
|
|
hw:cpu_policy is set to dedicated; allowing the guest application to use
|
|
dedicated cores exclusively for its high-load tasks, but use a shared core
|
|
for its low-load (e.g. management type) tasks.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="hw:wrs:min_vcpus" style="plain" type="xsd:integer" required="false">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN">
|
|
<para>Indicates the minimum number of vCPUs for the virtual machine. The value
|
|
must be between one and the number of VCPUs in the flavor of the virtual
|
|
machine. If this extra_spec is specified then the server is assumed to support
|
|
vCPU scaling.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name=" extra spec " style="plain" type="xsd:integer" required="false">
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xml:lang="EN">
|
|
<para>See Wind River Titanium Cloud Administration Guide for complete list of
|
|
additional flavor extra specs.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
|
|
|
|
<!-- Useful for describing APIs -->
|
|
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
|
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
|
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
|
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|