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

info:
4
  version: "1.5.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.8.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.08.01_60/gs_NFV-SOL003v020801p.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
56
        The POST method creates a new VNF instance resource based on a VNF package 
        that is onboarded and in "ENABLED" state.
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
          description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
94
            201 CREATED
95

Giacomo Bernini's avatar
Giacomo Bernini committed
96
97
98
99
100
101
            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.
102
103
104
105
106
107
108
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Location:
109
              description: The resource URI of the created VNF instance.
110
111
              type: string
              format: url
112
113
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
114
115
116
117
118
119
120
121
            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
122
123
124
125
126
127
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
128
          schema:
129
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
130
131
132
133
134
135
136
137
138
        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:
139
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
140
141
142
143
144
145
146
147
        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"
148
149
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
150

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

235
236
237
238
239
240
241
242
243
244
            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.
245
246
247
248
249
250
          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
251
252
253
254
255
256
257
258
            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
259
260
261
262
263
264
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
265
266
267
268
269
270
            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
271
272
273
          schema:
            type: array
            items:
274
              $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
275
        400:
276
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
277
278
279
280
281
282
283
        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:
284
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
285
286
287
288
289
290
291
292
        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"
293
294
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
295

296
297
298
  ###############################################################################
  # Individual VNF instance                                                     #
  ###############################################################################
299
300
301
302
303
304
305
306
307
308
309
310
311
  '/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
312

313
314
    get:
      description: >
315
        Query VNF.
Gergely Csatari's avatar
Gergely Csatari committed
316

317
318
319
        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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
      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
342
343
344
345
346
347
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
348
349
      responses:
        200:
350
          description: >
351
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
352

353
354
            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.
355
356
357
358
359
360
          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
361
362
363
364
365
366
367
368
            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
369
370
371
372
373
374
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
375
          schema:
376
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
377
378
379
380
381
382
383
384
385
        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:
386
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
387
388
389
390
391
392
393
394
        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"
395
396
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
397

398
399
400
    patch:
      #SOL003 location: 5.4.3.3.4
      description: >
401
        Modify VNF Information.
402
403
404
405
406
407
408
409
410
        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.
411
      parameters:
412
        - name: VnfInfoModificationRequest
413
          description: >
414
415
            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.
416
417
418
          required: true
          in: body
          schema:
419
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest"
Gergely Csatari's avatar
Gergely Csatari committed
420
421
422
423
424
425
426
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
427
428
429
430
431
432
433
        - 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
434
435
          enum:
            - application/merge-patch+json
436
437
438
439
440
441
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
442
443
      responses:
        202:
444
445
446
          description: >
            202 ACCEPTED

447
448
449
450
451
            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.
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
          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:
473
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
474
        400:
475
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
476
477
478
479
480
481
482
        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:
483
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
484
485
486
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
487
488
          #description: >
            #409 CONFLICT
489

490
491
492
            #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.
493
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
494
495
496
497
498
499
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
500

501
502
503
    delete:
      #SOL003 location: 5.4.3.3.5
      description: >
504
        Delete VNF Identifier.
505
506
507
508
509
510
511
        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
512
513
514
515
516
517
518
519
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
520
521
522
523
524
525
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
526
527
      responses:
        204:
528
          description: >
529
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
530

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

565
566
567
            #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.
568
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
569
570
571
572
573
574
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
575

576
577
578
  ###############################################################################
  # Instantiate VNF task                                                        #
  ###############################################################################
579
580
581
582
583
584
585
586
587
588
589
590
591
  '/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
592
    post:
593
594
      #SOL003 location: 5.4.4.3.1
      description: >
595
        Instantiate VNF.
596
        The POST method instantiates a VNF instance.
597
598
599
600
601
602
603
        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.
604
605
606
607
608
609
      parameters:
        - name: InstantiateVnfRequest
          description: Parameters for the VNF instantiation.
          in: body
          required: true
          schema:
610
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest"
Gergely Csatari's avatar
Gergely Csatari committed
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
        - 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
632
633
634
635
636
637
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
638
      responses:
639
        202:
640
          description: >
641
            202 ACCEPTED
Gergely Csatari's avatar
Gergely Csatari committed
642

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

700
701
702
  ###############################################################################
  # Scale VNF task                                                              #
  ###############################################################################
703
704
705
706
707
708
709
  '/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
710
          in the response to a POST request creating a new "Individual VNF instance"
711
712
713
714
715
          resource. It can also be retrieved from the "id" attribute in the
          payload body of that response.
        in: path
        type: string
        required: true
716
    post:
717
718
      #SOL003 location: 5.4.5.3.1
      description: >
719
        Scale VNF.
720
721
722
723
724
725
726
727
        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.
728
729
730
731
732
733
734
      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
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
        - 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
756
757
758
759
760
761
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
762
763
      responses:
        202:
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
          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
793
794
795
796
797
798
799
        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:
800
801
802
803
804
805
806
807
808
809
          #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.
810
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
811
        405:
812
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
813
814
815
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
816
817
818
819
820
821
822
823
824
          #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.
825
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
826
827
828
829
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
830
831
832
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

833
834
835
  ###############################################################################
  # Scale VNF to Level task                                                     #
  ###############################################################################
836
837
838
839
840
841
842
843
  '/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
844
          new "Individual VNF instance" resource. It can also be retrieved from the "id"
845
846
847
848
          attribute in the payload body of that response.
        in: path
        type: string
        required: true
849
    post:
850
851
      #SOL003 location: 5.4.6.3.1
      description: >
852
        Scale VNF to Level.
853
854
855
856
857
858
859
860
        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.
861
862
863
864
865
866
867
      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
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
        - 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
889
890
891
892
893
894
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
895
896
      responses:
        202:
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
          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
926
927
928
929
930
931
932
        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:
933
934
935
936
937
938
939
940
941
942
          #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.
943
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
944
        405:
945
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
946
947
948
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
949
950
951
952
953
954
955
956
957
          #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.
958
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
959
960
961
962
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
963
964
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
965

966
967
968
  ###############################################################################
  # Change VNF Flavour task                                                     #
  ###############################################################################
969
970
971
972
973
974
975
976
  '/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
977
          response to a POST request creating a new "Individual VNF instance" resource. It
978
979
980
981
982
          can also be retrieved from the "id" attribute in the payload body of
          that response.
        in: path
        type: string
        required: true
983
    post:
984
      description: >
985
        Change VNF Flavour.
986
987
988
989
990
991
992
993
        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.
994
995
996
997
998
999
      parameters:
        - name: ChangeVnfFlavourRequest
          description: Parameters for the Change VNF Flavour operation.
          in: body
          required: true
          schema:
1000
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ChangeVnfFlavourRequest"
Gergely Csatari's avatar
Gergely Csatari committed
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
        - 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
1022
1023
1024
1025
1026
1027
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1028
1029
      responses:
        202:
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
          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
1059
1060
1061
1062
1063
1064
1065
        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:
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
          #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.
1076
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1077
        405:
1078
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1079
1080
1081
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
1082
1083
1084
1085
1086
1087
1088
1089
1090
          #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.
1091
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
1092
1093
1094
1095
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1096
1097
1098
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

1099
1100
1101
  ###############################################################################
  # Terminate VNF task                                                         #
  ###############################################################################
1102
1103
1104
1105
1106
1107
1108
  '/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
1109
          header in the response to a POST request creating a new "Individual VNF instance"
1110
1111
1112
1113
1114
          resource. It can also be retrieved from the "id" attribute in the
          payload body of that response.
        in: path
        type: string
        required: true
1115
    post:
1116
      description: >
1117
        Terminate VNF.
1118
1119
        The POST method triggers the VNFM to terminate a VNF instance and to request to the VIM
        the release of its used virtualised resources.
1120
1121
1122
1123
1124
1125
1126
        This method shall follow the provisions specified in the tables 5.4.8.3.1-1 and 5.4.8.3.1-2
        for URI query parameters, request and response data structures, and response codes.
        The steps and conditions that apply as the result of successfully executing this method
        are specified in clause 5.4.1.2.
        In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
        it shall set the "instantiationState" attribute in the representation of the "Individual VNF instance"
        resource to the value "NOT_INSTANTIATED".
1127
1128
1129
1130
1131
1132
      parameters:
        - name: TerminateVnfRequest
          description: Parameters for the VNF termination.
          in: body
          required: true
          schema:
1133
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/TerminateVnfRequest"
Gergely Csatari's avatar
Gergely Csatari committed
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
        - 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
1155
1156
1157
1158
1159
1160
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1161
1162
      responses:
        202:
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
          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
1192
1193
1194
1195
1196
1197
1198
1199
1200
        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:
1201
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1202
1203
1204
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
1205
1206
1207
1208
1209
1210
1211
1212
1213
          #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.
1214
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
1215
1216
1217
1218
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1219
1220
1221
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

1222
1223
1224
  ###############################################################################
  # Heal VNF task                                                               #
  ###############################################################################
1225
1226
1227
1228
1229
1230
1231
  '/vnf_instances/{vnfInstanceId}/heal':
    #SOL003 location: 5.4.9.2
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be healed. This identifier can be
          retrieved from the resource referenced by the "Location" HTTP
1232
          header in the response to a POST request creating a new "Individual VNF instance"
1233
1234
1235
1236
1237
          resource. It can also be retrieved from the "id" attribute in the
          payload body of that response.
        in: path
        type: string
        required: true
1238
    post:
1239
      description: >
1240
        Heal VNF.
1241
1242
1243
1244
1245
        The POST method requests to heal a VNF instance.
        This method shall follow the provisions specified in the tables 5.4.9.3.1-1 and 5.4.9.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.
1246
1247
1248
1249
1250
1251
      parameters:
        - name: HealVnfRequest
          description: Parameters for the Heal VNF operation.
          in: body
          required: true
          schema:
1252
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/HealVnfRequest"
Gergely Csatari's avatar
Gergely Csatari committed
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
        - 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
1274
1275
1276
1277
1278
1279
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1280
1281
      responses:
        202:
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
          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
1311
1312
1313
1314
1315
1316
1317
        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:
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
          #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.
1328
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1329
        405:
1330
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1331
1332
1333
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
1334
1335
1336
1337
1338
1339
1340
1341
1342
          #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.
1343
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
1344
1345
1346
1347
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1348
1349
1350
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

1351
1352
1353
  ###############################################################################
  # Operate VNF task                                                            #
  ###############################################################################
1354
1355
1356
1357
1358
1359
1360
  '/vnf_instances/{vnfInstanceId}/operate':
    #SOL003 location: 5.4.9.2
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be operated. This identifier can
          be retrieved from the resource referenced by the "Location" HTTP
1361
          header in the response to a POST request creating a new "Individual VNF instance"
1362
1363
1364
1365
1366
          resource. It can also be retrieved from the "id" attribute in the
          payload body of that response.
        in: path
        type: string
        required: true
1367
    post:
1368
      description: >
1369
        Operate VNF.
1370
        The POST method changes the operational state of a VNF instance resource.
1371
1372
1373
1374
1375
1376
1377
        This method shall follow the provisions specified in the tables 5.4.10.3.1-1 and 5.4.10.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 "vnfState" attribute in the representation of the "Individual VNF instance" resource
        to the value of the "changeStateTo" attribute passed in the "OperateVnfRequest" data in the POST request.
1378
1379
1380
1381
1382
1383
      parameters:
        - name: OperateVnfRequest
          description: Parameters for the Operate VNF operation.
          in: body
          required: true
          schema:
1384
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/OperateVnfRequest"
Gergely Csatari's avatar
Gergely Csatari committed
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
        - 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
1406
1407
1408
1409
1410
1411
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1412
1413
      responses:
        202:
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432