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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
|
.. -*- rst -*-
==============
Hosts (hosts)
==============
**Hosts**
A host belongs to segment. Host can be any kind of virtual machine which can
have compute service running on it.
Lists, creates, shows details for, updates, and deletes hosts.
List Hosts
==========
.. rest_method:: GET /segments/{segment_id}/hosts
Lists IDs, names, type, reserved, on_maintenance for all hosts.
You can filter on the type, on_maintenance and reserved when you
complete a list hosts request.
**Preconditions**
The segment must exist.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request
-------
.. rest_parameters:: parameters.yaml
- segment_id: segment_id_path
- limit: limit
- marker: marker
- on_maintenance: on_maintenance_query_host
- reserved: reserved_query_host
- sort_dir: sort_dir
- sort_key: sort_key_host
- type: type_query_host
Response
--------
.. rest_parameters:: parameters.yaml
- hosts: hosts
- name: host_name
- uuid: host_uuid
- failover_segment_id: segment_uuid
- deleted: deleted
- on_maintenance: on_maintenance
- reserved: reserved
- created_at: created
- control_attributes: control_attributes
- updated_at: updated
- failover_segment: segment
- type: host_type
- id: host_id
**Example List hosts**
.. literalinclude:: ../../doc/api_samples/hosts/hosts-list-resp.json
:language: javascript
Create Host
===========
.. rest_method:: POST /segments/{segment_id}/hosts
Creates a host under given segment.
Creates a Host under given segment with name, type, control_attributes.
User can set sepcific hosts as reserved by setting reserved attribute to True.
By default `on_maintenance` mode which indicates whether host is under
maintenance or not is False when host is created. Host name should be equal
to nova-compute host name from nova service list and host name from the
corosync cluster.
**Preconditions**
The segment must exist.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 201
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 409
..
A conflict(409) is returned if host with same name is already present under
given segment.
BadRequest (400) is returned if host doesn't exists in nova.
Request
-------
.. rest_parameters:: parameters.yaml
- segment_id: segment_id_path
- host: host
- type: host_type
- name: host_name
- control_attributes: control_attributes
- reserved: reserved
- on_maintenance: on_maintenance
**Example Create Host**
.. literalinclude:: ../../doc/api_samples/hosts/host-create-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- host: host
- name: host_name
- uuid: host_uuid
- failover_segment_id: segment_uuid
- deleted: deleted
- on_maintenance: on_maintenance
- reserved: reserved
- created_at: created
- control_attributes: control_attributes
- updated_at: updated
- failover_segment: segment
- type: host_type
- id: host_id
**Example Create Host**
.. literalinclude:: ../../doc/api_samples/hosts/host-create-resp.json
:language: javascript
Show Host Details
=================
.. rest_method:: GET /segments/{segment_id}/hosts/{host_id}
Shows details for a host.
**Preconditions**
The segment must exist.
The host must exist.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 403
- 404
Request
-------
.. rest_parameters:: parameters.yaml
- segment_id: segment_id_path
- host_id: host_id_path
Response
--------
.. rest_parameters:: parameters.yaml
- host: host
- name: host_name
- uuid: host_uuid
- failover_segment_id: segment_uuid
- deleted: deleted
- on_maintenance: on_maintenance
- reserved: reserved
- created_at: created
- control_attributes: control_attributes
- updated_at: updated
- failover_segment: segment
- type: host_type
- id: host_id
**Example Show Host Details**
.. literalinclude:: ../../doc/api_samples/hosts/host-get-resp.json
:language: javascript
Update Host
===========
.. rest_method:: PUT /segments/{segment_id}/hosts/{host_id}
Updates the editable attributes of an existing host.
**Preconditions**
- The segment must exist.
- The host must exist.
- User can not update host if that host or any host from
the failover segment has any usage in the notification
table i.e. any host from the failover segment has
notification status as new/error/running.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 409
..
A conflict(409) is returned if user tries to update host name which is
already assigned to host under given segment or user tries to update the
host or any other host from the failover segment has any usage in the
notification table i.e. any host from the failover segment has
notification status as new/error/running.
BadRequest (400) is returned if host doesn't exists in nova.
Request
-------
.. rest_parameters:: parameters.yaml
- segment_id: segment_id_path
- host_id: host_id_path
- type: host_type
- name: segment_name
- on_maintenance: on_maintenance
- reserved: reserved
**Example Update host reserved flag**
.. literalinclude:: ../../doc/api_samples/hosts/host-update-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- host: host
- name: host_name
- uuid: host_uuid
- failover_segment_id: segment_uuid
- deleted: deleted
- on_maintenance: on_maintenance
- reserved: reserved
- created_at: created
- control_attributes: control_attributes
- updated_at: updated
- failover_segment: segment
- type: host_type
- id: host_id
**Example Update host reserved flag**
.. literalinclude:: ../../doc/api_samples/hosts/host-update-resp.json
:language: javascript
Delete Host
===========
.. rest_method:: DELETE /segments/{segment_id}/hosts/{host_id}
Deletes a host from given segment.
**Preconditions**
- The segment must exist.
- The host must exist.
- User can not delete host if that host or any host from
the failover segment has any usage in the notification
table i.e. any host from the failover segment has
notification status as new/error/running.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 409
..
A conflict(409) is returned if user tries to delete the
host or any other host from the failover segment has any usage in the
notification table i.e. any host from the failover segment has
notification status as new/error/running.
Request
-------
.. rest_parameters:: parameters.yaml
- segment_id: segment_id_path
- host_id: host_id_path
Response
--------
There is no body content for the response of a successful DELETE query.
|
