NSLifecycleManagement.yaml 67.4 KB
Newer Older
1
2
openapi: 3.0.2

3
info:
4
5
6
7
8
9
10
11
  title: SOL005 - NS Lifecycle Management Interface
  description: |
    SOL005 - NS 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
12
  license:
13
    name: ETSI Forge copyright notice
14
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
15
16
  version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

17
externalDocs:
18
  description: ETSI GS NFV-SOL 005 V3.3.1
19
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
20
21
22
23
24

servers:
  - url: http://127.0.0.1/nslcm/v1
  - url: https://127.0.0.1/nslcm/v1

25
paths:
26
  '/api_versions':
27
    $ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions
28

29
  /ns_instances:
30
    parameters:
31
32
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
33
    get:
34
      summary: Query multiple NS instances.
35
      description: |
36
        Query NS Instances.
37
38
        The GET method queries information about multiple NS instances. This method shall support the URI query parameters,
        request and response data structures, and response codes, as specified in the Tables 6.4.2.3.2-1 and 6.4.2.3.2-2.
39
      parameters:
40
41
42
43
44
45
46
        - $ref: ../components/SOL005_params.yaml#/components/parameters/filter
        - $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
47
      responses:
48
49
50
        "200":
          $ref: '#/components/responses/NsInstances.Get'
        "400":
51
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
52
        "401":
53
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
54
        "403":
55
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
56
        "404":
57
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
58
        "405":
59
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
60
        "406":
61
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
62
        "409":
63
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
64
        "416":
65
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
66
        "500":
67
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
68
        "503":
69
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
70
        "504":
71
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
72

73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
    post:
      summary: Create a NS instance resource.
      description: |
        The POST method creates a new NS instance resource. As the result of successfully executing this method, a new
        "Individual NS instance" resource as defined in clause 6.4.3 shall have been created, and the value of the
        "instantiationState" attribute in the representation of that resource shall be "NOT_INSTANTIATED". A notification
        of type NsIdentifierCreationNotification shall be triggered as part of successfully executing this method as defined
        in clause 6.5.2.6.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/NsInstanceCreateRequest'
      responses:
        "201":
          $ref: '#/components/responses/NsInstances.Post'
        "400":
90
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
91
        "401":
92
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
93
        "403":
94
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
95
        "404":
96
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
97
        "405":
98
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
99
        "406":
100
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
101
        "409":
102
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
103
        "416":
104
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
105
        "500":
106
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
107
        "503":
108
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
109
        "504":
110
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
111

112
  /ns_instances/{nsInstanceId}:
113
    parameters:
114
115
116
      - $ref: '#/components/parameters/NsInstanceId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
117
    get:
rameshnaraya's avatar
rameshnaraya committed
118
      summary: Read an individual NS instance resource.
119
120
      description: |
        The GET method retrieves information about a NS instance by  reading an individual NS instance resource.
121
      parameters:
122
123
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
124
      responses:
125
126
127
        "200":
          $ref: '#/components/responses/IndividualNsInstance.Get'
        "400":
128
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
129
        "401":
130
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
131
        "403":
132
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
133
        "404":
134
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
135
        "405":
136
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
137
        "406":
138
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
139
        "416":
140
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
141
        "500":
142
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
143
        "503":
144
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
145
        "504":
146
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
147

148
    delete:
rameshnaraya's avatar
rameshnaraya committed
149
      summary: Delete NS instance resource.
150
      description: |
151
        Delete NS Identifier
152
153
154
        This method deletes an individual NS instance resource. As the result of successfully executing this method, the
        "Individual NS instance" resource shall not exist any longer. A notification of type "NsIdentifierDeletionNotification"
        shall be triggered as part of successfully executing this method as defined in clause 6.5.2.7.
155
      responses:
156
157
158
        "204":
          $ref: '#/components/responses/IndividualNsInstance.Delete'
        "400":
159
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
160
        "401":
161
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
162
        "403":
163
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
164
        "404":
165
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
166
        "405":
167
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
168
        "406":
169
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
170
        "409":
171
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
172
        "412":
173
          $ref: ../responses/SOL005_resp.yaml#/components/responses/412
174
        "500":
175
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
176
        "503":
177
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
178
        "504":
179
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
180

181
  /ns_instances/{nsInstanceId}/instantiate:
182
    parameters:
183
184
185
      - $ref: '#/components/parameters/NsInstanceId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
186
    post:
rameshnaraya's avatar
rameshnaraya committed
187
      summary: Instantiate a NS.
188
189
190
191
192
      description: |
        The POST method requests to instantiate a NS instance resource. The steps and conditions that apply as the result
        of successfully executing this method are specified in clause 6.4.1.2. In addition, once the NFVO has successfully
        completed the underlying NS LCM operation occurrence, it shall set the "nsState" attribute to the value "INSTANTIATED"
        in the representation of the "Individual NS instance" resource.
193
      parameters:
194
195
196
197
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/NsInstanceInstantiateRequest'
198
      responses:
199
200
201
        "202":
          $ref: '#/components/responses/InstantiateNsInstance.Post'
        "400":
202
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
203
        "401":
204
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
205
        "403":
206
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
207
        "404":
208
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
209
        "405":
210
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
211
        "406":
212
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
213
        "409":
214
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
215
        "416":
216
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
217
        "500":
218
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
219
        "503":
220
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
221
        "504":
222
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
223

224
  /ns_instances/{nsInstanceId}/scale:
225
    parameters:
226
227
228
      - $ref: '#/components/parameters/NsInstanceId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
229
    post:
rameshnaraya's avatar
rameshnaraya committed
230
      summary: Scale a NS instance.
231
232
233
234
235
      description: |
        The POST method requests to scale a NS instance resource. The steps and conditions that apply as the result of
        successfully executing this method are specified in clause 6.4.1.2. In addition, once the NFVO has successfully
        completed the underlying NS LCM operation occurrence, it shall reflect the result of scaling the NS instance by
        updating the "nsScaleStatus" attribute in the representation of the "Individual NS instance" resource.
236
      parameters:
237
238
239
240
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/NsInstanceScaleRequest'
241
      responses:
242
243
244
        "202":
          $ref: '#/components/responses/ScaleNsInstance.Post'
        "400":
245
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
246
        "401":
247
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
248
        "403":
249
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
250
        "404":
251
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
252
        "405":
253
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
254
        "406":
255
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
256
        "409":
257
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
258
        "416":
259
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
260
        "500":
261
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
262
        "503":
263
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
264
        "504":
265
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
266

267
  /ns_instances/{nsInstanceId}/update:
268
    parameters:
269
270
271
      - $ref: '#/components/parameters/NsInstanceId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
272
    post:
rameshnaraya's avatar
rameshnaraya committed
273
      summary: Updates a NS instance.
274
      description: |
275
        The POST method updates an NS instance.
276
      parameters:
277
278
279
280
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/NsInstanceUpdateRequest'
281
      responses:
282
283
284
        "202":
          $ref: '#/components/responses/UpdateNsInstance.Post'
        "400":
285
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
286
        "401":
287
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
288
        "403":
289
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
290
        "404":
291
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
292
        "405":
293
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
294
        "406":
295
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
296
        "409":
297
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
298
        "416":
299
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
300
        "500":
301
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
302
        "503":
303
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
304
        "504":
305
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
306

307
  /ns_instances/{nsInstanceId}/heal:
308
    parameters:
309
310
311
      - $ref: '#/components/parameters/NsInstanceId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
312
    post:
313
      summary: Heal a NS instance.
314
315
316
317
318
      description: |
        The POST method requests to heal an NS instance. This method shall follow the provisions specified in the Tables
        6.4.7.3.1-1 and 6.4.7.3.1-2 for URI query parameters, request and response data structures, and response codes.
        The steps and conditions that apply as the result of successfully executing this method are specified in clause
        6.4.1.2.
319
      parameters:
320
321
322
323
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/NsInstanceHealRequest'
324
      responses:
325
326
327
        "202":
          $ref: '#/components/responses/HealNsInstance.Post'
        "400":
328
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
329
        "401":
330
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
331
        "403":
332
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
333
        "404":
334
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
335
        "405":
336
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
337
        "406":
338
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
339
        "409":
340
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
341
        "416":
342
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
343
        "500":
344
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
345
        "503":
346
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
347
        "504":
348
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
349

350
  /ns_instances/{nsInstanceId}/terminate:
351
    parameters:
352
353
354
      - $ref: '#/components/parameters/NsInstanceId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
355
    post:
356
      summary: Terminate a NS instance.
357
358
359
360
361
362
363
364
365
      description: |
        Terminate NS task.   The POST method terminates an NS instance. This method shall follow the provisions specified
        in the Tables 6.4.8.3.1-1 and 6.4.8.3.1-2 for URI query parameters, request and response data structures, and
        response codes. The steps and conditions that apply as the result of successfully executing this method are
        specified in clause 6.4.1.2. In addition, once the NFVO has successfully completed the underlying NS LCM operation
        occurrence, it shall set the "nsState" attribute in the representation of the "Individual NS instance" resource
        to the value "NOT_INSTANTIATED". This method can only be used with an NS instance in the INSTANTIATED state.
        Terminating an NS instance does not delete the NS instance identifier, but rather transitions the NS into the
        NOT_INSTANTIATED state.
366
      parameters:
367
368
369
370
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/NsInstanceTerminateRequest'
371
      responses:
372
373
374
        "202":
          $ref: '#/components/responses/TerminateNsInstance.Post'
        "400":
375
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
376
        "401":
377
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
378
        "403":
379
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
380
        "404":
381
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
382
        "405":
383
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
384
        "406":
385
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
386
        "409":
387
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
388
        "416":
389
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
390
        "500":
391
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
392
        "503":
393
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
394
        "504":
395
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
396

397
398
399
400
  /ns_lcm_op_occs:
    parameters:
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
401
    get:
rameshnaraya's avatar
rameshnaraya committed
402
      summary: Query multiple NS LCM operation occurrences.
403
404
405
406
407
      description: |
        Get Operation Status. Shall be returned upon the following error: The operation cannot be executed currently,
        due to a conflict with the state of the resource. Typically, this is due to the fact that the NS instance resource
        is in NOT_INSTANTIATED state, or that another lifecycle management operation is ongoing. The response body shall
        contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error.
408
      parameters:
409
410
411
412
413
414
        - $ref: ../components/SOL005_params.yaml#/components/parameters/filter
        - $ref: ../components/SOL005_params.yaml#/components/parameters/fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
415
      responses:
416
417
418
        "200":
          $ref: '#/components/responses/NsLcmOpOccs.Get'
        "400":
419
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
420
        "401":
421
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
422
        "403":
423
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
424
        "404":
425
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
426
        "405":
427
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
428
        "406":
429
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
430
        "500":
431
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
432
        "503":
433
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
434
        "504":
435
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
436

437
  /ns_lcm_op_occs/{nsLcmOpOccId}:
438
    parameters:
439
440
441
      - $ref: '#/components/parameters/NsLcmOpOccId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
442
    get:
rameshnaraya's avatar
rameshnaraya committed
443
      summary: Read an individual NS LCM operation occurrence resource.
444
445
446
447
448
      description: |
        The API consumer can use this method to read status information about a NS lifecycle management operation
        occurrence by reading an individual "NS LCM operation occurrence" resource. This method shall follow the provisions
        specified in the Tables 6.4.10.3.2-1 and 6.4.10.3.2-2 for URI query parameters, request and response data structures,
        and response codes.
449
      parameters:
450
451
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
452
      responses:
453
454
455
        "200":
          $ref: '#/components/responses/IndividualNsLcmOpOcc.Get'
        "400":
456
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
457
        "401":
458
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
459
        "403":
460
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
461
        "404":
462
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
463
        "405":
464
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
465
        "406":
466
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
467
        "416":
468
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
469
        "500":
470
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
471
        "503":
472
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
473
        "504":
474
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
475

476
  /ns_lcm_op_occs/{nsLcmOpOccId}/retry:
477
    parameters:
478
479
480
      - $ref: '#/components/parameters/NsLcmOpOccId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
481
    post:
rameshnaraya's avatar
rameshnaraya committed
482
      summary: Retry a NS lifecycle management operation occurrence.
483
484
485
486
487
      description: |
        The POST method initiates retrying a NS lifecycle management operation  if that operation has experienced a
        temporary failure, i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state. This method shall
        follow the provisions specified in the  Tables 6.4.11.3.1-1 and 6.4.11.3.1-2 for URI query parameters, request
        and response data structures, and response codes.
488
      responses:
489
490
491
        "202":
          $ref: '#/components/responses/NsLcmOpOccRetry.Post'
        "400":
492
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
493
        "401":
494
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
495
        "403":
496
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
497
        "404":
498
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
499
        "405":
500
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
501
        "406":
502
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
503
        "409":
504
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
505
        "416":
506
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
507
        "500":
508
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
509
        "503":
510
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
511
        "504":
512
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
513

514
  /ns_lcm_op_occs/{nsLcmOpOccId}/rollback:
515
    parameters:
516
517
518
      - $ref: '#/components/parameters/NsLcmOpOccId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
519
    post:
rameshnaraya's avatar
rameshnaraya committed
520
      summary: Rollback a NS lifecycle management operation occurrence.
521
522
523
524
525
      description: |
        The POST method initiates rolling back a NS lifecycle operation  if that operation has experienced a temporary
        failure, i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state. This method shall follow the
        provisions specified in the  Tables 6.4.12.3.1-1 and 6.4.12.3.1-2 for URI query parameters, request and response
        data structures, and response codes.
526
      responses:
527
528
529
        "202":
          $ref: '#/components/responses/NsLcmOpOccRollback.Post'
        "400":
530
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
531
        "401":
532
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
533
        "403":
534
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
535
        "404":
536
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
537
        "405":
538
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
539
        "406":
540
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
541
        "409":
542
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
543
        "416":
544
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
545
        "500":
546
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
547
        "503":
548
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
549
        "504":
550
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
551

552
  /ns_lcm_op_occs/{nsLcmOpOccId}/continue:
553
    parameters:
554
555
556
      - $ref: '#/components/parameters/NsLcmOpOccId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
557
    post:
rameshnaraya's avatar
rameshnaraya committed
558
      summary: Continue a NS lifecycle management operation occurrence.
559
560
561
562
563
      description: |
        The POST method initiates continuing an NS lifecycle operation if that operation has experienced a temporary
        failure, i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state. This method shall follow the
        provisions specified in the Tables 6.4.13.3.1-1 and 6.4.13.3.1-2 for URI query parameters, request and response
        data structures, and response codes.
564
      responses:
565
566
567
        "202":
          $ref: '#/components/responses/NsLcmOpOccContinue.Post'
        "400":
568
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
569
        "401":
570
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
571
        "403":
572
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
573
        "404":
574
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
575
        "405":
576
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
577
        "406":
578
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
579
        "409":
580
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
581
        "416":
582
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
583
        "500":
584
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
585
        "503":
586
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
587
        "504":
588
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
589

590
  /nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/fail:
591
    parameters:
592
593
594
      - $ref: '#/components/parameters/NsLcmOpOccId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
595
    post:
rameshnaraya's avatar
rameshnaraya committed
596
      summary: Mark a NS lifecycle management operation occurrence as failed.
597
598
      description: |
        The POST method marks a NS lifecycle management operation  occurrence as "finally failed" if that operation
599
600
        occurrence is in "FAILED_TEMP" state.
      parameters:
601
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
602
      responses:
603
604
605
        "200":
          $ref: '#/components/responses/NsLcmOpOccFail.Post'
        "400":
606
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
607
        "401":
608
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
609
        "403":
610
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
611
        "404":
612
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
613
        "405":
614
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
615
        "406":
616
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
617
        "409":
618
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
619
        "416":
620
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
621
        "500":
622
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
623
        "503":
624
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
625
        "504":
626
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
627

628
  /nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel:
629
    parameters:
630
631
632
      - $ref: '#/components/parameters/NsLcmOpOccId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
633
    post:
rameshnaraya's avatar
rameshnaraya committed
634
      summary: Cancel a NS lifecycle management operation occurrence.
635
      description: |
636
        The POST method initiates cancelling an ongoing NS lifecycle management operation while it is being executed or
637
638
639
640
641
642
643
644
645
646
647
648
649
        rolled back, i.e. the related NS LCM operation occurrence\" is either in "PROCESSING" or "ROLLING_BACK" state.
        This method shall follow the provisions specified in the Tables 6.4.15.3.1-1 and 6.4.15.3.1-2 for URI query
        parameters, request and response data structures, and response codes. Before returning the "202 Accepted" response,
        the NFVO shall update the "isCancelPending" and "cancelMode" attributes in the representation of the parent resource
        according to the provisions in clause 6.5.2.3. In case of success of processing the asynchronous request:
        1) If the request has been processed in "PROCESSING" or "ROLLING_BACK" state, the "operationState" attribute in
           the representation of the parent resource shall be changed to "FAILED_TEMP". In both cases, the NFVO shall update
           the "isCancelPending" and "cancelMode" attributes in the representation of the parent resource according to the
           provisions in clause 6.5.2.3 to reflect the new status, and the applicable "result" notification according to
           clause 6.6.2.2 shall be emitted to indicate that the execution of the underlying NS LCM operation occurrence
           has temporarily failed. Due to race conditions, the processing of the actual operation that is to be cancelled
           may eventually still succeed, in which case the "operationState" attribute in the representation of the parent
           resource shall represent the result of that operation, rather than the result of the cancellation.
650
      parameters:
651
652
653
654
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/NsLcmOpOccCancelRequest'
rameshnaraya's avatar