Newer
Older
version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - NS 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 and has not been
approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
license:
name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli
committed
contact:
name: "NFV-SOL WG"
externalDocs:
description: ETSI GS NFV-SOL 005 V2.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020701p.pdf
- https
consumes:
moscatelli
committed
###############################################################################
Samir Medjiah
committed
# API Versions #
###############################################################################
moscatelli
committed
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
Samir Medjiah
committed
###############################################################################
moscatelli
committed
# Alarms #
###############################################################################
rameshnaraya
committed
'/alarms':
#ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.2
Samir Medjiah
committed
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
get:
summary: Query alarms related to NS instances.
rameshnaraya
committed
description: >
rameshnaraya
committed
The API consumer can use this method to retrieve information about the alarm list.
This method shall follow the provisions specified in the Tables 8.4.2.3.2-1 and 8.4.2.3.2-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
parameters:
Samir Medjiah
committed
- name: filter
in: query
rameshnaraya
committed
required: false
Samir Medjiah
committed
type: string
moscatelli
committed
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
The NFVO shall support receiving this parameter as part of the URI query string.
The OSS/BSS may supply this parameter.
The following attribute names shall be supported by the NFVO in the filter
expression:
rameshnaraya
committed
- id
- nsInstanceId
- rootCauseFaultyComponent.faultyNestedNsInstanceId
- rootCauseFaultyComponent.faultyNsVirtualLinkInstanceId
- rootCauseFaultyComponent.faultyVnfInstanceId
- rootCauseFaultyResource.faultyResourceType
- eventType
- name: nextpage_opaque_marker
in: query
description: >
Marker to obtain the next page of a paged response. Shall be supported by the NFVO
if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013.
required: false
type: string
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
200:
moscatelli
committed
Shall be returned when information about zero or more alarms has been queried successfully.
rameshnaraya
committed
The response body shall contain the list of related alarms.
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 clauses 5.2.2 of ETSI GS NFV-SOL 013.
If the NFVO 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 response.
type: string
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
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
rameshnaraya
committed
schema:
moscatelli
committed
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
moscatelli
committed
###############################################################################
# Individual alarm #
###############################################################################
rameshnaraya
committed
'/alarms/{alarmId}':
#ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.3
rameshnaraya
committed
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.
rameshnaraya
committed
in: path
type: string
required: true
Samir Medjiah
committed
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
description: >
The API consumer can use this method to read an individual alarm.
This method shall follow the provisions specified in the Tables 8.4.3.3.2-1 and 8.4.3.3.2-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
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
moscatelli
committed
responses:
moscatelli
committed
Shall be returned when information about an individual alarm has been read successfully.
The response body shall contain a representation of the individual alarm.
rameshnaraya
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
rameshnaraya
committed
type: string
maximum: 1
minimum: 1
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
schema:
moscatelli
committed
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
rameshnaraya
committed
patch:
summary: Acknowledge individual alarm.
rameshnaraya
committed
description: >
Acknowledge Alarm
moscatelli
committed
rameshnaraya
committed
This method modifies an individual alarm resource.
This method shall follow the provisions specified in the Tables 8.4.3.3.2-1 and 8.4.3.3.2-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
parameters:
moscatelli
committed
required: true
schema:
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications"
description: >
The parameter for the alarm modification, as defined in clause 8.5.2.8.
moscatelli
committed
- 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 Content-Type header shall be set to
"application/merge-patch+json" according to
IETF RFC 7396.
in: header
required: true
type: string
enum:
- application/merge-patch+json
rameshnaraya
committed
responses:
200:
moscatelli
committed
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 8.5.2.8).
rameshnaraya
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
rameshnaraya
committed
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
schema:
properties:
AlarmModifications:
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
409:
$ref: "../responses/SOL005_resp.yaml#/components/responses/409"
rameshnaraya
committed
412:
$ref: "../responses/SOL005_resp.yaml#/components/responses/412"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
moscatelli
committed
##############################################################################
#Subscriptions #
##############################################################################
rameshnaraya
committed
'/subscriptions':
#ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.4
Samir Medjiah
committed
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
post:
summary: Subscribe to alarms related to NSs.
moscatelli
committed
description: >
rameshnaraya
committed
The POST method creates a new subscription.
This method shall follow the provisions specified in the Tables 8.4.4.3.1-1 and 8.4.4.3.1-2 for URI query
parameters, request and response data structures, and response codes.
As the result of successfully executing this method, a new "Individual subscription" resource shall exist
as defined in clause 8.4.5. This method shall not trigger any notification.
rameshnaraya
committed
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 OSS, and might make sense only in very rare
use cases. Consequently, the NFVO 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).
moscatelli
committed
parameters:
rameshnaraya
committed
- 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
moscatelli
committed
type: string
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscriptionRequest"
description: >
Details of the subscription to be created, as defined in clause 8.5.2.2.
rameshnaraya
committed
responses:
201:
moscatelli
committed
Shall be returned when the subscription has been 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.
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
rameshnaraya
committed
headers:
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
rameshnaraya
committed
WWW-Authenticate:
rameshnaraya
committed
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
303:
$ref: "../responses/SOL005_resp.yaml#/components/responses/303"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/422"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
rameshnaraya
committed
get:
summary: Query multiple subscriptions.
rameshnaraya
committed
description: >
Query Subscription Information
moscatelli
committed
The API consumer can use this method to retrieve the list of active subscriptions for alarms related to an NS subscribed
by the API consumer. It can be used e.g. for resynchronization after error situations.
This method shall follow the provisions specified in the Tables 8.4.4.3.2-1 and 8.4.4.3.2-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
parameters:
Samir Medjiah
committed
- name: filter
in: query
rameshnaraya
committed
required: false
Samir Medjiah
committed
type: string
moscatelli
committed
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
The NFVO shall support receiving this parameter as part of the URI query string. The
OSS/BSS may supply this parameter.
All attribute names that appear in the FmSubscription and in data types referenced from it
shall be supported by the NFVO in the filter expression.
- name: nextpage_opaque_marker
in: query
description: >
Marker to obtain the next page of a paged response. Shall be supported by the NFVO if the NFVO
supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
required: false
type: string
rameshnaraya
committed
- 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
responses:
200:
moscatelli
committed
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
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 [16].
If the NFVO supports alternative 2 (paging)
according to clause 5.4.2.1 of ETSI
GS NFV-SOL 013 [16] 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 [16].
rameshnaraya
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
rameshnaraya
committed
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
rameshnaraya
committed
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
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
rameshnaraya
committed
schema:
type: array
items:
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
412:
$ref: "../responses/SOL005_resp.yaml#/components/responses/412"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
moscatelli
committed
###############################################################################
# Individual subscription #
###############################################################################
rameshnaraya
committed
'/subscriptions/{subscriptionId}':
#ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.5
rameshnaraya
committed
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
Samir Medjiah
committed
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
get:
summary: Read an individual subscription.
rameshnaraya
committed
description: >
Query Subscription Information
moscatelli
committed
The API consumer can use this method for reading an individual subscription for alarms related to NSs subscribed by
the API consumer.
This method shall follow the provisions specified in the Tables 8.4.5.3.2-1 and 8.4.5.3.2-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
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
responses:
200:
moscatelli
committed
Shall be returned when information about an individual subscription has been read successfully.
The response body shall contain a representation of the subscription resource.
rameshnaraya
committed
headers:
Content-Type:
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
schema:
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
rameshnaraya
committed
delete:
rameshnaraya
committed
description: >
Terminate Subscription
moscatelli
committed
rameshnaraya
committed
This method terminates an individual subscription.
As the result of successfully executing this method, the "Individual subscription" resource shall
not exist any longer. This means that no notifications for that subscription shall be sent to the
formerly-subscribed API consumer.
NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed
API consumer for a certain time period after the deletion.
rameshnaraya
committed
responses:
204:
moscatelli
committed
description: >
moscatelli
committed
Shall be returned when the subscription resource has been deleted successfully.
rameshnaraya
committed
The response body shall be empty.
headers:
WWW-Authenticate:
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"