ac4cc65cb5
Contains .inc files which have all the contents of the .rst files but are grouped together for easier editing. Contains parameters.yaml, which has all parameters in one file. Contains request and response samples (JSON and XML) that are pointed to from the .inc files. Change-Id: I42d5451300f95774a3ec4df66bc95cb36795844d
79 lines
972 B
ReStructuredText
79 lines
972 B
ReStructuredText
.. -*- rst -*-
|
|
|
|
======
|
|
Events
|
|
======
|
|
|
|
Lists all events and shows information for an event.
|
|
|
|
|
|
List events
|
|
===========
|
|
|
|
.. rest_method:: GET /v1/events
|
|
|
|
Lists events.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- limit: limit
|
|
- marker: marker
|
|
- sort: sort
|
|
- global_project: global_project
|
|
- obj_id: obj_id
|
|
- obj_type: obj_type
|
|
- obj_name: obj_name
|
|
- cluster_id: cluster_id
|
|
- action: action
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/events-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Show event details
|
|
==================
|
|
|
|
.. rest_method:: GET /v1/events/{event_id}
|
|
|
|
Shows details for an event.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- event_id: event_id
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/event-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|