Newer
Older
info:
title: SOL009 - NFV-MANO Fault Management interface
SOL009 - NFV-MANO Fault Management interface
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to. In case of
discrepancies the published ETSI Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.07.01_60/gs_NFV-SOL009v030701p.pdf
servers:
- url: http://127.0.0.1/nfvmanofm/v1
- url: https://127.0.0.1/nfvmanofm/v1
paths:
/api_versions:
$ref: ../endpoints/SOL009_endpoints.yaml#/endpoints/api_versions
The client can use this method to retrieve information about the alarm list. See clause 7.5.3.3.2.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
$ref: '#/components/responses/Alarms.Get.200'
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
- $ref: "#/components/parameters/alarmId"
The client can use this method to read an individual alarm. See clause 7.5.4.3.2.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
This method modifies an "Individual alarm" resource. See clause 7.5.4.3.4.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
- $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
$ref: "#/components/requestBodies/AlarmModifications"
$ref: '#/components/responses/Alarm.Patch.200'
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/409
$ref: ../components/SOL009_resp.yaml#/components/responses/412
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/subscriptions:
post:
description: >
The POST method creates a new subscription. See clause 7.5.5.3.1.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
- $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
$ref: "#/components/requestBodies/FmSubscriptionRequest"
$ref: '#/components/responses/Subscriptions.Post.201'
$ref: ../components/SOL009_resp.yaml#/components/responses/303
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
get:
description: >
The client can use this method to retrieve the list of active subscriptions for NFV-MANO functional entity
alarms subscribed by the client. It can be used e.g. for resynchronization after error situations.
See clause 7.5.5.3.2.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
- $ref: "#/components/parameters/filter.FmSubscriptions"
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
$ref: '#/components/responses/Subscriptions.Get.200'
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
"/subscriptions/{subscriptionId}":
parameters:
- $ref: "#/components/parameters/subscriptionId"
The client can use this method for reading an individual subscription for NFV-MANO functional entity alarms
subscribed by the client. See clause 7.5.6.3.2.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
$ref: '#/components/responses/Subscription.Get.200'
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
This method terminates an individual subscription. See clause 7.5.6.3.5.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
$ref: '#/components/responses/Subscription.Delete.204'
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
filter.Alarms:
name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
The NFV-MANO functional entity shall support receiving this parameter as part of the URI query string.
The API consumer may supply this parameter.
The following attribute names shall be supported by the NFV-MANO functional entity in the attribute-based
filtering expression: id, managedObjectId, eventType, perceivedSeverity, probableCause.
in: query
required: false
schema:
type: string
filter.FmSubscriptions:
name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
The NFV-MANO functional entity shall support receiving this parameter as part of the URI query string.
The API consumer may supply this parameter.
All attribute names that appear in the FmSubscription and in data types referenced from it shall be supported
by the NFV-MANO functional entity in the filter expression.
in: query
required: false
schema:
type: string
alarmId:
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 message content of the
response to a GET request to the "Alarms" resource.
in: path
required: true
schema:
type: string
subscriptionId:
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 "Individual subscription" resource.
It can also be retrieved from the "id" attribute in the message content
of that response.
in: path
required: true
schema:
type: string
requestBodies:
AlarmModifications:
description: >
The parameter for the alarm modification, as defined in clause
7.6.2.8. The Content-Type header shall be set to
"application/merge-patch+json" according to IETF RFC 7396.
content:
application/json:
schema:
$ref: "./components/NFVManoFaultManagement_def.yaml#/components/schemas/AlarmModifications"
required: true
FmSubscriptionRequest:
description: >
Details of the subscription to be created, as defined in clause
7.6.2.2.
content:
application/json:
schema:
$ref: "./components/NFVManoFaultManagement_def.yaml#/components/schemas/FmSubscriptionRequest"
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
description: >
200 OK
Shall be returned when information about zero or more alarms has been queried successfully.
The response body shall contain in an array the representations of zero or more alarms as defined
in clause 7.6.2.4. If the "filter" URI parameter was supplied in the request, the data in the response
body shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.
If the NFV-MANO functional entity supports alternative 2 (paging) according to clause 5.4.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 5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
Content-Type:
description: >
The MIME type of the body of the request. Reference: IETF RFC
7231
schema:
type: string
minimum: 1
maximum: 1
Version:
description: |
Version of the API used in the response.
schema:
type: string
minimum: 1
maximum: 1
Link:
description: >
Reference to other resources. Used for paging in the present
document.
schema:
type: string
minimum: 0
maximum: 1
content:
application/json:
schema:
type: array
items:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Alarm"
description: >
200 OK
Shall be returned when information about an individual alarm has been 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
schema:
type: string
minimum: 1
maximum: 1
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Alarm"
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
description: >
200 OK
Shall be returned when the request has been accepted and completed. ì The response body shall contain
attribute modifications for an "Individual alarm" resource (see clause 7.6.2.4).
headers:
Content-Type:
description: >
The MIME type of the body of the request. Reference: IETF RFC
7231
schema:
type: string
minimum: 1
maximum: 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.
schema:
type: string
minimum: 0
maximum: 1
content:
application/json:
schema:
$ref: "./components/NFVManoFaultManagement_def.yaml#/components/schemas/AlarmModifications"
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
description: >
201 CREATED
Shall be returned when the subscription has been created successfully. The response body shall contain a
representation of the created "Individual subscription" resource. The HTTP response shall include a
"Location:"" HTTP header that points to the created "Individual subscription" resource.
headers:
Content-Type:
description: >
The MIME type of the body of the request. Reference: IETF RFC
7231
schema:
type: string
minimum: 1
maximum: 1
Location:
description: |
The resource URI of the created subscription resource.
schema:
type: string
format: url
minimum: 1
maximum: 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.
schema:
type: string
minimum: 0
maximum: 1
content:
application/json:
schema:
$ref: "./components/NFVManoFaultManagement_def.yaml#/components/schemas/FmSubscription"
description: >
303 SEE OTHER
482
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
callbackURI and the same filter already exists and the
policy of NFV-MANO functional entity is to not create
redundant subscriptions.
The HTTP response shall include a "Location" HTTP header
that contains the resource URI of the existing "Individual
subscription" resource.
The response body shall be empty.
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.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Location:
description: >
The resource URI of the created "Individual subscription" resource.
schema:
type: string
format: url
minimum: 1
maximum: 1
Shall be returned upon the following error: The content type
of the message content is supported and the message content of a request
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
contains syntactically correct data but the data cannot be processed.
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 resource, the response code 422 shall also
be returned if the API producer has tested the Notification endpoint as
described in clause 7.5.7.3.2 and the test has failed.
In this case, the "detail" attribute in the "ProblemDetails" structure
shall convey more information about the error.
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.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
description: >
200 OK
Shall be returned when the list of subscriptions has been queried successfully. The response 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.6.2.3. If the
"filter" URI parameter was supplied in the request, the data in the response body shall have been
transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. If the NFV-MANO
functional entity supports alternative 2 (paging) according to clause 5.4.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 5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
Content-Type:
description: >
The MIME type of the body of the request. Reference: IETF RFC
7231
schema:
type: string
minimum: 1
maximum: 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.
schema:
type: string
minimum: 0
maximum: 1
Version:
description: |
Version of the API used in the response.
schema:
type: string
minimum: 1
maximum: 1
Link:
description: >
Reference to other resources. Used for paging in the present
document, see clause 4.7.2.1.
schema:
type: string
minimum: 0
maximum: 1
content:
application/json:
schema:
type: array
items:
$ref: "./components/NFVManoFaultManagement_def.yaml#/components/schemas/FmSubscription"
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
description: >
200 OK
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
schema:
type: string
minimum: 1
maximum: 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.
schema:
type: string
minimum: 0
maximum: 1
Version:
description: |
Version of the API used in the response.
schema:
type: string
minimum: 1
maximum: 1
content:
application/json:
schema:
$ref: "./components/NFVManoFaultManagement_def.yaml#/components/schemas/FmSubscription"
description: >
204 NO CONTENT
Shall be returned when the "Individual subscription" resource has been deleted successfully.
The response body shall be empty.
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.
schema:
type: string
minimum: 0
maximum: 1
Version:
description: |
Version of the API used in the response.
schema:
type: string
minimum: 1
maximum: 1