swagger: "2.0" info: version: "1.2.0" title: "SOL002 - VNF Indicator interface" description: > VNF Indicator interface of ETSI NFV SOL002. This API allows the EM/VNF to provide information on value changes of VNF related indicators. VNF related indicators are declared in the VNFD. 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/bugzilla/buglist.cgi?component=Nfv-Openapis license: name: "ETSI Forge copyright notice" url: https://forge.etsi.org/etsi-forge-copyright-notice.txt externalDocs: description: ETSI GS NFV-SOL 002 V2.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf basePath: /vnfind/v1 schemes: - http - https consumes: - application/json produces: - application/json paths: ############################################################################### # API Versions # ############################################################################### '/api-versions': parameters: - name: Version description: > Version of the API requested to use when responding to this request. in: header required: true type: string get: summary: Retrieve API version information description: > The GET method reads API version information. This method shall follow the provisions specified in table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not supported. responses: 200: description: > API version information was read successfully. The response body shall contain 4.4 API version information, as defined in clause 4.4.1.13. schema: $ref: '../../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation' headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 Version: description: The used API version. type: string maximum: 1 minimum: 1 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } 413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' } 414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 429: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/429' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } 504: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/504' } ############################################################################### # VNF Indicators # ############################################################################### /indicators: parameters: - name: Version description: > Version of the API requested to use when responding to this request. in: header required: true type: string get: summary: Query multiple indicators description: Get a list of indicators. Support of attribute based filtering via query parameters. parameters: - 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 EM/VNF may supply this parameter. The VNF may supply its instance Id as an attribute filter. All attribute names that appear in the VnfIndicator data type and in data types referenced from it shall be supported by the VNFM in the filter expression. If receiving, this parameter is not supported a 400 Bad Request response shall be returned (See table 8.4.2.3.2-2). EXAMPLE objects obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} Request 1: GET …/container Response 1: [ {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}, {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} ] Request 2: GET …/container?filter=(eq.weight,100) Response 2: [ {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} ] #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used 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 EM/VNF if the EM/VNF supports alternative 2 (paging) according to clause 4.7.2.1 for this resource in: query required: false type: string responses: 200: description: > OK Information about zero or more VNF indicators was queried successfully. The response body shall contain in an array the representations of all VNF indicators that match the attribute-based filtering parameters, i.e. zero or more representations of VNF indicators as defined in clause 8.5.2.2. If the EM/VNF 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. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 Version: description: The used API version. type: string maximum: 1 minimum: 1 schema: type: array items: $ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator' 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } /indicators/{vnfInstanceId}: parameters: - name: vnfInstanceId in: path description: > Service Unavailable Identifier of the VNF instance to which the VNF indicators applies. NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response. type: string required: true - name: Version description: > Version of the API requested to use when responding to this request. in: header required: true type: string get: summary: Query multiple indicators related to a VNF instance. description: > Get a list of indicators related to a specific VNF instance. Support of attribute based filtering via query parameters. parameters: - 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 EM/VNF shall support receiving filtering parameters as part of the URI query string. The VNFM may supply filtering parameters. All attribute names that appear in the VnfIndicator data type and in data types referenced from it shall be supported in attribute-based filtering parameters. EXAMPLE objects obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} Request 1: GET …/container Response 1: [ {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}, {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} ] Request 2: GET …/container?filter=(eq.weight,100) Response 2: [ {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} ] #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used 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 EM/VNF if the EM/VNF supports alternative 2 (paging) according to clause 4.7.2.1 for this resource. in: query required: false type: string responses: 200: description: > OK Information about zero or more VNF indicators was queried successfully. The response body shall contain in an array the representations of all VNF indicators that are related to the particular VNF instance and that match the attribute filter., i.e. zero or more representations of VNF indicators as defined in clause 8.5.2.2. If the EM/VMF 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. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 Version: description: The used API version. type: string maximum: 1 minimum: 1 schema: type: array items: $ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator' 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } /indicators/{vnfInstanceId}/{indicatorId}: parameters: - name: vnfInstanceId in: path description: > Service Unavailable Identifier of the VNF instance to which the VNF indicators applies. NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response. type: string required: true - name: indicatorId in: path description: > Identifier of the VNF indicator. # LEH NOTE from SOL002 is strange type: string required: true - name: Version description: > Version of the API requested to use when responding to this request. in: header required: true type: string get: summary: Read an inidividual VNF indicator related to a VNF instance. description: > Read an individual VNF indicator related to a specific VNF instance. NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response. responses: 200: description: > OK The VNF indicator was read successfully. The response body shall contain the representation of the VNF indicator. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 Version: description: The used API version. type: string maximum: 1 minimum: 1 schema: $ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator' 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } /indicators/{indicatorId}: parameters: - name: indicatorId in: path description: > Identifier of the VNF indicator. type: string required: true - name: Version description: > Version of the API requested to use when responding to this request. in: header required: true type: string get: summary: Read an inidividual VNF indicator related to a VNF instance. description: > Reads a VNF indicator. responses: 200: description: > OK The VNF indicator was read successfully. The response body shall contain the representation of the VNF indicator. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 Version: description: The used API version. type: string maximum: 1 minimum: 1 schema: $ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator' 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } /subscriptions: parameters: - name: Version description: > Version of the API requested to use when responding to this request. in: header required: true type: string post: summary: Create a new subscription to VNF indicator change notifications description: Create a new subscription parameters: - name: subscription in: body description: Subscription data. required: true schema: $ref: 'definitions/VnfIndicatorSubscriptionRequest_def.yaml#/definitions/VnfIndicatorSubscriptionRequest' responses: 201: description: > Created The subscription was created successfully. The response body shall contain a representation of the created subscription resource. schema: $ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription' headers: Location: description: > Pointer to the created subscription resource. type: string format: URI Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 Version: description: The used API version. type: string maximum: 1 minimum: 1 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } get: summary: Query multiple subscriptions. description: > Service Unavailable The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations. parameters: - name: filter description: > Attribute-based filtering expression according to clause 4.3.2. The EM shall and the VNF may support receiving this parameter as part of the URI query string. The VNFM may supply this parameter. All attribute names that appear in the VnfIndicatorSubscription data type and in data types referenced from it shall be supported in the filter expression. If receiving, this parameter is not supported, a 400 Bad Request response shall be returned (see table 8.4.5.3.2-2). EXAMPLE objects obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} Request 1: GET …/container Response 1: [ {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}, {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} ] Request 2: GET …/container?filter=(eq.weight,100) Response 2: [ {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} ] #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used 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 EM if the EM supports alternative 2 (paging) according to clause 4.7.2.1 for this resource. in: query required: false type: string responses: 200: description: > OK The list of subscriptions was queried successfully. The response body shall contain in an array the representations of all active subscriptions of the functional block that invokes the method which match the attribute filter, i.e. zero or more representations of VNF indicators subscriptions as defined in clause 8.5.2.4. If the EM 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. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 Version: description: The used API version. type: string maximum: 1 minimum: 1 schema: type: array items: $ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription' 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } /subscriptions/{subscriptionId}: parameters: - name: Version description: > Version of the API requested to use when responding to this request. in: header required: true type: string get: summary: Read an individual subscription. description: > Service Unavailable This resource represents an individual subscription. The client can use this resource to read and to terminate a subscription to notifications related to VNF indicator value changes. parameters: - name: subscriptionId description: > Identifier of this subscription. NOTE: 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 responses: 200: description: > OK The subscriptions was queried successfully. The response body shall contain the representation of the requested subscription. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 Version: description: The used API version. type: string maximum: 1 minimum: 1 schema: $ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription' 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } delete: summary: Delete a subscription description: Terminate an individual subscription. parameters: - name: subscriptionId description: > Service Unavailable Identifier of this subscription. NOTE: 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 responses: 204: description: > No Content The subscription was deleted successfully. The response body shall be empty. headers: Version: description: The used API version. type: string maximum: 1 minimum: 1 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }