VNFLifecycleManagement.yaml 89.1 KB
Newer Older
1
2
3
swagger: "2.0"

info:
4
  version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
5
  title: SOL003 - VNF Lifecycle Management interface
6
  description: >
7
8
    SOL003 - VNF Lifecycle Management interface definition

9

10
    IMPORTANT: Please note that this file might be not aligned to the current
11
12
13
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

14

15
16
17
18
19
20
    In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based
    filtering mechanism is defined. This mechanism is currently not
    included in the corresponding OpenAPI design for this GS version. Changes
    to the attribute-based filtering mechanism are being considered in v2.5.1
    of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
    design.
21

22
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
23
24
25
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
26
27

externalDocs:
28
29
  description: ETSI GS NFV-SOL 003 V2.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf
30
31
32
33
34
35
36
37
38
39
40
41

basePath: "/vnflcm/v1"

schemes:
  - https

consumes:
  - "application/json"
produces:
  - "application/json"

paths:
42
43
44
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
45
  '/api-versions':
46
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
47

48
49
50
  ###############################################################################
  # VNF instances                                                               #
  ###############################################################################
51
52
53
  '/vnf_instances':
    #SOL003 location: 5.4.2
    post:
Gergely Csatari's avatar
Gergely Csatari committed
54
      description: >
55
        Create VNF Identifier.
Gergely Csatari's avatar
Gergely Csatari committed
56
        The POST method creates a new VNF instance resource.
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
      parameters:
        - name: createVnfRequest
          description: The VNF creation parameters
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfRequest"
        - 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
Gergely Csatari's avatar
Gergely Csatari committed
76
          required: false
77
78
79
80
81
82
83
84
          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
85
86
87
88
89
90
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
91
92
      responses:
        201:
93
94
95
96
          description: >
          201 CREATED

          A VNF Instance identifier was created successfully.
97
98
99
100
101
102
103
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Location:
104
              description: The resource URI of the created VNF instance.
105
106
              type: string
              format: url
Gergely Csatari's avatar
Gergely Csatari committed
107
108
109
110
111
112
113
114
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
115
116
117
118
119
120
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
121
          schema:
122
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
123
124
125
126
127
128
129
130
131
        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:
132
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
133
134
135
136
137
138
139
140
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
141
142
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
143
144
    get:
      description: >
145
        Query VNF.
146
147
148
149
150
151
152
153
154
155
156
157
158
159
        The GET method queries information about multiple VNF instances.
      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
Gergely Csatari's avatar
Gergely Csatari committed
160
          required: false
161
          type: string
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
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the 
            URI query string. The NFVO may supply this parameter. 
            All attribute names that appear in the VnfInstance and in data 
            types referenced from it shall be supported by the VNFM in the 
            filter expression.
          in: query
          required: false
          type: string
        - name: all_fields
          description: >
            Include all complex attributes in the response.
            See clause 4.3.3 for details. The VNFM shall support this parameter.
          in: query
          required: false
          type: string
        - name: fields
          description: >
            Complex attributes to be included into the response.
            See clause 4.3.3 for details. The VNFM should support this parameter.
          in: query
          required: false
          type: string
        - name: exclude_fields
          description: >
            Complex attributes to be excluded from the response.
            See clause 4.3.3 for details. The VNFM should support this parameter.
          in: query
          required: false
          type: string
        - name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response.
            See clause 4.3.3 for details. The VNFM shall support this parameter.
            The following attributes shall be excluded from the VnfInstance structure
            in the response body if this parameter is provided, or none of the parameters
            "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
            -	vnfConfigurableProperties
            - vimConnectionInfo
            -	instantiatedVnfInfo
            -	metadata
            -	extensions
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the 
            VNFM if the VNFM supports alternative 2 (paging) according to clause 4.7.2.1 
            for this resource.
          in: query
          required: false
          type: string
217
218
219
220
221
222
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
223
224
      responses:
        200:
225
          description: >
226
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
227

228
            Information about zero or more VNF instances was queried
229
230
231
232
233
234
235
            successfully. The response body shall contain in an array
            the representations of zero or more VNF instances, as defined
            in clause 5.5.2.2.
            If the VNFM 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.
236
237
238
239
240
241
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
242
243
244
245
246
247
248
249
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
250
251
252
253
254
255
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
256
257
258
259
260
261
            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
262
263
264
          schema:
            type: array
            items:
265
              $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
266
        400:
267
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
268
269
270
271
272
273
274
        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:
275
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
276
277
278
279
280
281
282
283
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
284
285
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
286

287
288
289
  ###############################################################################
  # Individual VNF instance                                                     #
  ###############################################################################
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
  '/vnf_instances/{vnfInstanceId}':
    #SOL003 location: 5.4.3.2
    parameters:
      - name: vnfInstanceId
        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.
        in: path
        type: string
        required: true
    get:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
305
306
307
        Query VNF


308
309
        The GET method retrieves information about a VNF instance by reading
        an individual VNF instance resource.
Gergely Csatari's avatar
Gergely Csatari committed
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
      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
332
333
334
335
336
337
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
338
339
      responses:
        200:
340
          description: >
341
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
342

343
344
345
346
347
348
349
350
351
            Information about zero or more VNF instances was queried
            successfully. The response body shall contain
            representations of zero or more VNF instances.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
352
353
354
355
356
357
358
359
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
360
361
362
363
364
365
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
366
          schema:
367
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
368
369
370
371
372
373
374
375
376
        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:
377
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
378
379
380
381
382
383
384
385
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
386
387
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
388
389
390
    patch:
      #SOL003 location: 5.4.3.3.4
      description: >
391
        Modify VNF Information.
392
393
394
395
396
397
398
        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
      parameters:
399
        - name: VnfInfoModificationRequest
400
          description: >
401
            Input parameters for VNF info modification.
402
403
404
          required: true
          in: body
          schema:
405
            $ref: "../definitions/SOL003_def.yaml#/definitions/VnfInfoModificationRequest"
Gergely Csatari's avatar
Gergely Csatari committed
406
407
408
409
410
411
412
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
413
414
415
416
417
418
419
420
        - name: Content-Type
          description: >
            The Content-Type header shall be set to
            "application/merge-patch+json" according to IETF RFC 7396.
          in: header
          required: true
          type: string
          enum: ["application/merge-patch+json"]
421
422
423
424
425
426
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
427
428
      responses:
        202:
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
          description: >
            202 ACCEPTED

            The request was accepted for processing, but the processing has not
            been completed. On success, the HTTP response shall include a
            "Location" HTTP header that contains the URI of the newly-created
            "VNF LCM operation occurrence" resource corresponding to the
            operation.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
459
        400:
460
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
461
462
463
464
465
466
467
        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:
468
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
469
470
471
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
472
473
474
475
476
          description: >
            Shall be returned upon the following error: The operation cannot be executed currently,
            due to a conflict with the state of the "Individual VNF instance" resource.
            Typically, this is due to the fact that another LCM operation is ongoing.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
477
478
479
480
481
482
483
484
485
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    delete:
      #SOL003 location: 5.4.3.3.5
      description: >
486
        Delete VNF Identifier.
487
        This method deletes an individual VNF instance resource.
Gergely Csatari's avatar
Gergely Csatari committed
488
489
490
491
492
493
494
495
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
496
497
498
499
500
501
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
502
503
      responses:
        204:
504
          description: >
505
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
506

507
508
509
            The VNF instance resource and the associated VNF identifier were
            deleted successfully.
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
510
511
512
513
514
515
516
517
518
          headers:
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
519
520
521
522
523
524
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
525
        400:
526
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
527
528
529
530
531
532
533
        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:
534
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
535
536
537
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
538
539
540
541
542
          description: >
            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 "Individual VNF instance" resource is in INSTANTIATED state.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
543
544
545
546
547
548
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
549

550
551
552
  ###############################################################################
  # Instantiate VNF task                                                        #
  ###############################################################################
553
554
555
556
557
558
559
560
561
562
563
564
565
  '/vnf_instances/{vnfInstanceId}/instantiate':
    #SOL003 location: 5.4.4.2
    parameters:
      - name: vnfInstanceId
        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.
        in: path
        type: string
        required: true
566
    post:
567
568
      #SOL003 location: 5.4.4.3.1
      description: >
569
        Instantiate VNF.
570
571
572
573
574
575
576
577
        The POST method instantiates a VNF instance.
      parameters:
        - name: InstantiateVnfRequest
          description: Parameters for the VNF instantiation.
          in: body
          required: true
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest"
Gergely Csatari's avatar
Gergely Csatari committed
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
        - 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
599
600
601
602
603
604
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
605
      responses:
606
        202:
607
          description: >
608
            202 ACCEPTED
Gergely Csatari's avatar
Gergely Csatari committed
609

610
            Shall be returned when the request has been accepted for processing
611
612
613
614
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that
            contains the URI of the newly-created "VNF LCM operation
            occurrence" resource corresponding to the operation.
615
          headers:
616
617
            Location:
              description: The resource URI of the created VNF instance
618
              type: string
619
              format: url
620
621
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
622
623
624
625
626
627
628
629
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
630
631
632
633
634
635
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
636
637
638
639
640
641
642
643
644
        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:
645
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
646
647
648
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
649
650
651
652
653
654
655
          description: >
            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 "Individual VNF instance" resource is in INSTANTIATED state,
            or that a required child attribute of the "extensions" attribute has not been set.
            Those attributes are marked as "required" in the VNFD.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
656
657
658
659
660
661
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
662
663
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
664

665
666
667
  ###############################################################################
  # Scale VNF task                                                              #
  ###############################################################################
668
669
670
671
672
673
674
675
676
677
678
679
680
  '/vnf_instances/{vnfInstanceId}/scale':
    #SOL003 location: 5.4.5.2
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be scaled. 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.
        in: path
        type: string
        required: true
681
    post:
682
683
      #SOL003 location: 5.4.5.3.1
      description: >
684
        Scale VNF.
685
686
687
688
689
690
691
692
693
        The POST method requests to scale a VNF instance resource
        incrementally.
      parameters:
        - name: ScaleVnfRequest
          description: Parameters for the scale VNF operation.
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfRequest"
Gergely Csatari's avatar
Gergely Csatari committed
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
        - 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
715
716
717
718
719
720
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
721
722
      responses:
        202:
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
          description: >
            202 ACCEPTED

            Shall be returned when the request has been accepted for processing.
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that
            contains the URI of the newly-created "VNF LCM operation
            occurrence" resource corresponding to the operation.
          headers:
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
752
753
754
755
756
757
758
        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:
759
760
761
762
763
764
765
766
          description: >
            Shall be returned upon the following error: The API producer did not find a current representation
            for the target resource or is not willing to disclose that one exists.
            The general cause for this error and its handling is specified in clause 4.3.5.4,6.4 of ETSI GS NFV-SOL 013,
            including rules for the presence of the response body.
            Specifically in case of this task resource, the response code 404 shall also returned if
            the task is not supported for the VNF instance represented by the parent resource, which means that the
            task resource consequently does not exist.
767
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
768
        405:
769
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
770
771
772
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
773
774
775
776
777
778
779
780
          description: >
            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 "Individual VNF instance" resource is in
            NOT_INSTANTIATED state, or that another lifecycle management operation is ongoing, or that
            a required child attribute of the "extensions" attribute has not been set.
            Those attributes are marked as "required" in the VNFD.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
781
782
783
784
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
785
786
787
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

788
789
790
  ###############################################################################
  # Scale VNF to Level task                                                     #
  ###############################################################################
791
792
793
794
795
796
797
798
799
800
801
802
803
  '/vnf_instances/{vnfInstanceId}/scale_to_level':
    #SOL003 location: 5.4.6.2
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be scaled to a target level. 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.
        in: path
        type: string
        required: true
804
    post:
805
806
      #SOL003 location: 5.4.6.3.1
      description: >
807
        Scale VNF to Level.
808
809
810
811
812
813
814
815
816
        The POST method requests to scale a VNF instance resource to a target
        level.
      parameters:
        - name: ScaleVnfToLevelRequest
          description: Parameters for the scale VNF to Level operation.
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfToLevelRequest"
Gergely Csatari's avatar
Gergely Csatari committed
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
        - 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
838
839
840
841
842
843
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
844
845
      responses:
        202:
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
          description: >
            202 ACCEPTED

            Shall be returned when the request has been accepted for processing.
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that
            contains the URI of the newly-created "VNF LCM operation
            occurrence" resource corresponding to the operation.
          headers:
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
875
876
877
878
879
880
881
        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:
882
883
884
885
886
887
888
889
          description: >
            Shall be returned upon the following error: The API producer did not find a current representation
            for the target resource or is not willing to disclose that one exists.
            The general cause for this error and its handling is specified in clause 4.3.5.4,6.4 of ETSI GS NFV-SOL 013,
            including rules for the presence of the response body.
            Specifically in case of this task resource, the response code 404 shall also returned if the task
            is not supported for the VNF instance represented by the parent resource, which means that the task resource
            consequently does not exist.
890
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
891
        405:
892
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
893
894
895
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
896
897
898
899
900
901
902
903
          description: >
            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 VNF instance resource is in NOT_INSTANTIATED state,
            that another lifecycle management operation is ongoing, or that a required child attribute of
            the "extensions" attribute has not been set.
            Those attributes are marked as "required" in the VNFD.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
904
905
906
907
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
908
909
910
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
          
911
912
913
  ###############################################################################
  # Change VNF Flavour task                                                     #
  ###############################################################################
914
915
916
917
918
919
920
921
922
923
924
925
926
927
  '/vnf_instances/{vnfInstanceId}/change_flavour':
    #SOL003 location: 5.4.7.2
    parameters:
      - name: vnfInstanceId
        description: >
          The identifier of the VNF instance of which the deployment flavour
          is requested to be changed. 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.
        in: path
        type: string
        required: true
928
    post:
929
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
930
931
932
        Change VNF Flavour


933
934
935
936
937
938
939
940
        The POST method changes the deployment flavour of a VNF instance.
      parameters:
        - name: ChangeVnfFlavourRequest
          description: Parameters for the Change VNF Flavour operation.
          in: body
          required: true
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/ChangeVnfFlavourRequest"
Gergely Csatari's avatar
Gergely Csatari committed
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
        - 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
962
963
964
965
966
967
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
968
969
      responses:
        202:
Gergely Csatari's avatar
Gergely Csatari committed
970
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/202-with-Location"
971
972
973
974
975
976
977
        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:
978
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
979
980
981
982
983
984
985
986
987
988
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
989
990
991
  ###############################################################################
  # Terminate VNF task                                                         #
  ###############################################################################
992
993
994
995
996
997
998
999
1000
  '/vnf_instances/{vnfInstanceId}/terminate':
    #SOL003 location: 5.4.8.2
    parameters:
      - name: vnfInstanceId
        description: >
          The identifier of the VNF instance to be terminated. 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
For faster browsing, not all history is shown. View entire blame