388 lines
23 KiB
Plaintext
388 lines
23 KiB
Plaintext
|
|
<!--
|
|
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>'>
|
|
<!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>
|
|
'>
|
|
|
|
<!-- Image List Parameters -->
|
|
|
|
<!ENTITY imageListParameters
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="changes-since" style="query" required="false" type="xsd:dateTime"><doc><p xmlns="http://www.w3.org/1999/xhtml">A time/date stamp for when the image last changed status.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="server" style="query" required="false" type="xsd:anyURI"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the server in URL format.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="query" required="false" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the image as a string.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="status" style="query" required="false" type="csapi:ImageStatus"><doc><p xmlns="http://www.w3.org/1999/xhtml">Value of the status of the image so that you can filter on "ACTIVE" for example.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="marker" style="query" required="false" type="csapi:UUID"><doc><p xmlns="http://www.w3.org/1999/xhtml">UUID of the image at which you want to set a marker.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="limit" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the limit of values to return.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="type" style="query" required="false" type="xsd:string" default="ALL"><doc><p xmlns="http://www.w3.org/1999/xhtml">Value of the type of image, such as BASE, SERVER, or ALL.</p></doc>
|
|
<option value="BASE"/>
|
|
<option value="SERVER"/>
|
|
<option value="ALL"/>
|
|
</param>
|
|
'>
|
|
<!-- Server Create Parameters -->
|
|
<!ENTITY serverCreateParameters
|
|
'
|
|
|
|
<param name="server" style="plain" required="true"
|
|
type="csapi:ServerForCreate" path="/csapi:server">
|
|
<doc xml:lang="EN" title="server">
|
|
<p xmlns="http://www.w3.org/1999/xhtml"
|
|
>server.</p>
|
|
</doc>
|
|
</param>
|
|
<param name="imageRef" style="plain" required="true"
|
|
type="csapi:string">
|
|
<doc xml:lang="EN" title="imageRef">
|
|
<p xmlns="http://www.w3.org/1999/xhtml">The
|
|
image reference for the desired image for
|
|
your server instance.</p>
|
|
<p xmlns="http://www.w3.org/1999/xhtml"
|
|
>Specify as an ID or full URL.</p></doc>
|
|
</param>
|
|
<param name="flavorRef" style="plain" required="true"
|
|
type="csapi:string">
|
|
<doc xml:lang="EN" title="flavorRef">
|
|
<p xmlns="http://www.w3.org/1999/xhtml">The
|
|
flavor reference for the desired flavor
|
|
for your server instance.</p>
|
|
<p xmlns="http://www.w3.org/1999/xhtml"
|
|
>Specify as an ID or full URL.</p></doc>
|
|
</param>
|
|
<param name="name" style="plain" required="true"
|
|
type="csapi:string">
|
|
<doc xml:lang="EN" title="name">
|
|
<p xmlns="http://www.w3.org/1999/xhtml">The
|
|
name for your created server.</p></doc>
|
|
</param>
|
|
<param name="metadata" style="plain" required="false"
|
|
type="csapi:string">
|
|
<doc xml:lang="EN" title="metadata">
|
|
<p xmlns="http://www.w3.org/1999/xhtml"
|
|
>Metadata key and value pairs. The maximum
|
|
size of the metadata key and value is 255
|
|
bytes each.</p></doc>
|
|
</param>
|
|
<param name="personality" style="plain"
|
|
required="false" type="csapi:string">
|
|
<doc xml:lang="EN" title="personality">
|
|
<p xmlns="http://www.w3.org/1999/xhtml">File
|
|
path and contents (text only) to inject
|
|
into the server at launch. The maximum
|
|
size of the file path data is 255 bytes.
|
|
The maximum limit refers to the number of
|
|
bytes in the decoded data and not the
|
|
number of characters in the encoded
|
|
data.</p></doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="security_group" style="plain" required="false" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">The name of the security group. If blank, the server is created in the "default" security group.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="user_data" style="plain" required="false" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">Use to pass configuration information or scripts upon launch. Must be Base64 encoded.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="availability_zone" style="plain" required="false" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">The availability zone in which to launch the server.</p></doc></param>
|
|
|
|
'>
|
|
|
|
<!-- Server List Parameters -->
|
|
|
|
<!ENTITY serverListParameters
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="changes-since" style="query" required="false" type="xsd:dateTime"><doc><p xmlns="http://www.w3.org/1999/xhtml">A time/date stamp for when the server last changed status.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="image" style="query" required="false" type="xsd:anyURI"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the image in URL format.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="flavor" style="query" required="false" type="xsd:anyURI"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the flavor in URL format.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="query" required="false" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the server as a string.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="marker" style="query" required="false" type="csapi:UUID"><doc><p xmlns="http://www.w3.org/1999/xhtml">UUID of the server at which you want to set a marker.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="limit" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the limit of values to return.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="status" style="query" required="false" type="csapi:ServerStatus"><doc><p xmlns="http://www.w3.org/1999/xhtml">Value of the status of the server so that you can filter on "ACTIVE" for example.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="host" style="query" required="false" type="xsd:string"><doc><p xmlns="http://www.w3.org/1999/xhtml">Name of the host as a string.</p></doc></param>
|
|
'>
|
|
|
|
<!ENTITY serverResponseParameters
|
|
' <param name="Location" style="header" required="true"
|
|
type="xsd:anyURI">
|
|
<doc xml:lang="EN" title="Location"><p
|
|
xmlns="http://www.w3.org/1999/xhtml">Full URL
|
|
to a server created by the service.</p></doc>
|
|
</param>
|
|
<param name="adminPass" style="plain" required="true"
|
|
type="xsd:string">
|
|
<doc xml:lang="EN" title="adminPass"><p
|
|
xmlns="http://www.w3.org/1999/xhtml">The administrative password.</p></doc>
|
|
</param>
|
|
<param name="id" style="plain" required="true"
|
|
type="csapi:uuid">
|
|
<doc xml:lang="EN" title="id"><p
|
|
xmlns="http://www.w3.org/1999/xhtml">The server ID.</p></doc>
|
|
</param>
|
|
<param name="links" style="plain" required="true"
|
|
type="xsd:string">
|
|
<doc xml:lang="EN" title="id"><p
|
|
xmlns="http://www.w3.org/1999/xhtml">Server href and rel links.</p></doc>
|
|
</param>
|
|
'>
|
|
|
|
<!-- Flavor List Parameters -->
|
|
|
|
<!ENTITY flavorListParameters
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="minDisk" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the minimum disk space in GB so you can filter results.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="minRam" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the minimum RAM so you can filter results.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="marker" style="query" required="false" type="csapi:UUID"><doc><p xmlns="http://www.w3.org/1999/xhtml">UUID of the flavor at which you want to set a marker.</p></doc></param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="limit" style="query" required="false" type="xsd:int"><doc><p xmlns="http://www.w3.org/1999/xhtml">Integer value for the limit of values to return.</p></doc></param>
|
|
'>
|
|
|
|
<!ENTITY quotaSetsReqParameters
|
|
' <param name="quota_set" style="plain" required="true"
|
|
type="xsd:string">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">A
|
|
quota_set object.</p></doc>
|
|
</param>
|
|
<param name="cores" style="plain" required="false"
|
|
type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of instance cores allowed for each
|
|
tenant.</p></doc>
|
|
</param>
|
|
<param name="fixed_ips " style="plain" required="false"
|
|
type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of fixed IP addresses allowed for each
|
|
tenant. Must be equal to or greater than the
|
|
number of allowed instances.</p></doc>
|
|
</param>
|
|
<param name="floating_ips" style="plain" required="false"
|
|
type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of floating IP addresses allowed for
|
|
each tenant.</p></doc>
|
|
</param>
|
|
<param name="id" style="plain" required="false"
|
|
type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
ID for the quota set.</p></doc>
|
|
</param>
|
|
<param name="injected_file_content_bytes" style="plain"
|
|
required="false" type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of bytes of content allowed for each
|
|
injected file.</p></doc>
|
|
</param>
|
|
<param name="injected_file_path_bytes " style="plain"
|
|
required="false" type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of bytes allowed for each injected file
|
|
path.</p></doc>
|
|
</param>
|
|
<param name="injected_files" style="plain"
|
|
required="false" type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of injected files allowed for each
|
|
tenant.</p></doc>
|
|
</param>
|
|
<param name="instances" style="plain" required="false"
|
|
type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of instances allowed for each
|
|
tenant.</p></doc>
|
|
</param>
|
|
<param name="key_pairs" style="plain" required="false"
|
|
type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of key pairs allowed for each
|
|
user.</p></doc>
|
|
</param>
|
|
<param name="metadata_items" style="plain"
|
|
required="false" type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of metadata items allowed for each
|
|
instance.</p></doc>
|
|
</param>
|
|
<param name="ram" style="plain" required="false"
|
|
type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
amount of instance RAM in megabytes allowed
|
|
for each tenant.</p></doc>
|
|
</param>
|
|
<param name="security_group_rules" style="plain"
|
|
required="false" type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of rules allowed for each security
|
|
group.</p></doc>
|
|
</param>
|
|
<param name="security_groups" style="plain"
|
|
required="false" type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of security groups allowed for each
|
|
tenant.</p></doc>
|
|
</param>
|
|
'>
|
|
|
|
<!ENTITY quotaSetsRespParameters
|
|
' <param name="quota_set" style="plain" required="true"
|
|
type="xsd:string">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">A
|
|
quota_set object.</p></doc>
|
|
</param>
|
|
<param name="cores" style="plain" required="true"
|
|
type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of instance cores allowed for each
|
|
tenant.</p></doc>
|
|
</param>
|
|
<param name="fixed_ips " style="plain" required="true"
|
|
type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of fixed IP addresses allowed for each
|
|
tenant. Must be equal to or greater than the
|
|
number of allowed instances.</p></doc>
|
|
</param>
|
|
<param name="floating_ips" style="plain" required="true"
|
|
type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of floating IP addresses allowed for
|
|
each tenant.</p></doc>
|
|
</param>
|
|
<param name="id" style="plain" required="true"
|
|
type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
ID for the quota set.</p></doc>
|
|
</param>
|
|
<param name="injected_file_content_bytes" style="plain"
|
|
required="true" type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of bytes of content allowed for each
|
|
injected file.</p></doc>
|
|
</param>
|
|
<param name="injected_file_path_bytes " style="plain"
|
|
required="true" type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of bytes allowed for each injected file
|
|
path.</p></doc>
|
|
</param>
|
|
<param name="injected_files" style="plain"
|
|
required="true" type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of injected files allowed for each
|
|
tenant.</p></doc>
|
|
</param>
|
|
<param name="instances" style="plain" required="true"
|
|
type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of instances allowed for each
|
|
tenant.</p></doc>
|
|
</param>
|
|
<param name="key_pairs" style="plain" required="true"
|
|
type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of key pairs allowed for each
|
|
user.</p></doc>
|
|
</param>
|
|
<param name="metadata_items" style="plain"
|
|
required="true" type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of metadata items allowed for each
|
|
instance.</p></doc>
|
|
</param>
|
|
<param name="ram" style="plain" required="true"
|
|
type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
amount of instance RAM in megabytes allowed
|
|
for each tenant.</p></doc>
|
|
</param>
|
|
<param name="security_group_rules" style="plain"
|
|
required="false" type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of rules allowed for each security
|
|
group.</p></doc>
|
|
</param>
|
|
<param name="security_groups" style="plain"
|
|
required="true" type="xsd:int">
|
|
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
|
|
number of security groups allowed for each
|
|
tenant.</p></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>'>
|
|
|