NSLifecycleManagement.yaml 86.8 KB
Newer Older
1
2
3
swagger: "2.0"

info:
4
  version: "1.0.0"
rameshnaraya's avatar
rameshnaraya committed
5
  title: SOL005 - NS Lifecycle Management Interface
6
  description: >
rameshnaraya's avatar
rameshnaraya committed
7
    SOL005 - NS Lifecycle Management Interface
8
9
10
11
12
13
14
15
    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
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
16
  contact:
17
18
19
20
21
22
23
24
25
26
    name: "NFV-SOL WG"
externalDocs:
  description: ETSI GS NFV-SOL 005 V2.4.1
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/nslcm/v1"
schemes:
  - https
consumes:
  - "application/json"
produces:
27
  - "application/json"
28
paths:
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
  # API Versions                                                                #
  ###############################################################################
  '/api-versions':
    get:
      summary: Retrieve API version information
      description: >
        The GET method reads API version information. This method shall follow the provisions specified in
        table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
        supported.
      parameters:
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: false
          type: string
      responses:
        200:
          description: >
            200 OK
            
            API version information was read successfully.
            The response body shall contain API version information, as defined in clause 4.4.1.7.
          schema:
            $ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
        400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' }
        401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }
        403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }
        404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }
        405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
        406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }
        413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
        414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
        416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
        422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
        429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
        500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
        503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
        504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
  ###############################################################################
81
82
  # NSInstances                                                                 #
  ###############################################################################
83
84
85
  '/ns_instances':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.2
    post:
86
      summary: Create a NS instance resource.
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
      description: >
        The POST method creates a new NS instance resource.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
110
          type: string
111
112
113
114
115
116
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
rameshnaraya's avatar
rameshnaraya committed
117
118
119
120
121
122
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
123
              - "CreateNsRequest"
rameshnaraya's avatar
rameshnaraya committed
124
125
126
127
128
            properties:
              CreateNsRequest:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/CreateNsRequest"
            description: >
              The NS creation parameters, as defined in clause 6.5.2.7. 
129
      responses:
130
        201:
131
132
          description: >
            201 Created
133

134
135
136
137
138
139
            A NS Instance identifier was created successfully.
            The response body shall contain a representation of
            the created NS instance, as defined in clause 6.5.2.8.
            The HTTP response shall include a "Location" HTTP
            header that contains the resource URI of the created
            NS instance.
rameshnaraya's avatar
rameshnaraya committed
140
141
142
143
144
          schema:
            type: "object"
            properties:
              NsInstance:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
145
          headers:
rameshnaraya's avatar
rameshnaraya committed
146
147
148
149
150
151
            Content-Type:
              type: "string"
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
152
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
153
              type: "string"
154
155
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
156
157
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
158
159
              maximum: 1
              minimum: 0
160
161
162
163
164
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
165
              minimum: 1
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
185
          $ref: "responses/SOL005_resp.yaml#/responses/503"
186
    get:
187
      summary: Query multiple NS instances.
188
      description: >
189
        Query NS Instances.
190

191
192
193
194
        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.
      parameters:
195
196
        - name: filter
          in: query
197
          required: false
198
          type: string
199
          description: >
200
            Attribute-based filtering expression according to clause 4.3.2.
201
202
            The NFVO shall support receiving this parameter as part of the URI
            query string. The OSS/BSS may supply this parameter.
203
            All attribute names that appear in the NsInstance and in data types
204
205
206
            referenced from it shall be supported by the NFVO in the filter expression.
        - name: all_fields
          in: query
207
          required: false
208
          type: string
209
          description: >
210
211
212
213
            Include all complex attributes in the response. See clause 4.3.3 for details.
            The NFVO shall support this parameter.
        - name: fields
          in: query
214
          required: false
215
          type: string
216
          description: >
217
218
            "Complex attributes to be included into the response. See clause 4.3.3 for
            details. The NFVO should support this parameter."          
219
220
        - name: exclude_fields
          in: query
221
          required: false
222
          type: string
223
          description: >
224
225
            "Complex attributes to be excluded from the response. See clause 4.3.3 for
            details. The NFVO should support this parameter."
226
227
        - name: exclude_default
          in: query
228
          required: false
229
          type: string
230
          description: >
231
232
233
234
235
236
237
238
239
240
241
242
            "Indicates to exclude the following complex attributes from the response.
            See clause 4.3.3 for details. The NFVO shall support this parameter.
            The following attributes shall be excluded from the NsInstance structure in
            the response body if this parameter is provided, or none of the parameters
            "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
            - vnfInstances
            - pnfInfo
            - virtualLinkInfo
            - vnffgInfo
            - sapInfo
            - nsScaleStatus
            - additionalAffinityOrAntiAffinityRules"
243
244
245
246
247
248
249
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
            if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
          required: false
          type: string
250
251
252
253
254
255
256
257
258
259
260
261
262
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
263
          type: string
264
265
266
267
268
269
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
270
271
272
      responses:
        200:
          description: >
273
            200 OK
274

275
276
277
278
279
280
            Information about zero or more NS instances was queried successfully.
            The response body shall contain in an array the representations of
            zero or more NS instances, as defined in clause 6.5.2.8.
            If the NFVO supports alternative 2 (paging) according to 
            clause 4.7.2.1 for this resource, inclusion of the Link HTTP header 
            in this response shall follow the provisions in clause 4.7.2.3.
281
282
283
284
285
286
287
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
288
              type: "string"
289
290
              description: >
                Challenge if the corresponding HTTP request has not provided
291
292
293
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
294
              minimum: 0
295
296
297
298
299
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
300
              minimum: 1
301
302
303
304
305
306
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
307
308
309
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
310
311
              properties:
                NsInstance:
312
                  $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
rameshnaraya's avatar
rameshnaraya committed
332
          $ref: "responses/SOL005_resp.yaml#/responses/503"
333
334
335
336

  ###############################################################################
  # Individual NS instance                                                      #
  ###############################################################################
337
338
339
340
341
342
343
344
345
346
  '/ns_instances/{nsInstanceId}':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.3
    parameters:
      - name: nsInstanceId
        description: >
          Identifier of the NS instance.
        in: path
        type: string
        required: true
    get:
rameshnaraya's avatar
rameshnaraya committed
347
      summary: Read an individual NS instance resource.
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
      description: >
        The GET method retrieves information about a NS instance by 
        reading an individual NS instance resource.   
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
373
374
375
376
377
378
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
379
380
      responses:
        200:
381
382
          description: >
            200 OK
383

384
385
            Information about an individual NS instance was queried successfully.
            The response body shall contain a representation of the NS instance.
rameshnaraya's avatar
rameshnaraya committed
386
387
388
389
390
          schema:
            type: "object"
            properties:
              NsInstance:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
391
392
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
393
394
395
396
              type: "string"
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message body.
397
              maximum: 1
398
              minimum: 1
399
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
400
              type: "string"
401
402
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
403
                authorization, or error details if the corresponding HTTP request
404
                has provided an invalid authorization token.
405
406
              maximum: 1
              minimum: 0
407
408
409
410
411
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
412
              minimum: 1
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
432
433
          $ref: "responses/SOL005_resp.yaml#/responses/503"

434
    delete:
rameshnaraya's avatar
rameshnaraya committed
435
      summary: Delete NS instance resource.
436
437
      description: >
        Delete NS Identifier
438

439
440
441
442
443
444
445
446
447
        This method deletes an individual NS instance resource.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
448
449
450
451
452
453
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
454
455
456
457
      responses:
        204:
          description: >
            204 No Content
458

459
460
461
462
463
            The NS instance resource and the associated NS
            identifier were deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
464
              type: "string"
465
466
              description: >
                Challenge if the corresponding HTTP request has not provided
467
468
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
469
470
              maximum: 1
              minimum: 0
471
472
473
474
475
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
476
              minimum: 1
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-INSTANTIATED"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

498
499
500
  ###############################################################################
  # Instantiate NS task                                                         #
  ###############################################################################
501
502
503
504
505
506
507
508
509
  '/ns_instances/{nsInstanceId}/instantiate':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.4
    parameters:
      - name: nsInstanceId
        description: >
          Identifier of the NS instance to be instantiated.
        in: path
        type: string
        required: true
510
    post:
rameshnaraya's avatar
rameshnaraya committed
511
      summary: Instantiate a NS.
512
513
514
      description: >
        The POST method requests to instantiate a NS instance resource.
      parameters:
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
536
537
538
539
540
541
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
542
543
544
545
546
547
548
549
550
551
552
553
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "InstantiateNsRequest"
            properties:
              InstantiateNsRequest:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/InstantiateNsRequest"
            description: >
              Parameters for the instantiate NS operation, as defined in clause 6.5.2.10.
554
555
      responses:
        202:
rameshnaraya's avatar
rameshnaraya committed
556
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-INSTANTIATED"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
577
578
579
580

  ###############################################################################
  # Scale NS task                                                               #
  ###############################################################################
581
582
583
584
585
586
587
588
589
  '/ns_instances/{nsInstanceId}/scale':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.5
    parameters:
      - name: nsInstanceId
        description: >
          Identifier of the NS instance to be scaled.
        in: path
        type: string
        required: true
590
    post:
rameshnaraya's avatar
rameshnaraya committed
591
      summary: Scale a NS instance.
592
593
      description: >
        The POST method requests to scale a NS instance resource.
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
616
617
618
619
620
621
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
622
623
624
625
626
627
628
629
630
631
632
633
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "ScaleNsRequest"
            properties:
              ScaleNsRequest:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/ScaleNsRequest"
            description: >
              Parameters for the scale NS operation, as defined in clause 6.5.2.13.
634
635
636
637
638
639
640
641
642
643
644
645
646
647
      responses:
        202:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
648
          $ref: "responses/SOL005_resp.yaml#/responses/406"
649
650
651
652
653
654
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
655
656
657
658

  ###############################################################################
  # Update NS task                                                              #
  ###############################################################################
659
660
661
662
663
664
665
666
667
  '/ns_instances/{nsInstanceId}/update':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.6
    parameters:
      - name: nsInstanceId
        description: >
          Identifier of the NS instance to be updated.
        in: path
        type: string
        required: true
668
    post:
rameshnaraya's avatar
rameshnaraya committed
669
      summary: Updates a NS instance.
670
671
672
      description: >
        Scale NS instance.
        The POST method requests to scale a NS instance resource.
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
695
696
697
698
699
700
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
701
702
703
704
705
706
707
708
709
710
711
712
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "UpdateNsRequest"
            properties:
              UpdateNsRequest:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/UpdateNsRequest"
            description: >
              Parameters for the update NS operation, as defined in clause 6.5.2.11.
713
714
      responses:
        202:
715
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
734
735
736
737

  ###############################################################################
  # Heal NS task                                                                #
  ###############################################################################
738
739
  '/ns_instances/{nsInstanceId}/heal':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.7
740
741
742
    parameters:
      - name: nsInstanceId
        description: >
743
          Identifier of the NS instance to be healed.
744
745
746
747
        in: path
        type: string
        required: true
    post:
748
749
      summary: Heal a NS instance.
      description: >
750
751
752
753
        The POST method requests to heal a NS instance resource.
        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.
754
      parameters:
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
776
777
778
779
780
781
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
782
783
784
785
786
787
788
789
790
791
792
793
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "HealNsRequest"
            properties:
              HealNsRequest:
                $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/HealNsRequest"
            description: >
              Parameters for the heal NS operation, as defined in clause 6.5.2.12.
794
795
      responses:
        202:
796
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
814
          $ref: "responses/SOL005_resp.yaml#/responses/503"
815

816
817
818
  ###############################################################################
  # Terminate NS task                                                           #
  ###############################################################################
819
820
  '/ns_instances/{nsInstanceId}/terminate':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.8
821
822
823
    parameters:
      - name: nsInstanceId
        description: >
824
          The identifier of the NS instance to be terminated.
825
826
827
828
        in: path
        type: string
        required: true
    post:
829
830
831
832
833
834
835
836
837
838
      summary: Terminate a NS instance.
      description: >
        Terminate NS task.  
        The POST method terminates a NS instance. This method can only be 
        used with a NS instance in the INSTANTIATED
        state. Terminating a NS instance does not delete the NS instance identifier, 
        but rather transitions the NS into the NOT_INSTANTIATED state.
        This method shall support the URI query parameters, request and 
        response data structures, and response codes, as
        specified in the Tables 6.4.8.3.1-1 and 6.8.8.3.1-2.
839
      parameters:
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
861
862
863
864
865
866
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
867
868
869
870
871
872
873
874
875
876
877
878
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "TerminateNsRequest"
            properties:
              TerminateNsRequest:
                $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest"
            description: >
              The terminate NS request parameters, as defined in  clause 6.5.2.14.
879
880
      responses:
        202:
881
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
899
          $ref: "responses/SOL005_resp.yaml#/responses/503"
900

901
902
903
  ###############################################################################
  # NS LCM operation occurrences                                                #
  ###############################################################################
904
905
906
  '/ns_lcm_op_occs':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.9
    get:
rameshnaraya's avatar
rameshnaraya committed
907
      summary: Query multiple NS LCM operation occurrences.
908
      description: >
909
        Get Operation Status.
910
911
912
913
914
        The client can use this method to query status information about multiple NS lifecycle management operation
        occurrences.
        This method shall follow the provisions specified in the Tables 6.4.9.3.2-1 and 6.4.9.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
915
916
        - name: filter
          in: query
917
          required: false
918
          type: string
919
          description: >
920
921
922
            Attribute-based filtering expression according to clause 4.3.2.
            The NFVO shall support receiving this parameter as part of the URI query string.
            The OSS/BSS may supply this parameter.
923
            All attribute names that appear in the NsLcmOpOcc and in data types referenced
924
            from it shall be supported by the NFVO in the filter expression.
925
926
        - name: fields
          in: query
927
          required: false
928
          type: string
929
          description: >
930
931
            Complex attributes to be included into the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.
932
933
        - name: exclude_fields
          in: query
934
          required: false
935
          type: string
936
          description: >
937
938
            Complex attributes to be excluded from the response. See clause 4.3.3 for details.
            The NFVO should support this parameter.
939
940
        - name: exclude_default
          in: query
941
          required: false
942
          type: string
943
          description: >
944
945
946
947
948
949
950
951
            Indicates to exclude the following complex attributes from the response. See
            clause 4.3.3 for details. The NFVO shall support this parameter.
            The following attributes shall be excluded from the NsLcmOpOcc structure in the
            response body if this parameter is provided:
            - operationParams
            - changedVnfInfo
            - error
            - resourceChanges
952
953
954
955
956
957
958
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
            if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
          required: false
          type: string
959
960
961
962
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
963
964
965
          in: header
          required: true
          type: string
966
967
968
969
970
971
972
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
973
974
975
976
977
978
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
979
980
981
      responses:
        200:
          description: >
982
            200 OK
983

984
985
986
987
988
989
990
            Status information for zero or more NS lifecycle management operation 
            occurrences was queried successfully. 
            The response body shall contain in an array the representations of
            zero or more NS instances, as defined in clause 5.5.2.13.
            If the NFVO supports alternative 2 (paging) according to 
            clause 4.7.2.1 for this resource, inclusion of the Link HTTP header 
            in this response shall follow the provisions in clause 4.7.2.3.
991
992
993
994
995
996
997
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
998
              type: "string"
999
1000
              description: >
                Challenge if the corresponding HTTP request has not provided
For faster browsing, not all history is shown. View entire blame