Merge "Document orchestration event list API"
This commit is contained in:
Jenkins
@@ -861,7 +861,102 @@
|
||||
<para role="shortdesc">Lists events for a specified
|
||||
stack.</para>
|
||||
</wadl:doc>
|
||||
<response status="200"/>
|
||||
<request>
|
||||
<representation mediaType="application/xml">
|
||||
<param name="resource_action" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Filters the event list by the specified
|
||||
resource_action. You can use this filter multiple
|
||||
times to filter by multiple
|
||||
resource actions:
|
||||
<code>CREATE</code>, <code>DELETE</code>,
|
||||
<code>UPDATE</code>, <code>ROLLBACK</code>,
|
||||
<code>SUSPEND</code>, <code>RESUME</code> or
|
||||
<code>ADOPT</code>.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="resource_status" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Filters the event list by the specified
|
||||
resource_status. You can use this filter multiple
|
||||
times to filter by multiple
|
||||
resource statuses:
|
||||
<code>IN_PROGRESS</code>, <code>COMPLETE</code> or
|
||||
<code>FAILED</code>.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="resource_name" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Filters the event list by the specified
|
||||
resource_name. You can use this filter multiple
|
||||
times to filter by multiple
|
||||
resource names.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="resource_type" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Filters the event list by the specified
|
||||
resource_type. You can use this filter multiple
|
||||
times to filter by multiple
|
||||
resource types:
|
||||
<code>OS::Nova::Server</code>,
|
||||
<code>OS::Cinder::Volume</code>,
|
||||
<code>OS::Neutron::Port</code>, and so on.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="limit" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Limits the number of events that appear
|
||||
on a page to this value. The typical
|
||||
pattern of limit and marker is to make an
|
||||
initial limited request and then to use
|
||||
the ID of the last event from the response
|
||||
as the marker parameter in a subsequent
|
||||
limited request.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="marker" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Specifies the ID of the last-seen event.
|
||||
The typical pattern of limit and marker is
|
||||
to make an initial limited request and
|
||||
then to use the ID of the last event from
|
||||
the response as the marker parameter in a
|
||||
subsequent limited request.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="sort_keys" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Sorts the event list by:
|
||||
<code>resource_type</code> or
|
||||
<code>created_at</code>.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="sort_dir" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The sort direction of the event list.
|
||||
Which is <code>asc</code> (ascending) or
|
||||
<code>desc</code> (descending).</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code href="samples/event_list_resp.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="resource_event_list">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
@@ -869,7 +964,102 @@
|
||||
<para role="shortdesc">Lists events for a specified stack
|
||||
resource.</para>
|
||||
</wadl:doc>
|
||||
<response status="200"/>
|
||||
<request>
|
||||
<representation mediaType="application/xml">
|
||||
<param name="resource_action" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Filters the event list by the specified
|
||||
resource_action. You can use this filter multiple
|
||||
times to filter by multiple
|
||||
resource actions:
|
||||
<code>CREATE</code>, <code>DELETE</code>,
|
||||
<code>UPDATE</code>, <code>ROLLBACK</code>,
|
||||
<code>SUSPEND</code>, <code>RESUME</code> or
|
||||
<code>ADOPT</code>.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="resource_status" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Filters the event list by the specified
|
||||
resource_status. You can use this filter multiple
|
||||
times to filter by multiple
|
||||
resource statuses:
|
||||
<code>IN_PROGRESS</code>, <code>COMPLETE</code> or
|
||||
<code>FAILED</code>.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="resource_name" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Filters the event list by the specified
|
||||
resource_name. You can use this filter multiple
|
||||
times to filter by multiple
|
||||
resource names.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="resource_type" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Filters the event list by the specified
|
||||
resource_type. You can use this filter multiple
|
||||
times to filter by multiple
|
||||
resource types:
|
||||
<code>OS::Nova::Server</code>,
|
||||
<code>OS::Cinder::Volume</code>,
|
||||
<code>OS::Neutron::Port</code>, and so on.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="limit" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Limits the number of events that appear
|
||||
on a page to this value. The typical
|
||||
pattern of limit and marker is to make an
|
||||
initial limited request and then to use
|
||||
the ID of the last event from the response
|
||||
as the marker parameter in a subsequent
|
||||
limited request.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="marker" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Specifies the ID of the last-seen event.
|
||||
The typical pattern of limit and marker is
|
||||
to make an initial limited request and
|
||||
then to use the ID of the last event from
|
||||
the response as the marker parameter in a
|
||||
subsequent limited request.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="sort_keys" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Sorts the event list by:
|
||||
<code>resource_type</code> or
|
||||
<code>created_at</code>.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="sort_dir" style="query" required="false">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>The sort direction of the event list.
|
||||
Which is <code>asc</code> (ascending) or
|
||||
<code>desc</code> (descending).</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code href="samples/event_list_resp.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="event_show">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
{
|
||||
"events": [
|
||||
{
|
||||
"resource_name": "port",
|
||||
"event_time": "2014-07-23T08:14:47Z",
|
||||
"links": [{
|
||||
"href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5/resources/port/events/474bfdf0-a450-46ec-a78a-0c7faa404073",
|
||||
"rel": "self"
|
||||
},
|
||||
{
|
||||
"href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5/resources/port",
|
||||
"rel": "resource"
|
||||
},
|
||||
{
|
||||
"href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5",
|
||||
"rel": "stack"
|
||||
}],
|
||||
"logical_resource_id": "port",
|
||||
"resource_status": "CREATE_FAILED",
|
||||
"resource_status_reason": "NotFound: Subnet f8a699d0-3537-429e-87a5-6b5a8d0c2bf0 could not be found",
|
||||
"physical_resource_id": null,
|
||||
"id": "474bfdf0-a450-46ec-a78a-0c7faa404073"
|
||||
},
|
||||
{
|
||||
"resource_name": "port",
|
||||
"event_time": "2014-07-23T08:14:47Z",
|
||||
"links": [{
|
||||
"href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5/resources/port/events/66fa95b6-e6f8-4f05-b1af-e828f5aba04c",
|
||||
"rel": "self"
|
||||
},
|
||||
{
|
||||
"href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5/resources/port",
|
||||
"rel": "resource"
|
||||
},
|
||||
{
|
||||
"href": "http://192.168.123.200:8004/v1/dc4b074874244f7693dd65583733a758/stacks/aws_port/db467ed1-50b5-4a3e-aeb1-396ff1d151c5",
|
||||
"rel": "stack"
|
||||
}],
|
||||
"logical_resource_id": "port",
|
||||
"resource_status": "CREATE_IN_PROGRESS",
|
||||
"resource_status_reason": "state changed",
|
||||
"physical_resource_id": null,
|
||||
"id": "66fa95b6-e6f8-4f05-b1af-e828f5aba04c"
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user