openapi: 3.0.2 info: title: SOL002 - VNF Fault Management interface description: | SOL002 - VNF 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/SOL002-SOL003/issues contact: name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt version: 1.5.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 002 V3.7.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.07.01_60/gs_NFV-SOL002v030701p.pdf servers: - url: http://127.0.0.1/vnffm/v1 - url: https://127.0.0.1/vnffm/v1 paths: /api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' /alarms: parameters: - $ref: ../../components/SOL002_params.yaml#/components/parameters/Version - $ref: ../../components/SOL002_params.yaml#/components/parameters/Authorization get: description: | The API consumer can use this method to retrieve information about the alarm list. See clause 7.4.2.3.2. parameters: - $ref: ../../components/SOL002_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002_params.yaml#/components/parameters/ContentType - $ref: '#/components/parameters/filter_alarms' - $ref: ../../components/SOL002_params.yaml#/components/parameters/nextpage_opaque_marker_vnfm responses: "200": $ref: '#/components/responses/Alarms.Get.200' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 /alarms/{alarmId}: parameters: - $ref: '#/components/parameters/AlarmId' - $ref: ../../components/SOL002_params.yaml#/components/parameters/Version - $ref: ../../components/SOL002_params.yaml#/components/parameters/Authorization get: description: | The API consumer can use this method to read an individual alarm. See clause 7.4.3.3.2. parameters: - $ref: ../../components/SOL002_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002_params.yaml#/components/parameters/ContentType responses: "200": $ref: '#/components/responses/IndividualAlarm.Get.200' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 patch: description: | This method modifies an individual alarm resource. See clause 7.4.3.3.4. parameters: - $ref: ../../components/SOL002_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002_params.yaml#/components/parameters/ContentType - $ref: ../../components/SOL002_params.yaml#/components/parameters/If-Unmodified-Since - $ref: ../../components/SOL002_params.yaml#/components/parameters/If-Match requestBody: $ref: '#/components/requestBodies/IndividualAlarmRequest' responses: "200": $ref: '#/components/responses/IndividualAlarm.Patch.200' "409": $ref: '#/components/responses/IndividualAlarm.Patch.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 "412": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 /alarms/{alarmId}/escalate: parameters: - $ref: '#/components/parameters/AlarmId' - $ref: ../../components/SOL002_params.yaml#/components/parameters/Version - $ref: ../../components/SOL002_params.yaml#/components/parameters/Authorization post: description: | The POST method enables the API consumer to escalate the perceived severity of an alarm that is represented by an individual alarm resource. See clause 7.4.4.3.1. requestBody: $ref: '#/components/requestBodies/IndividualAlarmEscalateRequest' responses: "204": $ref: '#/components/responses/IndividualAlarmEscalate.Post.204' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 /subscriptions: parameters: - $ref: ../../components/SOL002_params.yaml#/components/parameters/Version - $ref: ../../components/SOL002_params.yaml#/components/parameters/Authorization get: description: | The API consumer can use this method to retrieve the list of active subscriptions for VNF alarms subscribed by the API consumer. It can be used e.g. for resynchronization after error situations. See clause 7.4.5.3.2. parameters: - $ref: ../../components/SOL002_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002_params.yaml#/components/parameters/ContentType - $ref: '#/components/parameters/filter_subscriptions' - $ref: ../../components/SOL002_params.yaml#/components/parameters/nextpage_opaque_marker_vnfm responses: "200": $ref: '#/components/responses/Subscriptions.Get.200' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 post: description: | The POST method creates a new subscription. See clause 7.4.5.3.1. parameters: - $ref: ../../components/SOL002_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002_params.yaml#/components/parameters/ContentType requestBody: $ref: '#/components/requestBodies/FmSubscriptionRequest' responses: "201": $ref: '#/components/responses/Subscriptions.Post.201' "303": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/303 "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": $ref: '#/components/responses/Subscriptions.Post.422' "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 /subscriptions/{subscriptionId}: parameters: - $ref: '#/components/parameters/SubscriptionId' - $ref: ../../components/SOL002_params.yaml#/components/parameters/Version - $ref: ../../components/SOL002_params.yaml#/components/parameters/Authorization get: description: | The API consumer can use this method for reading an individual subscription for VNF alarms subscribed by the API consumer. See clause 7.4.6.3.2. parameters: - $ref: ../../components/SOL002_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002_params.yaml#/components/parameters/ContentType responses: "200": $ref: '#/components/responses/IndividualSubscription.Get.200' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 delete: description: | This method terminates an individual subscription. See clause 7.4.6.3.5. responses: "204": $ref: '#/components/responses/IndividualSubscription.Delete.204' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 components: parameters: filter_subscriptions: name: filter description: > Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013 [6]. The VNFM shall support receiving this parameter as part of the URI query string. The EM may supply this parameter. The VNF may supply its instance Id as an attribute filter. 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 schema: type: string filter_alarms: name: filter description: > Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013 [6]. The VNFM shall support receiving this parameter as part of the URI query string. The EM may supply this parameter. The VNF may supply its instance Id as an attribute filter. The following attribute names shall be supported in the filter expression: id, managedObjectId, vnfcInstanceIds, rootCauseFaultyResource.faultyResourceType, eventType, perceivedSeverity, probableCause. If the vnfcInstanceIds parameter is provided, exactly one value for the managedObjectId attribute shall be provided. in: query required: false schema: type: string AlarmId: name: alarmId in: path 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. required: true style: simple explode: false schema: type: string SubscriptionId: name: subscriptionId in: path 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 message content of that response. required: true style: simple explode: false schema: type: string requestBodies: IndividualAlarmRequest: description: The parameter for the alarm modification content: application/json: schema: $ref: definitions/SOL002VNFFaultManagement_def.yaml#/definitions/AlarmModifications required: true IndividualAlarmEscalateRequest: description: The proposed "escalated perceived severity" value content: application/json: schema: $ref: ./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityRequest required: false FmSubscriptionRequest: description: The VNF creation parameters content: application/json: schema: $ref: definitions/SOL002VNFFaultManagement_def.yaml#/definitions/FmSubscriptionRequest required: true responses: Alarms.Get.200: description: | 200 OK Shall be returned when 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 "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 VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013for 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: Version: description: The used API version. style: simple explode: false schema: type: string 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. style: simple explode: false schema: type: string Link: description: | Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. style: simple explode: false schema: type: string Content-Type: description: The MIME type of the body of the response. style: simple explode: false schema: type: string content: application/json: schema: $ref: ./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm IndividualAlarm.Get.200: description: | 200 OK Shall be returned when information about an individual alarm read successfully. The response body shall contain a representation of the individual alarm. headers: Version: description: The used API version. style: simple explode: false schema: type: string 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. style: simple explode: false schema: type: string Content-Type: description: The MIME type of the body of the response. style: simple explode: false schema: type: string ETag: description: > Used to provide the current entity-tag for the selected resource representation. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string Last-Modified: description: > Used to provide a timestamp indicating the date and time at which the server believes the selected resource representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string format: date-time content: application/json: schema: $ref: ./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm IndividualAlarm.Patch.200: description: | 200 OK Shall be returned when the request was accepted and completed. The response body shall contain attribute modifications for an "Individual alarm" resource. headers: Version: description: The used API version. style: simple explode: false schema: type: string 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. style: simple explode: false schema: type: string Content-Type: description: The MIME type of the body of the response. style: simple explode: false schema: type: string ETag: description: > Used to provide the current entity-tag for the selected resource representation. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string Last-Modified: description: > Used to provide a timestamp indicating the date and time at which the server believes the selected resource representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string format: date-time content: application/json: schema: $ref: definitions/SOL002VNFFaultManagement_def.yaml#/definitions/AlarmModifications IndividualAlarm.Patch.409: 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 "Individual alarm" resource. Typically, this is due to the fact that the alarm is already in the state that is requested to be set (such as trying to acknowledge an already-acknowledged alarm). The response body shall contain a ProblemDetails structure, in which the "detail" attribute 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. style: simple explode: false schema: type: string Version: description: The used API version. style: simple explode: false schema: type: string Content-Type: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string content: application/json: schema: $ref: "../General_Definitions/SOL002_def.yaml#/definitions/ProblemDetails" IndividualAlarmEscalate.Post.204: description: | 204 No Content Shall be returned when the VNFM has received the proposed "escalated perceived severity" value successfully. The response body shall be empty. headers: Version: description: The used API version. style: simple explode: false schema: type: string content: {} Subscriptions.Get.200: description: | 200 OK Shall be returned when the list of subscriptions has been queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method. 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 VNFM 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: Version: description: The used API version. style: simple explode: false schema: type: string 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. style: simple explode: false schema: type: string Link: description: | Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. style: simple explode: false schema: type: string Content-Type: description: The MIME type of the body of the response. style: simple explode: false schema: type: string content: application/json: schema: $ref: definitions/SOL002VNFFaultManagement_def.yaml#/definitions/FmSubscription Subscriptions.Post.201: description: | 201 CREATED 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: Version: description: The used API version. style: simple explode: false schema: type: string 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. style: simple explode: false schema: type: string Content-Type: description: The MIME type of the body of the response. style: simple explode: false schema: type: string Location: description: | The resource URI of the created subscription resource. style: simple explode: false schema: type: string format: url content: application/json: schema: $ref: definitions/SOL002VNFFaultManagement_def.yaml#/definitions/FmSubscription Subscriptions.Post.422: description: | 422 Unprocessable Content Shall be returned upon the following error: The content type of the message content is supported and the message content of a request 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 [6], 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 VNFM has tested the Notification endpoint as described in clause 7.4.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. style: simple explode: false schema: type: string Version: description: Version of the API used in the response. style: simple explode: false schema: type: string Content-Type: description: | The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string content: application/json: schema: $ref: "../General_Definitions/SOL002_def.yaml#/definitions/ProblemDetails" IndividualSubscription.Get.200: description: | 200 OK Shall be returned when information about an individual subscription has been read successfully. The response body shall contain a representation of the "Individual subscription" resource. headers: Version: description: The used API version. style: simple explode: false schema: type: string 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. style: simple explode: false schema: type: string Content-Type: description: The MIME type of the body of the response. style: simple explode: false schema: type: string content: application/json: schema: $ref: definitions/SOL002VNFFaultManagement_def.yaml#/definitions/FmSubscription IndividualSubscription.Delete.204: description: | 204 NO CONTENT Shall be returned when the "Individual subscription" resource has been deleted successfully. The response body shall be empty. headers: Version: description: The used API version. style: simple explode: false schema: type: string 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. style: simple explode: false schema: type: string content: {}