Newer
Older
title: SOL002 - VNF Lifecycle Management interface
description: |
SOL002 - VNF Lifecycle Management interface IMPORTANT: Please note that this file might be not aligned to the
current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG.
In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to
https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
contact:
name: NFV-SOL WG
license:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 1.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
Michele Carignani
committed
externalDocs:
description: ETSI GS NFV-SOL 002 V3.3.1
Giacomo Bernini
committed
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf
security:
- OauthSecurity:
- all
servers:
- url: http://127.0.0.1/vnflcm/v1
- url: https://127.0.0.1/vnflcm/v1
paths:
/api_versions:
$ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
/vnf_instances:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
Michele Carignani
committed
get:
Michele Carignani
committed
The GET method queries information about multiple VNF instances.
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
Michele Carignani
committed
responses:
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
"200":
$ref: '#/components/responses/VnfInstances.Get'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
post:
description: |
The POST method creates a new VNF instance resource.
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/VnfInstanceCreationRequest'
responses:
"201":
$ref: '#/components/responses/VnfInstances.Post'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_instances/{vnfInstanceId}:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
Michele Carignani
committed
get:
Samir Medjiah
committed
Information about a VNF instance by reading an "Individual VNF instance".
Michele Carignani
committed
responses:
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
"200":
$ref: '#/components/responses/IndividualVnfInstance.Get'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
Michele Carignani
committed
delete:
Samir Medjiah
committed
This method deletes an "Individual VNF instance" resource.
Michele Carignani
committed
responses:
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
"204":
$ref: '#/components/responses/IndividualVnfInstance.Delete'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"409":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/409
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
patch:
description: |
This method modifies an "Individual VNF instance" resource. Changes to the VNF configurable properties are
applied to the configuration in the VNF instance, and are reflected in the representation of this resource.
Other changes are applied to the VNF instance information managed by the VNFM, and are reflected in the
representation of this resource
requestBody:
$ref: '#/components/requestBodies/VnfInstanceModificationRequest'
responses:
"202":
$ref: '#/components/responses/IndividualVnfInstance.Patch'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"409":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/409
"412":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/412
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_instances/{vnfInstanceId}/instantiate:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
Michele Carignani
committed
The POST method instantiates a VNF instance.
requestBody:
$ref: '#/components/requestBodies/VnfInstanceInstantiationRequest'
Michele Carignani
committed
responses:
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
"202":
$ref: '#/components/responses/InstantiateVnfInstance.Post'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"409":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/409
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_instances/{vnfInstanceId}/scale:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
description: |
The POST method requests to scale a VNF instance resource incrementally.
requestBody:
$ref: '#/components/requestBodies/VnfInstanceScaleRequest'
Michele Carignani
committed
responses:
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
"202":
$ref: '#/components/responses/ScaleVnfInstance.Post'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"409":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/409
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_instances/{vnfInstanceId}/scale_to_level:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
description: |
The POST method requests to scale a VNF instance resource to a target level.
requestBody:
$ref: '#/components/requestBodies/VnfInstanceScaleToLevelRequest'
Michele Carignani
committed
responses:
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
"202":
$ref: '#/components/responses/ScaleVnfInstanceToLevel.Post'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"409":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/409
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_instances/{vnfInstanceId}/change_flavour:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
Michele Carignani
committed
The POST method changes the deployment flavour of a VNF instance.
requestBody:
$ref: '#/components/requestBodies/VnfInstanceChangeFlavourRequest'
Michele Carignani
committed
responses:
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
"202":
$ref: '#/components/responses/VnfInstanceChangeFlavour.Post'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"409":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/409
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_instances/{vnfInstanceId}/terminate:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
Michele Carignani
committed
The POST method terminates a VNF instance.
requestBody:
$ref: '#/components/requestBodies/VnfInstanceTerminationRequest'
Michele Carignani
committed
responses:
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
"202":
$ref: '#/components/responses/TerminateVnfInstance.Post'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"409":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/409
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_instances/{vnfInstanceId}/heal:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
The POST method requests to heal a VNF instance.
requestBody:
$ref: '#/components/requestBodies/VnfInstanceHealRequest'
Michele Carignani
committed
responses:
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
"202":
$ref: '#/components/responses/HealVnfInstance.Post'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"409":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/409
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_instances/{vnfInstanceId}/operate:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
The POST method changes the operational state of a VNF instance.
requestBody:
$ref: '#/components/requestBodies/VnfInstanceOperateRequest'
Michele Carignani
committed
responses:
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
"202":
$ref: '#/components/responses/OperateVnfInstance.Post'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"409":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/409
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_instances/{vnfInstanceId}/change_ext_conn:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
Michele Carignani
committed
The POST method changes the external connectivity of a VNF instance.
requestBody:
$ref: '#/components/requestBodies/VnfInstanceChangeExtConnRequest'
Michele Carignani
committed
responses:
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
"202":
$ref: '#/components/responses/VnfInstanceChangeExtConn.Post'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"409":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/409
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_lcm_op_occs:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
description: |
The client can use this method to query status information about multiple VNF lifecycle management operation occurrences.
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
Michele Carignani
committed
responses:
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
"200":
$ref: '#/components/responses/VnfLcmOpOccs.Get'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_lcm_op_occs/{vnfLcmOpOccId}:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
description: |
The client can use this method to retrieve status information about a VNF lifecycle management operation occurrence
by reading an "Individual VNF LCM operation occurrence" resource.
Michele Carignani
committed
responses:
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
"200":
$ref: '#/components/responses/IndividualVnfLcmOpOcc.Get'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_lcm_op_occs/{vnfLcmOpOccId}/retry:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
description: |
The POST method initiates retrying a VNF lifecycle operation if that operation has experienced a temporary
failure, i.e. the related "Individual VNF LCM operation occurrence" resource is in "FAILED_TEMP" state.
Michele Carignani
committed
responses:
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
"202":
$ref: '#/components/responses/VnfLcmOpOccRetry.Post'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"409":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/409
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_lcm_op_occs/{vnfLcmOpOccId}/rollback:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
description: |
The POST method initiates rolling back a VNF lifecycle operation if that operation has experienced a temporary
failure, i.e. the related "Individual VNF LCM operation occurrence" resource is in "FAILED_TEMP" state.
Michele Carignani
committed
responses:
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
"202":
$ref: '#/components/responses/VnfLcmOpOccRollback.Post'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"409":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/409
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_lcm_op_occs/{vnfLcmOpOccId}/fail:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
description: |
The POST method marks a VNF lifecycle management operation occurrence as "finally failed" if that operation
occurrence is in "FAILED_TEMP" state.
Michele Carignani
committed
responses:
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
"200":
$ref: '#/components/responses/VnfLcmOpOccFail.Post'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"409":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/409
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/vnf_lcm_op_occs/{vnfLcmOpOccId}/cancel:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
description: |
The POST method initiates cancelling an ongoing VNF lifecycle operation while it is being executed or rolled
back, i.e. the related "Individual VNF LCM operation occurrence" is either in "PROCESSING" or "ROLLING_BACK" state.
Michele Carignani
committed
responses:
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
"202":
$ref: '#/components/responses/VnfLcmOpOccCancel.Post'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"409":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/409
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/subscriptions:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
description: |
The GET method queries the list of active subscriptions of the functional block that invokes the method. It can
be used e.g. for resynchronization after error situations.
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
responses:
"200":
$ref: '#/components/responses/Subscriptions.Get'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
post:
description: |
The POST method creates a new subscription.
requestBody:
$ref: '#/components/requestBodies/VnfLcmSubscriptionRequest'
Michele Carignani
committed
responses:
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
"201":
$ref: '#/components/responses/Subscriptions.Post'
"303":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/303
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
/subscriptions/{subscriptionId}:
Michele Carignani
committed
parameters:
- $ref: '#/components/parameters/SubscriptionId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
Michele Carignani
committed
get:
description: |
The GET method retrieves information about a subscription by reading an "Individual subscription" resource.
Michele Carignani
committed
responses:
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
"200":
$ref: '#/components/responses/IndividualSubscription.Get'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
Michele Carignani
committed
delete:
Michele Carignani
committed
The DELETE method terminates an individual subscription.
responses:
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"204":
$ref: '#/components/responses/IndividualSubscription.Delete'
"400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
"401":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
"403":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
"404":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
"405":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
"406":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
"500":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
"503":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
"504":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
components:
parameters:
VnfInstanceId:
name: vnfInstanceId
in: path
description: |
Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location"
HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved
from the "id" attribute in the payload body of that response.
required: true
style: simple
explode: false
schema:
type: string
VnfLcmOpOccId:
name: vnfLcmOpOccId
in: path
description: |
Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource
referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation.
It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification.
required: true
style: simple
explode: false
schema:
type: string
SubscriptionId:
name: subscriptionId
in: path
description: |
Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location"
HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from
the "id" attribute in the payload body of that response.
required: true
style: simple
explode: false
schema:
type: string
requestBodies:
VnfInstanceCreationRequest:
description: |
The VNF creation parameters, as defined in clause 5.5.2.3.
content:
application/json:
schema:
$ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfRequest
required: true
VnfInstanceModificationRequest:
description: Input parameters for VNF info modification
content:
application/json:
schema:
$ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest
required: true
VnfInstanceInstantiationRequest:
description: Parameters for the VNF instantiation.
content:
application/json:
schema:
$ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest
required: true
VnfInstanceScaleRequest:
description: Parameters for the scale VNF operation.
content:
application/json:
schema:
$ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfRequest
required: true
VnfInstanceScaleToLevelRequest:
description: Parameters for the scale VNF to Level operation.
content:
application/json:
schema:
$ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfToLevelRequest
required: true
VnfInstanceChangeFlavourRequest: