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

info:
4
  version: "1.4.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.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.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
        This method shall follow the provisions specified in the tables 5.4.2.3.1-1 and 5.4.2.3.1-2
        for URI query parameters, request and response data structures, and response codes.
        As the result of successfully executing this method, a new "Individual VNF instance"
        resource as defined in clause 5.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 VnfIdentifierCreationNotification shall be triggered as part of successfully
        executing this method as defined in clause 5.5.2.18.
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
      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
83
          required: false
84
85
86
87
88
89
90
91
          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
92
93
94
95
96
97
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
98
99
      responses:
        201:
100
          description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
101
            201 CREATED
102

Giacomo Bernini's avatar
Giacomo Bernini committed
103
104
105
106
107
108
            Shall be returned when a new "Individual VNF instance" resource and
            the associated VNF instance identifier washas been created successfully.
            The response body shall contain a representation of the created VNF instance,
            as defined in clause 5.5.2.2.
            The HTTP response shall include a "Location" HTTP header that contains the resource
            URI of the created VNF instance.
109
110
111
112
113
114
115
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Location:
116
              description: The resource URI of the created VNF instance.
117
118
              type: string
              format: url
119
120
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
121
122
123
124
125
126
127
128
            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
129
130
131
132
133
134
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
135
          schema:
136
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
137
138
139
140
141
142
143
144
145
        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:
146
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
147
148
149
150
151
152
153
154
        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"
155
156
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
157

158
159
    get:
      description: >
160
        Query VNF.
161
162
163
164
165
166
167
168
169
170
171
172
173
174
        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
175
          required: false
176
          type: string
177
178
        - name: filter
          description: >
179
180
181
182
183
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
            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.
184
185
186
187
188
          in: query
          required: false
          type: string
        - name: all_fields
          description: >
189
190
            Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
            The VNFM shall support this parameter.
191
192
193
194
195
          in: query
          required: false
          type: string
        - name: fields
          description: >
196
197
            Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
            The VNFM should support this parameter.
198
199
200
201
202
          in: query
          required: false
          type: string
        - name: exclude_fields
          description: >
203
204
            Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
            The VNFM should support this parameter.
205
206
207
208
209
210
          in: query
          required: false
          type: string
        - name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response.
211
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter.
212
213
            The following attributes shall be excluded from the VnfInstance structure
            in the response body if this parameter is provided, or none of the parameters
214
            "all_fields", "fields", "exclude_fields", "exclude_default" are provided:
215
            -	vnfConfigurableProperties
216
            -   vimConnectionInfo
217
218
219
220
221
222
223
224
225
            -	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 
226
227
            VNFM if the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of
            ETSI GS NFV-SOL 013 for this resource.
228
229
230
          in: query
          required: false
          type: string
231
232
233
234
235
236
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
237
238
      responses:
        200:
239
          description: >
240
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
241

242
243
244
245
246
247
248
249
250
251
            Shall be returned when information about zero or more VNF instances has been queried 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 "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields"
            (if supported) or "exclude_default" URI parameters was supplied in the request, the data in the response
            body shall have been transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of
            ETSI GS NFV-SOL 013, respectively.
            If the VNFM supports alternative 2 (paging) according to clause 5.4.7.2.1 of ETSI GS NFV-SOL 013
            for this resource, inclusion of the Link HTTP header in this response shall follow the provisions
            in clause 4.7.2.3.5.4.2.3 of ETSI GS NFV-SOL 013.
252
253
254
255
256
257
          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
258
259
260
261
262
263
264
265
            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
266
267
268
269
270
271
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
272
273
274
275
276
277
            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
278
279
280
          schema:
            type: array
            items:
281
              $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
282
        400:
283
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
284
285
286
287
288
289
290
        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:
291
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
292
293
294
295
296
297
298
299
        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"
300
301
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
302

303
304
305
  ###############################################################################
  # Individual VNF instance                                                     #
  ###############################################################################
306
307
308
309
310
311
312
313
314
315
316
317
318
  '/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
319

320
321
    get:
      description: >
322
        Query VNF.
Gergely Csatari's avatar
Gergely Csatari committed
323

324
325
326
        The GET method retrieves information about a VNF instance by reading an "Individual VNF instance" resource.
        This method shall follow the provisions specified in the tables 5.4.3.3.2-1 and 5.4.3.3.2-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
      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
349
350
351
352
353
354
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
355
356
      responses:
        200:
357
          description: >
358
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
359

360
361
            Shall be returned when information about an individual VNF instance has been read successfully.
            The response body shall contain a representation of the VNF instance, as defined in clause 5.5.2.2.
362
363
364
365
366
367
          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
368
369
370
371
372
373
374
375
            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
376
377
378
379
380
381
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
382
          schema:
383
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
384
385
386
387
388
389
390
391
392
        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:
393
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
394
395
396
397
398
399
400
401
        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"
402
403
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
404

405
406
407
    patch:
      #SOL003 location: 5.4.3.3.4
      description: >
408
        Modify VNF Information.
409
410
411
412
413
414
415
416
417
        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.
        This method shall follow the provisions specified in the tables 5.4.3.3.4-1 and 5.4.3.3.4-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 5.4.1.2.
418
      parameters:
419
        - name: VnfInfoModificationRequest
420
          description: >
421
422
            Parameters for the VNF modification, as defined in clause 5.5.2.12.
            The Content-Type header shall be set to "application/merge-patch+json" according to IETF RFC 7396.
423
424
425
          required: true
          in: body
          schema:
426
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest"
Gergely Csatari's avatar
Gergely Csatari committed
427
428
429
430
431
432
433
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
434
435
436
437
438
439
440
        - 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
441
442
          enum:
            - application/merge-patch+json
443
444
445
446
447
448
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
449
450
      responses:
        202:
451
452
453
          description: >
            202 ACCEPTED

454
455
456
457
458
            Shall be returned when the request has been accepted for processing.
            On success, the HTTP response shall include a "Location" HTTP header that
            contains the URI of the newly-created "Individual VNF LCM operation occurrence"
            resource corresponding to the operation.
            The response body shall be empty.
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
          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:
480
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
481
        400:
482
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
483
484
485
486
487
488
489
        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:
490
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
491
492
493
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
494
495
          #description: >
            #409 CONFLICT
496

497
498
499
            #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.
500
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
501
502
503
504
505
506
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
507

508
509
510
    delete:
      #SOL003 location: 5.4.3.3.5
      description: >
511
        Delete VNF Identifier.
512
513
514
515
516
517
518
        This method deletes an "Individual VNF instance" resource.
        This method shall follow the provisions specified in the tables 5.4.3.3.5-1 and 5.4.3.3.5-2
        for URI query parameters, request and response data structures, and response codes.
        As the result of successfully executing this method, the "Individual VNF instance" resource
        shall not exist any longer.
        A notification of type "VnfIdentifierDeletionNotification" shall be triggered as part of successfully
        executing this method as defined in clause 5.5.2.19.
Gergely Csatari's avatar
Gergely Csatari committed
519
520
521
522
523
524
525
526
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
527
528
529
530
531
532
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
533
534
      responses:
        204:
535
          description: >
536
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
537

538
539
            Shall be returned when the "Individual VNF instance" resource and the associated
            VNF identifier were deleted successfully.
540
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
541
542
543
544
545
546
547
548
549
          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
550
551
552
553
554
555
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
556
        400:
557
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
558
559
560
561
562
563
564
        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:
565
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
566
567
568
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
569
570
          #description: >
            #409 CONFLICT
571

572
573
574
            #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.
575
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
576
577
578
579
580
581
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
582

583
584
585
  ###############################################################################
  # Instantiate VNF task                                                        #
  ###############################################################################
586
587
588
589
590
591
592
593
594
595
596
597
598
  '/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
599
    post:
600
601
      #SOL003 location: 5.4.4.3.1
      description: >
602
        Instantiate VNF.
603
        The POST method instantiates a VNF instance.
604
605
606
607
608
609
610
        This method shall follow the provisions specified in the tables 5.4.4.3.1-1 and 5.4.4.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 5.4.1.2.
        In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
        it shall set the "instantiationState" attribute to the value "INSTANTIATED" and the "vnfState"
        attribute to the value "STARTED" in the representation of the "Individual VNF instance" resource.
611
612
613
614
615
616
      parameters:
        - name: InstantiateVnfRequest
          description: Parameters for the VNF instantiation.
          in: body
          required: true
          schema:
617
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest"
Gergely Csatari's avatar
Gergely Csatari committed
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
        - 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
639
640
641
642
643
644
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
645
      responses:
646
        202:
647
          description: >
648
            202 ACCEPTED
Gergely Csatari's avatar
Gergely Csatari committed
649

650
            Shall be returned when the request has been accepted for processing
651
652
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that
653
            contains the URI of the newly-created "Individual VNF LCM operation
654
            occurrence" resource corresponding to the operation.
655
          headers:
656
657
            Location:
              description: The resource URI of the created VNF instance
658
              type: string
659
              format: url
660
661
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
662
663
664
665
666
667
668
669
            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
670
671
672
673
674
675
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
676
677
678
679
680
681
682
683
684
        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:
685
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
686
687
688
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
689
690
691
692
693
694
695
696
          #description: >
            #409 CONFLICT

            #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.
697
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
698
699
700
701
702
703
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
704
705
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
706

707
708
709
  ###############################################################################
  # Scale VNF task                                                              #
  ###############################################################################
710
711
712
713
714
715
716
  '/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
717
          in the response to a POST request creating a new "Individual VNF instance"
718
719
720
721
722
          resource. It can also be retrieved from the "id" attribute in the
          payload body of that response.
        in: path
        type: string
        required: true
723
    post:
724
725
      #SOL003 location: 5.4.5.3.1
      description: >
726
        Scale VNF.
727
728
729
730
731
732
733
734
        The POST method requests to scale a VNF instance resource incrementally.
        This method shall follow the provisions specified in the tables 5.4.5.3.1-1 and 5.4.5.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 5.4.1.2.
        In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
        it shall reflect the result of scaling the VNF instance by updating the "scaleStatus" attribute
        in the representation of the "Individual VNF instance" resource.
735
736
737
738
739
740
741
      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
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
        - 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
763
764
765
766
767
768
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
769
770
      responses:
        202:
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
          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
800
801
802
803
804
805
806
        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:
807
808
809
810
811
812
813
814
815
816
          #description: >
            #404 NOT FOUND

            #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 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.
817
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
818
        405:
819
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
820
821
822
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
823
824
825
826
827
828
829
830
831
          #description: >
            #409 CONFLICT

            #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.
832
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
833
834
835
836
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
837
838
839
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

840
841
842
  ###############################################################################
  # Scale VNF to Level task                                                     #
  ###############################################################################
843
844
845
846
847
848
849
850
  '/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
851
          new "Individual VNF instance" resource. It can also be retrieved from the "id"
852
853
854
855
          attribute in the payload body of that response.
        in: path
        type: string
        required: true
856
    post:
857
858
      #SOL003 location: 5.4.6.3.1
      description: >
859
        Scale VNF to Level.
860
861
862
863
864
865
866
867
        The POST method requests to scale a VNF instance resource to a target level.
        This method shall follow the provisions specified in the tables 5.4.6.3.1-1 and 5.4.6.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 5.4.1.2.
        In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
        it shall reflect the result of scaling the VNF instance by updating the "scaleStatus" attribute
        in the representation of the "Individual VNF instance" resource.
868
869
870
871
872
873
874
      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
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
        - 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
896
897
898
899
900
901
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
902
903
      responses:
        202:
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
          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
933
934
935
936
937
938
939
        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:
940
941
942
943
944
945
946
947
948
949
          #description: >
            #404 NOT FOUND

            #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 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.
950
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
951
        405:
952
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
953
954
955
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
956
957
958
959
960
961
962
963
964
          #description: >
            #409 CONFLICT

            #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.
965
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
966
967
968
969
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
970
971
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
972

973
974
975
  ###############################################################################
  # Change VNF Flavour task                                                     #
  ###############################################################################
976
977
978
979
980
981
982
983
  '/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
984
          response to a POST request creating a new "Individual VNF instance" resource. It
985
986
987
988
989
          can also be retrieved from the "id" attribute in the payload body of
          that response.
        in: path
        type: string
        required: true
990
    post:
991
      description: >
992
        Change VNF Flavour.
993
994
995
996
997
998
999
1000
        This method shall follow the provisions specified in the tables 5.4.7.3.1-1 and 5.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 5.4.1.2.
        In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
        it shall set the "flavourId" attribute in the representation of the "Individual VNF instance"
        resource to the value of the "newFlavourId" attribute passed in the "ChangeVnfFlavourRequest"
        data in the POST request.
For faster browsing, not all history is shown. View entire blame