VNFFaultManagement.yaml 24 KB
Newer Older
1
swagger: "2.0"
Gergely Csatari's avatar
Gergely Csatari committed
2
 
3
info:
4
  version: "1.1.1"
5
  title: SOL003 - VNF Fault Management interface
6
  description: >
7
8
    SOL003 - VNF Fault Management interface

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
26
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

27
28
29
30
externalDocs:
  description: ETSI GS NFV-SOL 003 V2.4.1
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.04.01_60/gs_NFV-SOL003v020401p.pdf

31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
basePath: "/vnffm/v1"

schemes:
  - https

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

paths:
###############################################################################
# Alarms                                                                      #
###############################################################################
  '/alarms':
  #SOL003 location: 7.4.2
    get:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
49
50
51
        Get Alarm List


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
        The client can use this method to retrieve information about the alarm
        list.
      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
67
          required: false
68
          type: string
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the 
            URI query string. The NFVO may supply this parameter. 
            The following attribute names shall be supported by the VNFM in
            the attribute-based filtering expression: id, managedObjectId, 
            rootCauseFaultyResource/faultyResourceType, eventType, 
            perceivedSeverity, probableCause.
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the 
            VNFM if the VNFM supports alternative 2 (paging) according to clause 4.7.2.1 
            for this resource.
          in: query
          required: false
          type: string
89
90
91
92
93
94
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
95
96
97
      responses:
        200:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
98
99
            OK

100
101
102
103
104
105
            Information about zero or more alarms was queried successfully.
            The response body shall contain in an array the representations
            of zero or more alarms as defined in clause 7.5.2.4.
            If the VNFM supports alternative 2 (paging) according to clause 
            4.7.2.1 for this resource, inclusion of the Link HTTP header in 
            this response shall follow the provisions in clause 4.7.2.3.
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request.
                Reference: IETF RFC 7231
              type: string
              maximum: 1
              minimum: 1
          schema:
            $ref: "../definitions/SOL003_def.yaml#/definitions/Alarm"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400-attr-based-filtering-error"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Individual alarm                                                            #
###############################################################################
  '/alarms/{alarmId}':
  #SOL003 location: 7.4.3
    parameters:
      - name: alarmId
        description: >
          Identifier of the alarm.
          This identifier can be retrieved from the "id" attribute of the
          "alarm" attribute in the AlarmNotification or
          AlarmClearedNotification. It can also be retrieved from the "id"
          attribute of the applicable array element in the payload body of the
          response to a GET request to the "Alarms" resource.
        in: path
        type: string
        required: true
    get:
      description: >
        The client can use this method to read an individual alarm.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          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
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
170
          required: false
171
          type: string
172
173
174
175
176
177
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
178
179
180
      responses:
        200:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
181
182
            OK

183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
            Information about an individual alarm was read successfully.
            The response body shall contain a representation of the individual
            alarm.
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request.
                Reference: IETF RFC 7231
              type: string
              maximum: 1
              minimum: 1
          schema:
            $ref: "../definitions/SOL003_def.yaml#/definitions/Alarm"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    patch:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
212
213
214
        Acknowledge Alarm


215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
        This method modifies an individual alarm resource.
      parameters:
        - name: AlarmModifications
          description: The VNF creation parameters
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
Gergely Csatari's avatar
Gergely Csatari committed
230
231
232
233
234
235
236
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
237
238
        - name: Content-Type
          description: >
239
240
241
            The Content-Type header shall be set to
            "application/merge-patch+json" according to
            IETF RFC 7396.
242
243
244
          in: header
          required: true
          type: string
245
          enum: ["application/merge-patch+json"]
246
247
248
249
250
251
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
252
253
254
      responses:
        200:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
255
256
            OK

257
258
259
260
261
262
263
264
265
266
267
            The request was accepted and completed. The response body shall
            contain attribute modifications for an ‘Individual alarm’
            resource.
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request.
                Reference: IETF RFC 7231
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
268
269
270
271
272
273
274
275
            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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFFaultManagement_resp.yaml#/responses/409-alarm-state-conflict"
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Subscriptions                                                               #
###############################################################################
299
  '/subscriptions':
300
301
302
  #SOL003 location: 7.4.4
    post:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
303
304
305
        Subscribe


306
        The POST method creates a new subscription.
307
308
309
310
311
312
313
314
315
316
        Creation of two subscription resources with the same callbackURI and
        the same filter can result in performance degradation and will
        provide duplicates of notifications to the NFVO, and might make sense
        only in very rare use cases. Consequently, the VNFM may either allow
        creating a subscription resource if another subscription resource with
        the same filter and callbackUri already exists (in which case it shall
        return the “201 Created” response code), or may decide to not create a
        duplicate subscription resource (in which case it shall return a
        “303 See Other” response code referencing the existing subscription
        resource with the same filter and callbackUri).
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
      parameters:
        - name: FmSubscriptionRequest
          description: The VNF creation parameters
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscriptionRequest"
        - 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
336
337
338
339
340
341
342
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
343
344
          required: true
          type: string
345
346
347
348
349
350
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
351
352
353
      responses:
        201:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
354
355
            Created

356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
            The subscription was created successfully. The response body shall
            contain a representation of the created subscription resource.
            The HTTP response shall include a "Location:" HTTP header that
            points to the created subscription resource.
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request.
                Reference: IETF RFC 7231
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: >
                The resource URI of the created subscription resource.
              type: string
              format: url
Gergely Csatari's avatar
Gergely Csatari committed
373
374
375
376
377
378
379
380
            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
381
382
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
383
384
        303:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    get:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
401
402
403
        Query Subscription Information


404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
        The client can use this method to retrieve the list of active
        subscriptions for VNF alarms subscribed by the client. It can be used
        e.g. for resynchronization after error situations.
      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
420
421
422
423
424
425
426
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
427
428
          required: true
          type: string
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the 
            URI query string. The NFVO may supply this parameter. 
            All attribute names that appear in the FmSubscription and in 
            data types referenced from it shall be supported by the VNFM 
            in the filter expression.
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be 
            supported by the VNFM if the VNFM supports alternative 2 (paging) 
            according to clause 4.7.2.1 for this resource.
          in: query
          required: false
          type: string
448
449
450
451
452
453
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
454
455
456
      responses:
        200:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
457
458
            OK

459
            The list of subscriptions was queried successfully. The response
460
461
462
463
464
465
466
            body shall contain in an array the representations of all active
            subscriptions of the functional block that invokes the method,
            i.e. zero or more representations of FM subscriptions as defined
            in clause 7.5.2.3.
            If the VNFM supports alternative 2 (paging) according to clause 
            4.7.2.1 for this resource, inclusion of the Link HTTP header in 
            this response shall follow the provisions in clause 4.7.2.3.
467
468
469
470
471
472
473
474
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request.
                Reference: IETF RFC 7231
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
475
476
477
478
479
480
481
482
            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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400-attr-based-filtering-error"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Individual subscription                                                     #
###############################################################################
  '/subscriptions/{subscriptionId}':
  #SOL003 location: 7.4.5
    parameters:
      - name: subscriptionId
        description: >
          Identifier of this subscription.
          This identifier can be retrieved from the resource referenced by the
          "Location" HTTP header in the response to a POST request creating a
          new subscription resource. It can also be retrieved from the "id"
          attribute in the payload body of that response.
        in: path
        type: string
        required: true
    get:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
519
520
521
        Query Subscription Information


522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
        The client can use this method for reading an individual subscription
        for VNF alarms subscribed by the client.
      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
537
538
539
540
541
542
543
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
544
545
          required: true
          type: string
546
547
548
549
550
551
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
552
553
554
      responses:
        200:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
555
556
            OK

557
558
559
560
561
562
563
564
565
566
567
            The operation has completed successfully.
            The response body shall contain a representation of the
            subscription resource.
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request.
                Reference: IETF RFC 7231
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
568
569
570
571
572
573
574
575
            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
576
577
578
579
580
581
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    delete:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
600
601
602
        Terminate Subscription

        
603
604
605
606
607
608
609
        This method terminates an individual subscription.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
610
          required: false
611
          type: string
612
613
614
615
616
617
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
618
619
620
      responses:
        204:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
621
622
            No Content

623
624
            The subscription resource was deleted successfully.
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
625
626
627
628
629
630
631
632
633
          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
634
635
636
637
638
639
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
640
641
642
643
644
645
646
647
648
649
650
651
652
653
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"