summaryrefslogtreecommitdiff
path: root/api-ref/source/v1/events.inc
blob: a0f72ece21219b022a255f7cac9d933c37355a73 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
.. -*- rst -*-

======
Events
======

The orchestration service provides APIs to check the events occurred on a
stack or a specific resource in a stack.

List stack events
=================

.. rest_method::  GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/events

Lists events for a stack.

Response Codes
--------------

.. rest_status_code:: success status.yaml

   - 200

.. rest_status_code:: error status.yaml

   - 400
   - 401
   - 404

Request Parameters
------------------

.. rest_parameters:: parameters.yaml

   - tenant_id: tenant_id
   - stack_name: stack_name_url
   - stack_id: stack_id_url
   - resource_action: resource_action_query
   - resource_status: resource_status_query
   - resource_name: resource_name_query
   - resource_type: resource_type_query
   - limit: limit
   - marker: marker
   - sort_keys: sort_keys
   - sort_dir: sort_dir
   - nested_depth: nested_depth

Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - X-Openstack-Request-Id: request_id
   - event_time: event_time
   - id: event_id
   - links: event_links
   - logical_resource_id: logical_resource_id
   - physical_resource_id: physical_resource_id
   - resource_name: resource_name
   - resource_status: resource_status
   - resource_status_reason: resource_status_reason

Response Example
----------------

.. literalinclude:: samples/events-list-response.json
   :language: javascript


Find stack events
=================

.. rest_method::  GET /v1/{tenant_id}/stacks/{stack_name}/events

Finds the canonical URL for the event list of a stack.

Response Codes
--------------

.. rest_status_code:: success status.yaml

   - 302

.. rest_status_code:: error status.yaml

   - 400
   - 401
   - 404
   - 500

Request Parameters
------------------

.. rest_parameters:: parameters.yaml

   - tenant_id: tenant_id
   - stack_name: stack_name_url

Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - X-Openstack-Request-Id: request_id
   - location: location
   - code: code
   - message: message
   - title: title

Response Example
----------------

.. literalinclude:: samples/events-find-response.json
   :language: javascript


List resource events
====================

.. rest_method::  GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/events

Lists events for a stack resource.

Response Codes
--------------

.. rest_status_code:: success status.yaml

   - 200

.. rest_status_code:: error status.yaml

   - 400
   - 401
   - 404

Request Parameters
------------------

.. rest_parameters:: parameters.yaml

   - tenant_id: tenant_id
   - stack_name: stack_name_url
   - stack_id: stack_id_url
   - resource_name: resource_name_url
   - resource_action: resource_action_query
   - resource_status: resource_status_query
   - resource_name: resource_name_query
   - resource_type: resource_type_query
   - limit: limit
   - marker: marker
   - sort_keys: sort_keys
   - sort_dir: sort_dir
   - nested_depth: nested_depth

Response Example
----------------

.. literalinclude:: samples/events-list-response.json
   :language: javascript


Show event details
==================

.. rest_method::  GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/events/{event_id}

Shows details for an event.

.. rest_status_code:: success status.yaml

   - 200 

.. rest_status_code:: error status.yaml

   - 400
   - 401
   - 404
   - 500

Request Parameters
------------------

.. rest_parameters:: parameters.yaml

   - tenant_id: tenant_id
   - stack_name: stack_name_url
   - stack_id: stack_id_url
   - resource_name: resource_name_url
   - event_id: event_id_url

Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - X-Openstack-Request-Id: request_id
   - event: event
   - event_time: event_time
   - id: event_id
   - links: event_links
   - logical_resource_id: logical_resource_id
   - physical_resource_id: physical_resource_id
   - resource_name: resource_name
   - resource_properties: resource_properties
   - resource_status: resource_status
   - resource_status_reason: resource_status_reason
   - resource_type: resource_type

Response Example
----------------

.. literalinclude:: samples/event-show-response.json
   :language: javascript