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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
|
.. -*- rst -*-
=====================================================================
Networking Flavors Framework v2.0 (CURRENT) (flavor, service_profile)
=====================================================================
Extension that allows user selection of operator-curated flavors
during resource creation.
Users can check if flavor available by performing a GET on the
/v2.0/extensions/flavors. If it is unavailable,there is an 404 error
response (itemNotFound).
Refer `Show extension details <#show-extension-details>`__ for more details.
List flavors
============
.. rest_method:: GET /v2.0/flavors
Lists all flavors visible to the project.
The list can be empty.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
Request
-------
.. rest_parameters:: parameters.yaml
- id: id-query
- service_type: flavor-service_type-query
- name: name-query
- description: description-query
- enabled: flavor-enabled-query
- sort_dir: sort_dir
- sort_key: flavor-sort_key
- fields: fields
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- flavors: flavors
- id: flavor-id
- service_type: flavor-service_type
- name: flavor-name
- description: flavor-description
- enabled: flavor-enabled
- service_profiles: flavor-service_profiles
Response Example
----------------
.. literalinclude:: samples/flavors/flavors-list-response.json
:language: javascript
Create flavor
=============
.. rest_method:: POST /v2.0/flavors
Creates a flavor.
This operation establishes a new flavor.
The service_type to which the flavor applies is a required
parameter. The corresponding service plugin must have been
activated as part of the configuration.
Check `Service providers <#list-service-providers>`__ for how to see
currently loaded service types. Additionally the service plugin
needs to support the use of flavors.
Creation currently limited to administrators. Other users will
receive a ``Forbidden 403`` response code with a response body
NeutronError message expressing that creation is disallowed by
policy.
Until one or more service profiles are associated with the flavor
by the operator, attempts to use the flavor during resource
creations will currently return a ``Not Found 404`` with a response
body that indicates no service profile could be found.
If the API cannot fulfill the request due to insufficient data or
data that is not valid, the service returns the HTTP ``Bad Request
(400)`` response code with information about the failure in the
response body. Validation errors require that you correct the error
and submit the request again.
Normal response codes: 201
Error response codes: 400, 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- flavor: flavor
- service_type: flavor-service_type
- enabled: flavor-enabled-request
- description: flavor-description-request
- name: flavor-name-request
Request Example
---------------
.. literalinclude:: samples/flavors/flavor-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- flavor: flavor
- id: flavor-id
- service_type: flavor-service_type
- name: flavor-name
- description: flavor-description
- enabled: flavor-enabled
- service_profiles: flavor-service_profiles
Response Example
----------------
.. literalinclude:: samples/flavors/flavor-create-response.json
:language: javascript
Show flavor details
===================
.. rest_method:: GET /v2.0/flavors/{flavor_id}
Shows details for a flavor.
This operation returns a flavor object by ID. If you are not an
administrative user and the flavor object is not visible to your
project account, the service returns the HTTP ``Forbidden (403)``
response code.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- flavor_id: flavor_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- flavor: flavor
- id: flavor-id
- service_type: flavor-service_type
- name: flavor-name
- description: flavor-description
- enabled: flavor-enabled
- service_profiles: flavor-service_profiles
Response Example
----------------
.. literalinclude:: samples/flavors/flavor-show-response.json
:language: javascript
Update flavor
=============
.. rest_method:: PUT /v2.0/flavors/{flavor_id}
Updates a flavor.
The service_type cannot be updated as there may be associated
service profiles and consumers depending on the value.
Normal response codes: 200
Error response codes: 400, 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- flavor_id: flavor_id
- flavor: flavor
- name: flavor-name-request
- description: flavor-description-request
- enabled: flavor-enabled-request
Request Example
---------------
.. literalinclude:: samples/flavors/flavor-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- flavor: flavor
- id: flavor-id
- service_type: flavor-service_type
- name: flavor-name
- description: flavor-description
- enabled: flavor-enabled
- service_profiles: flavor-service_profiles
Response Example
----------------
.. literalinclude:: samples/flavors/flavor-update-response.json
:language: javascript
Delete flavor
=============
.. rest_method:: DELETE /v2.0/flavors/{flavor_id}
Deletes a flavor.
Normal response codes: 204
Error response codes: 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- flavor_id: flavor_id
Response
--------
No body content is returned on a successful DELETE.
Associate flavor with a service profile
=======================================
.. rest_method:: POST /v2.0/flavors/{flavor_id}/service_profiles
Associate a flavor with a service profile.
A flavor can be associated with more than one profile.
Will return ``409 Conflict`` if association already exists.
Normal response codes: 201
Error response codes: 400, 401, 403, 404, 409
Request
-------
.. rest_parameters:: parameters.yaml
- flavor_id: flavor_id
- service_profile: service_profile
- id: service_profile-id
Request Example
---------------
.. literalinclude:: samples/flavors/flavor-associate-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- service_profile: service_profile
- id: id
Response Example
----------------
.. literalinclude:: samples/flavors/flavor-associate-response.json
:language: javascript
Disassociate a flavor.
======================
.. rest_method:: DELETE /v2.0/flavors/{flavor_id}/service_profiles/{profile_id}
Disassociate a flavor from a service profile.
Normal response codes: 204
Error response codes: 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- profile_id: profile_id
- flavor_id: flavor_id
Response
--------
No body content is returned on a successful disassociation.
List service profiles
=====================
.. rest_method:: GET /v2.0/service_profiles
Lists all service profiles visible for the tenant account.
The list can be empty.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
Request
-------
.. rest_parameters:: parameters.yaml
- id: id-query
- enabled: service_profile-enabled-query
- driver: service_profile-driver-query
- description: description-query
- sort_dir: sort_dir
- sort_key: service_profile-sort_key
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- service_profiles: service_profiles
- id: service_profile-id
- enabled: service_profile-enabled
- driver: service_profile-driver
- description: service_profile-description
- metainfo: service_profile-metainfo
Response Example
----------------
.. literalinclude:: samples/flavors/service-profiles-list-response.json
:language: javascript
Create service profile
======================
.. rest_method:: POST /v2.0/service_profiles
Creates a service profile.
This operation establishes a new service profile that can be
associated with one or more flavors.
Either metadata or a driver is required.
If a driver is specified but does not exist, call will return a
``Not found 404`` error with the response body explaining that the
driver could not be found.
Creation currently limited to administrators. Other users will
receive a ``Forbidden 403`` response code with a response body
NeutronError message expressing that creation is disallowed by
policy.
If the API cannot fulfill the request due to insufficient data or
data that is not valid, the service returns the HTTP ``Bad Request
(400)`` response code with information about the failure in the
response body. Validation errors require that you correct the error
and submit the request again.
Normal response codes: 201
Error response codes: 400, 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- service_profile: service_profile
- description: service_profile-description-request
- metainfo: service_profile-metainfo-request
- enabled: service_profile-enabled-request
- driver: service_profile-driver-request
Request Example
---------------
.. literalinclude:: samples/flavors/service-profile-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- service_profile: service_profile
- id: service_profile-id
- enabled: service_profile-enabled
- driver: service_profile-driver
- description: service_profile-description
- metainfo: service_profile-metainfo
Response Example
----------------
.. literalinclude:: samples/flavors/service-profile-create-response.json
:language: javascript
Show service profile details
============================
.. rest_method:: GET /v2.0/service_profiles/{profile_id}
Shows details for a service profile.
This operation returns a service profile object by ID. If you are
not an administrative user and the object is not visible to your
tenant account, the service returns the HTTP ``Forbidden (403)``
response code.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- profile_id: profile_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- service_profile: service_profile
- id: service_profile-id
- enabled: service_profile-enabled
- driver: service_profile-driver
- description: service_profile-description
- metainfo: service_profile-metainfo
Response Example
----------------
.. literalinclude:: samples/flavors/service-profile-show-response.json
:language: javascript
Update service profile
======================
.. rest_method:: PUT /v2.0/service_profiles/{profile_id}
Updates a service profile.
Normal response codes: 200
Error response codes: 400, 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- profile_id: profile_id
- service_profile: service_profile
- enabled: service_profile-enabled-request
- driver: service_profile-driver-request
- description: service_profile-description-request
- metainfo: service_profile-metainfo-request
Request Example
---------------
.. literalinclude:: samples/flavors/service-profile-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- service_profile: service_profile
- id: service_profile-id
- enabled: service_profile-enabled
- driver: service_profile-driver
- description: service_profile-description
- metainfo: service_profile-metainfo
Response Example
----------------
.. literalinclude:: samples/flavors/service-profile-update-response.json
:language: javascript
Delete service profile
======================
.. rest_method:: DELETE /v2.0/service_profiles/{profile_id}
Deletes a service profile.
Attempting to delete a service profile that is currently associated
with a flavor will return a ``Conflict 409`` with a response body
containing an in use message.
Either metadata or a driver is required.
Normal response codes: 204
Error response codes: 401, 403, 404, 409
Request
-------
.. rest_parameters:: parameters.yaml
- profile_id: profile_id
Response
--------
No body content is returned on a successful DELETE.
|
