NFVManoPerformanceManagement.yaml 73.7 KB
Newer Older
                      description: >
                        Value of the metric collected. The type of this attribute shall correspond to 
                        the related "Measurement Unit" as defined in clause 8.4 of ETSI GS NFV-IFA 031.
                    context:
                      description: >
                        Measurement context information related to the measured value. The set of 
                        applicable keys is defined per measurement in clause 8.4 of ETSI GS NFV-IFA 031.
                      $ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
                  required:
                    - timeStamp
                    - value
                minItems: 1
            required:
              - objectType
              - objectInstanceId
              - performanceMetric
              - performanceValues
          minItems: 1

    #----------

    PmNotificationsFilter:
      description: >
        This type represents a filter that can be used to subscribe for notifications 
        related to performance management events. 
        At a particular nesting level in the filter structure, the following applies: 
        All attributes shall match in order for the filter to match (logical "and" between 
        different filter attributes). If an attribute is an array, the attribute shall 
        match if at least one of the values in the array matches (logical "or" between the 
        values of one filter attribute).
      type: object
      properties:
        pmSubscriptionFilter:
          description: >
            pmSubscriptionFilter	ManoEntitySubscriptionFilter	0..1	Filter criteria 
            to select object instance about which to notify.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/ManoEntitySubscriptionFilter"
        notificationTypes:
          description: >
            Match particular notification types. 
            Permitted values:
              - ThresholdCrossedNotification
              - PerformanceInformationAvailableNotification

            The permitted values of the "notificationTypes" attribute are spelled exactly 
            as the names of the notification types to facilitate automated code generation 
            systems.
          type: string
          enum:
            - ThresholdCrossedNotification
            - PerformanceInformationAvailableNotification

    PmJobCriteria:
      description: >
        This type represents collection criteria for PM jobs.
      type: object
      properties:
        performanceMetric: 
          description: >
            This defines the types of performance metrics for the specified measured 
            object(s). This attribute’s value shall contain the related "Measurement Name" 
            values as defined in clause 8.4 of ETSI GS NFV-IFA 031. 
            At least one of the two attributes (performance metric or group) shall be present.
          type: array
          items:
            type: string
        performanceMetricGroup:
          description: >
            Group of performance metrics.
            A metric group is a pre-defined list of metrics, known to the producer that it 
            can decompose to individual metrics. This attribute’s value shall contain the 
            related "Measurement Group" values as defined in clause 8.4 of ETSI GS 
            NFV-IFA 031.
            At least one of the two attributes (performance metric or group) shall be present.
          type: array
          items:
            type: string
        collectionPeriod:
          description: >
            Specifies the periodicity at which the producer will collect performance 
            information. The unit shall be seconds. 

            At the end of each reportingPeriod, the producer will inform the API consumer 
            about availability of the performance data collected for each completed 
            collection period during this reportingPeriod. The reportingPeriod should 
            be equal to or a multiple of the collectionPeriod. In the latter case, the 
            performance data for the collection periods within one reporting period 
            are reported together. 

            In particular when choosing short collection and reporting periods, the 
            number of PM jobs that can be supported depends on the capability of the 
            producing entity.
          type: integer
        reportingPeriod:
          description: >
            Specifies the periodicity at which the producer will report to the API consumer 
            about performance information. The unit shall be seconds.

            At the end of each reportingPeriod, the producer will inform the API consumer 
            about availability of the performance data collected for each completed 
            collection period during this reportingPeriod. The reportingPeriod should 
            be equal to or a multiple of the collectionPeriod. In the latter case, the 
            performance data for the collection periods within one reporting period 
            are reported together. 

            In particular when choosing short collection and reporting periods, the 
            number of PM jobs that can be supported depends on the capability of the 
            producing entity.
          type: integer
        reportingBoundary:
          description: >
            Identifies a time boundary after which the reporting will stop.
            The boundary shall allow a single reporting as well as periodic reporting up to 
            the boundary.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
      required:
        - collectionPeriod
        - reportingPeriod

    ThresholdCriteria:
      description: >
        This type represents criteria that define a threshold.
      type: object
      properties:
        performanceMetric:
          description: >
            Defines the performance metric associated with the threshold. 
            This attribute’s value shall contain the related "Measurement Name" values 
            as defined in clause 8.4 of ETSI GS NFV-IFA 031 
          type: string
        thresholdType:
          description: >
            Type of threshold. This attribute determines which other attributes are 
            present in the data structure.
            Permitted values:
              - SIMPLE: Single-valued static threshold
            
            In the present document, simple thresholds are defined. The definition 
            of additional threshold types is left for future specification.
          type: string
          enum:
            - SIMPLE
        simpleThresholdDetails:
          description: >
            Details of a simple threshold. Shall be present if thresholdType="SIMPLE".
          type: object
          properties:
            thresholdValue:
              description: >
                The threshold value. Shall be represented as a floating point number. 
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Number"
            hysteresis:
              description: >
                The hysteresis of the threshold. 
                Shall be represented as a non-negative floating point number.
                A notification with crossing direction "UP" will be generated if the 
                measured value reaches or exceeds "thresholdValue" + "hysteresis". 
                A notification with crossing direction "DOWN" will be generated if 
                the measured value reaches or undercuts "thresholdValue" - "hysteresis". 

                The hysteresis is defined to prevent storms of threshold crossing notifications.
                When processing a request to create a threshold, implementations should enforce 
                a suitable minimum value for this attribute (e.g. override the value or reject 
                the request). 
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Number"
          required: 
            - thresholdValue
            - hysteresis
      required:
        - performanceMetric
        - thresholdType

    #----------------
    # common types to SOL009
    #----------------

  responses:
    pm_jobs.post.201:
      description: >
        201 CREATED

        Shall be returned when the PM job has been created successfully.

        The response body shall contain a representation of the created 
        "Individual PM job" resource, as defined in clause 6.6.2.7.

        The HTTP response shall include a "Location" HTTP header that 
        points to the created "Individual PM job" resource.
      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/schemas/PmJob"
    pm_jobs.get.200:
      description: >
        200 OK

        Shall be returned when information about zero or more PM jobs has 
        been queried successfully.

        The response body shall contain in an array the representations 
        of zero or more PM jobs, as defined in clause 6.6.2.7.

        If the "filter" URI parameter or one of the "all_fields", "fields" 
        (if supported), "exclude_fields" (if supported) or "exclude_default" 
        URI parameters 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 and 5.3.2 of ETSI GS NFV-SOL 013, respectively.

        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:
        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
        Link:
          description: >
            Reference to other resources. Link HTTP header in this response 
            shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
          schema:
            type: string
            minimum: 0
            maximum: 1
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "#/components/schemas/PmJob"
    pm_jobs.get.400:
      description: >
        400 BAD REQUEST

        Shall be returned upon the following errors: 
          - Invalid attribute-based filtering expression.
            The response body shall contain a ProblemDetails structure, in which 
            the "detail" attribute should convey more information about the error.
          - Invalid attribute selector.
            The response body shall contain a ProblemDetails structure, in which 
            the "detail" attribute should convey more information about the error.
          - Response too big.
            If the NFV-MANO functional entity supports alternative N°1 (error) 
            according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, 
            this error response shall follow the provisions in clause 5.4.2.2 of 
            ETSI GS NFV-SOL 013.
      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"

    pm_job.get.200:
      description: >
        200 OK

        Shall be returned when information about an individual PM job 
        has been read successfully.

        The response body shall contain a representation of the
        "Individual PM job" resource, as defined in clause 6.6.2.7.
      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/schemas/PmJob"
    pm_job.delete.204:
      description: >
        204 NO CONTENT

        Shall be returned when the PM job 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
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string

    pm_job.report.get.200:
      description: >
        200 OK

        Shall be returned when information of an individual performance 
        report has been read successfully.

        The response body shall contain a representation of the 
        "Individual performance report" resource, as defined 
        in clause 6.6.2.10.
      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/schemas/PerformanceReport"

    thresholds.post.201:
      description: >
        201 CREATED

        Shall be returned when a threshold has been created successfully. 

        The response body shall contain a representation of the created 
        "Individual threshold" resource, as defined in clause 6.6.2.9.

        The HTTP response shall include a "Location" HTTP header that 
        contains the resource URI of the created "Individual threshold" 
        resource.
      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 change state 
            operation occurence" resource.
          schema:
            type: string
            format: url
            minimum: 1
            maximum: 1
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Threshold"
    thresholds.get.200:
      description: >
        200 OK

        Shall be returned when information about zero or more thresholds 
        has been queried successfully.

        The response body shall contain in an array the representations 
        of zero or more thresholds, as defined in clause 6.6.2.9.

        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:
        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:
            type: array
            items:
              $ref: "#/components/schemas/Threshold"
    thresholds.get.400:
      description: >
        400 BAD REQUEST

        Shall be returned upon the following errors: 
          - Invalid attribute-based filtering expression.
            The response body shall contain a ProblemDetails structure, in which 
            the "detail" attribute should convey more information about the error.
          - Response too big.
            If the NFV-MANO functional entity supports alternative N°1 (error) 
            according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, 
            this error response shall follow the provisions in clause 5.4.2.2 of 
            ETSI GS NFV-SOL 013.
      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"

    threshold.get.200:
      description: >
        200 OK

        Shall be returned when information about an individual threshold 
        has been read successfully.

        The response body shall contain a representation of the threshold, 
        as defined in clause 6.6.2.9.
      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/schemas/Threshold"
    threshold.delete.204:
      description: >
        204 NO CONTENT
        
        Shall be returned when the threshold 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
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string

    subscriptions.post.201:
      description: >
        201 CREATED 

        Shall be returned when the subscription has been created successfully.

        A representation of the created subscription resource shall be returned 
        in the response body, as defined in clause 6.6.2.3.

        The HTTP response shall include a "Location" HTTP header that contains 
        the resource URI of the created "Individual subscription" resource.
      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 change state 
            operation occurence" resource.
          schema:
            type: string
            format: url
            minimum: 1
            maximum: 1
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PmSubscription"
    subscriptions.post.303:
      description: >
        303 SEE OTHER

        Shall be returned when a subscription with the same callbackURI and 
        the same filter already exists and the policy of the 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 change state 
            operation occurence" resource.
          schema:
            type: string
            format: url
            minimum: 1
            maximum: 1
    subscriptions.get.200:
      description: >
        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 PM subscriptions 
        as defined in clause 6.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:
        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:
            type: array
            items:
              $ref: "#/components/schemas/PmSubscription"
    subscriptions.get.400:
      description: >
        400 BAD REQUEST

        Shall be returned upon the following errors: 
          - Invalid attribute-based filtering expression.
            The response body shall contain a ProblemDetails structure, in which 
            the "detail" attribute should convey more information about the error.
          - Response too big.
            If the NFV-MANO functional entity supports alternative N°1 (error) 
            according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, 
            this error response shall follow the provisions in clause 5.4.2.2 of 
            ETSI GS NFV-SOL 013.
      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"

    subscription.get.200:
      description: >
        200 OK

        Shall be returned when the subscription has been read successfully.

        The response body shall contain a representation of the 
        "Individual subscription" resource, as defined in clause 6.6.2.3.
      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/schemas/PmSubscription"
    subscription.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:
        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

  parameters:

    filter.PmJob :
      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 PmJob  and in data 
        types referenced from it shall be supported by the NFV-MANO functional 
        entity in the expression. 
      in: query
      required: false
      schema:
        type: string
    filter.Threshold :
      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 Threshold  and in data 
        types referenced from it shall be supported by the NFV-MANO functional 
        entity in the expression. 
      in: query
      required: false
      schema:
        type: string
    filter.PmSubscription :
      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 PmSubscription  and in data 
        types referenced from it shall be supported by the NFV-MANO functional 
        entity in the expression. 
      in: query
      required: false
      schema:
        type: string
    exclude_default.PmJob :
      name: exclude_default
      description: >
        Indicates to exclude the following complex attributes from the 
        response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. 
        The NFV-MANO functional entity shall support this parameter.

        The following attributes shall be excluded from the PmJob 
        structure in the response body if this parameter is provided, or none of 
        the parameters "all_fields," "fields", "exclude_fields", "exclude_default" 
        are provided:
        - none
      in: query
      required: false
      schema:
        type: string
  requestBodies:
    CreatePMJobRequest:
      description: >
        PM job creation request.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CreatePmJobRequest"
      required: true

    CreateThesholdRequest:
      description: >
        Request parameters to create a threshold. 
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CreateThresholdRequest"
      required: true

    CreateSubscriptionRequest:
      description: >
        Details of the subscription to be created.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PmSubscriptionRequest"
      required: true