437 lines
24 KiB
Plaintext
437 lines
24 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>
|
|
'>
|
|
|
|
|
|
<!-- COMMON List/Show Parameters -->
|
|
|
|
<!ENTITY commonListShowParameters '
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="uuid" style="plain" 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 universally unique identifier for this object.</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>For convenience, resources contain links to themselves.
|
|
This allows a client to easily obtain rather than construct
|
|
resource URIs. The following types of link relations are
|
|
associated with resources: a self link containing a versioned
|
|
link to the resource, and a bookmark link containing a permanent
|
|
link to a resource that is appropriate for long term storage.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="created_at" style="plain" type="xsd:dateTime" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>The time when the object was created.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="updated_at" style="plain" type="xsd:dateTime" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>The time when the object was last updated.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
|
|
<!-- Alarm List/Show Parameters -->
|
|
|
|
<!ENTITY alarmListShowParameters '
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="alarm_id" 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>The alarm ID; each type of alarm has a unique ID. Note
|
|
the alarm_id and the entity_instance_id uniquely identify
|
|
an alarm instance.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="entity_instance_id" 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>The instance of the object raising alarm. A . separated list
|
|
of sub-entity-type=instance-value pairs, representing the containment
|
|
structure of the overall entity instance. Note
|
|
the alarm_id and the entity_instance_id uniquely identify
|
|
an alarm instance.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="reason_text" 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>The text description of the alarm.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="severity" 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>The severity of the alarm; <code>critical</code>,
|
|
<code>major</code>, <code>minor</code>, or <code>warning</code>.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="timestamp" style="plain" type="xsd:dateTime" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>The time in UTC at which the alarm has last been updated.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="uuid" style="plain" 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 unique identifier of the alarm.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
<!ENTITY alarmDetailShowParameters '
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="alarm_state" 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>The state of the alarm; <code>set</code> or <code>clear</code></para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="service_affecting" 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 whether the alarm affects the service.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="proposed_repair_action" 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>The proposed action to clear the alarm.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="alarm_type" 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>The type of the alarm.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="entity_type_id" 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>The type of the object raising the alarm. A . separated list
|
|
of sub-entity-type, representing the containment structure of the
|
|
overall entity type.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="probable_cause" 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>The probable cause of the alarm.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="suppression" 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 whether suppression of the specific alarm is allowed.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
<!ENTITY alarmSummaryShowParameters '
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="system_uuid" style="plain" type="csapi:UUID" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>UUID of the system.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="status" 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>Overall system status based on alarms present; <code>critical</code>,
|
|
<code>degraded</code>, or <code>OK</code>.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="critical" style="plain" type="xsd:integer" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>Count of critical alarms on the system</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="major" style="plain" type="xsd:integer" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>Count of major alarms on the system</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="minor" style="plain" type="xsd:integer" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>Count of minor alarms on the system</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="warnings" style="plain" type="xsd:integer" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>Count of warnings on the system</para>
|
|
</wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
|
|
<!-- Event Log List/Show Parameters -->
|
|
|
|
<!ENTITY eventLogListShowParameters '
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="event_log_id" 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>The event log ID; each type of event log has a unique ID. Note
|
|
the event_log_id and the entity_instance_id uniquely identify
|
|
an event log instance.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="state" 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>The state of the event; <code>set</code>, <code>clear</code> or <code>log</code></para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="entity_instance_id" 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>The instance of the object generating the event log. A . separated list
|
|
of sub-entity-type=instance-value pairs, representing the containment
|
|
structure of the overall entity instance. Note
|
|
the event_log_id and the entity_instance_id uniquely identify
|
|
an event log instance.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="reason_text" 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>The text description of the event log.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="severity" 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>The severity of the event log; <code>critical</code>,
|
|
<code>major</code>, <code>minor</code> or <code>warning</code>.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="timestamp" style="plain" type="xsd:dateTime" >
|
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
|
<para>The time in UTC at which the event log has last been updated.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="uuid" style="plain" 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 unique identifier of the event log.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="next" 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>The next attribute is the request to use to get the next n
|
|
items. It is used to paginate the event log list.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
<!ENTITY eventLogDetailShowParameters '
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="state" 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>The state of the event; <code>set</code>, <code>clear</code> or <code>log</code></para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="service_affecting" 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 whether the event affects the service.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="proposed_repair_action" 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>The proposed action to clear the event.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="event_log_type" 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>The type of the event.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="entity_type_id" 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>The type of the object raising the alarm. A . separated list
|
|
of sub-entity-type, representing the containment structure of the
|
|
overall entity type.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="probable_cause" 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>The probable cause of the event.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="suppression" 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 whether suppression of the specific event is allowed.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
|
|
<!-- Event Suppression List/Show Parameters -->
|
|
|
|
<!ENTITY EventSuppressionListShowParameters '
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="alarm_id" 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>The alarm ID type (event ID type) that can be suppressed or unsuppressed.
|
|
</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>The text description of the event type.</para>
|
|
</wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="suppression_status" 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>The suppression status for the event ID type; <code>suppressed</code> or <code>unsuppressed</code></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>'>
|