Newer
Older
title: SOL003 - VNF Performance Management interface
SOL003 - VNF Performance 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.
Giacomo Bernini
committed
Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
Michele Carignani
committed
externalDocs:
Giacomo Bernini
committed
description: ETSI GS NFV-SOL 003 V2.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf
Michele Carignani
committed
servers:
- url: http://127.0.0.1/vnfpm/v2
- url: https://127.0.0.1/vnfpm/v2
Giacomo Bernini
committed
###############################################################################
# API Versions #
###############################################################################
Giacomo Bernini
committed
$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
###############################################################################
# PM jobs #
###############################################################################
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
Create PM Job.
This method shall follow the provisions specified in the tables 6.4.2.3.1-1 and 6.4.2.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 PM job" resource as defined
in clause 6.4.3 shall have been created.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/CreatePmJobRequest'
$ref: '#/components/responses/PMJobs.Post.201'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
Query PM Job.
Giacomo Bernini
committed
The API consumer can use this method to retrieve information about PM jobs.
This method shall follow the provisions specified in the tables 6.4.2.3.2-1 and 6.4.2.3.2-2
for URI query parameters, request and response data structures, and response codes.
Giacomo Bernini
committed
The API consumer can use this method to retrieve information about PM jobs.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
$ref: '#/components/responses/PMJobs.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Individual PM job #
###############################################################################
#SOL003 location: 6.4.3
parameters:
- $ref: '#/components/parameters/PmJobId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
moscatelli
committed
Query PM Job.
Giacomo Bernini
committed
The API consumer can use this method for reading an individual PM job.
moscatelli
committed
This method shall follow the provisions specified in the tables 6.4.3.3.2-1 and 6.4.3.3.2-2
for URI query parameters, request and response data structures, and response codes.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
$ref: '#/components/responses/IndividualPMJob.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
moscatelli
committed
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
Giacomo Bernini
committed
patch:
This method allows to modify an "Individual PM job" resource.
Giacomo Bernini
committed
This method shall follow the provisions specified in the tables
6.4.3.3.4-1 and 6.4.3.3.4-2 for URI query parameters, request
and response data structures, and response codes.
responses:
200:
$ref: '#/components/responses/IndividualPMJob.Patch.200'
Giacomo Bernini
committed
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
Giacomo Bernini
committed
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
Giacomo Bernini
committed
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
Giacomo Bernini
committed
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
Giacomo Bernini
committed
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
412:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
Giacomo Bernini
committed
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
Giacomo Bernini
committed
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
Giacomo Bernini
committed
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
Giacomo Bernini
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
Giacomo Bernini
committed
moscatelli
committed
Delete PM Job.
This method terminates an individual PM job.
moscatelli
committed
This method shall follow the provisions specified in the tables 6.4.3.3.5-1 and 6.4.3.3.5-2
for URI query parameters, request and response data structures, and response codes.
As the result of successfully executing this method, the "Individual PM job" resource shall not exist any longer.
$ref: '#/components/responses/IndividualPMJob.Delete.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
moscatelli
committed
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Individual performance report #
###############################################################################
/pm_jobs/{pmJobId}/reports/{reportId}:
#SOL003 location: 6.4.4
parameters:
- $ref: '#/components/parameters/PmJobId'
- $ref: '#/components/parameters/ReportId'
Giacomo Bernini
committed
The API consumer can use this method for reading an individual performance report.
moscatelli
committed
This method shall follow the provisions specified in the tables 6.4.4.3.2-1 and 6.4.4.3.2-2
for URI query parameters, request and response data structures, and response codes.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/IndividualPerformanceReport.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
moscatelli
committed
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Thresholds #
###############################################################################
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
moscatelli
committed
Create Threshold.
Giacomo Bernini
committed
The POST method can be used by the API consumer to create a threshold.
moscatelli
committed
This method shall follow the provisions specified in the tables 6.4.5.3.1-1 and 6.4.5.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 threshold" resource
as defined in clause 6.4.6 shall have been created.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/CreateThresholdRequest'
$ref: '#/components/responses/Thresholds.Post.201'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
moscatelli
committed
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
moscatelli
committed
Query Threshold.
Giacomo Bernini
committed
The API consumer can use this method to query information about thresholds.
moscatelli
committed
This method shall follow the provisions specified in the tables 6.4.5.3.2-1 and 6.4.5.3.2-2
for URI query parameters, request and response data structures, and response codes.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
$ref: '#/components/responses/Thresholds.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
moscatelli
committed
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Individual threshold #
###############################################################################
- $ref: '#/components/parameters/ThresholdId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
moscatelli
committed
Query Threshold.
Giacomo Bernini
committed
The API consumer can use this method for reading an individual threshold
moscatelli
committed
This method shall follow the provisions specified in the tables 6.4.6.3.2-1 and 6.4.6.3.2-2
for URI query parameters, request and response data structures, and response codes.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
$ref: '#/components/responses/IndividualThreshold.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
moscatelli
committed
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
Giacomo Bernini
committed
patch:
Giacomo Bernini
committed
This method allows to modify an "Individual threshold" resource.
This method shall follow the provisions specified in the tables
6.4.6.3.4-1 and 6.4.6.3.4-2 for URI query parameters, request
and response data structures, and response codes.
$ref: '#/components/responses/IndividualThreshold.Patch.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
412:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
moscatelli
committed
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
Giacomo Bernini
committed
Delete Threshold.
This method allows to delete a threshold.
This method shall follow the provisions specified in the tables 6.4.6.3.5-1 and 6.4.6.3.5-2
moscatelli
committed
for URI query parameters, request and response data structures, and response codes.
Giacomo Bernini
committed
As the result of successfully executing this method, the "Individual threshold" resource
shall not exist any longer.
$ref: '#/components/responses/IndividualThreshold.Delete.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
moscatelli
committed
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
Giacomo Bernini
committed
# ##############################################################################
# # Subscriptions #
# ##############################################################################
# '/subscriptions':
# #SOL003 location: 6.4.7
# post:
Giacomo Bernini
committed
# Subscribe.
# The POST method creates a new subscription.
# This method shall follow the provisions specified in the tables 6.4.7.3.1-1 and 6.4.7.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
# as defined in clause 6.4.8 shall have been created. This method shall not trigger any notification.
# Creation of two "Individual subscription" resources with the same callbackURI and the same filter
# can result in performance degradation and will provide duplicates of notifications to the NFVO,
# and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating
# a new "Individual subscription" resource if another "Individual 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 "Individual subscription" resource (in which case it shall
# return a "303 See Other" response code referencing the existing "Individual subscription" resource
# with the same filter and callbackUri).
# parameters:
# - name: PmSubscriptionRequest
Giacomo Bernini
committed
# Details of the subscription to be created.
# in: body
# required: true
# schema:
# $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscriptionRequest"
# - name: Accept
Giacomo Bernini
committed
# Content-Types that are acceptable for the response.
# Reference: IETF RFC 7231
# in: header
# required: true
# type: string
# - name: Authorization
Giacomo Bernini
committed
# The authorization token for the request.
# Reference: IETF RFC 7235
# in: header
# required: false
# type: string
# - name: Content-Type
Giacomo Bernini
committed
# The MIME type of the body of the request.
# Reference: IETF RFC 7231
# in: header
# required: true
# type: string
# - name: Version
Giacomo Bernini
committed
# Version of the API requested to use when responding to this request.
# in: header
# required: true
# type: string
# responses:
# 201:
Giacomo Bernini
committed
# 201 CREATED
#
# Shall be returned when the subscription has been created successfully.
# A representation of the created "Individual subscription" resource shall be
# returned in the response body, as defined in clause 6.5.2.3.
# The HTTP response shall include a "Location" HTTP header that contains the
# resource URI of the created "Individual subscription" resource.
# headers:
# Location:
# description: The resource URI of the created VNF instance
# type: string
# format: url
# Content-Type:
Giacomo Bernini
committed
# The MIME type of the body of the request.
# Reference: IETF RFC 7231
# type: string
# maximum: 1
# minimum: 1
# WWW-Authenticate:
Giacomo Bernini
committed
# Challenge if the corresponding HTTP request has not provided
# authorization, or error details if the corresponding HTTP
# request has provided an invalid authorization token.
# type: string
# maximum: 1
# minimum: 0
# Version:
Giacomo Bernini
committed
# Version of the API used in the response.
# type: string
# maximum: 1
# minimum: 1
# schema:
# $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription"
# 303:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/303"
Giacomo Bernini
committed
# 400:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
Giacomo Bernini
committed
# 401:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
Giacomo Bernini
committed
# 403:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
# 404:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
Giacomo Bernini
committed
# 405:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
Giacomo Bernini
committed
# 406:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
# 422:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
Giacomo Bernini
committed
# 500:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
Giacomo Bernini
committed
# 503:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
Giacomo Bernini
committed
# 504:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
Giacomo Bernini
committed
#
# get:
Giacomo Bernini
committed
# Query Subscription Information.
# TThe client can use this method to query the list of active subscriptions
# to Performance management notifications subscribed by the client.
# This method shall follow the provisions specified in the tables 6.4.7.3.2-1 and 6.4.7.3.2-2
# for URI query parameters, request and response data structures, and response codes.
# parameters:
# - name: Accept
Giacomo Bernini
committed
# Content-Types that are acceptable for the response.
# Reference: IETF RFC 7231
# in: header
# required: true
# type: string
# - name: Authorization
Giacomo Bernini
committed
# The authorization token for the request.
# Reference: IETF RFC 7235
# in: header
# required: false
# type: string
# - name: filter
Giacomo Bernini
committed
# Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
# The VNFM shall support receiving this parameter as part of the
# URI query string. The NFVO may supply this parameter.
# All attribute names that appear in the PmSubscription and in
# data types referenced from it shall be supported by the VNFM
# in the filter expression.
# in: query
# required: false
# type: string
# - name: nextpage_opaque_marker
Giacomo Bernini
committed
# Marker to obtain the next page of a paged response. Shall be
# supported by the VNFM if the VNFM supports alternative 2 (paging)
# according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
# in: query
# required: false
# type: string
# - name: Version
Giacomo Bernini
committed
# Version of the API requested to use when responding to this request.
# in: header
# required: true
# type: string
# responses:
# 200:
Giacomo Bernini
committed
# 200 OK
#
# Shall be returned when the list of subscriptions has been queried successfully.
# The response body shall contain in an array the representations of all active subscriptions
# of the functional block that invokes the method, i.e. zero or more representations of
# PM subscriptions as defined in clause 6.5.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 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:
# Content-Type:
Giacomo Bernini
committed
# The MIME type of the body of the request.
# Reference: IETF RFC 7231
# type: string
# maximum: 1
# minimum: 1
# WWW-Authenticate:
Giacomo Bernini
committed
# Challenge if the corresponding HTTP request has not provided
# authorization, or error details if the corresponding HTTP
# request has provided an invalid authorization token.
# type: string
# maximum: 1
# minimum: 0
# Version:
Giacomo Bernini
committed
# Version of the API used in the response.
# type: string
# maximum: 1
# minimum: 1
# Link:
Giacomo Bernini
committed
# Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
# type: string
# maximum: 1
# minimum: 0
# schema:
# type: array
# items:
# $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription"
# 400:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
Giacomo Bernini
committed
# 401:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
Giacomo Bernini
committed
# 403:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
# 404:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
Giacomo Bernini
committed
# 405:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
Giacomo Bernini
committed
# 406:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
# 422:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
Giacomo Bernini
committed
# 500:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
Giacomo Bernini
committed
# 503:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
Giacomo Bernini
committed
# 504:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
Giacomo Bernini
committed
#
# ###############################################################################
# # Individual subscription #
# ###############################################################################
# '/subscriptions/{subscriptionId}':
# #SOL003 location: 6.4.8
# parameters:
# - name: subscriptionId
Giacomo Bernini
committed
# This identifier can be retrieved from the resource referenced by the
# "Location" HTTP header in the response to a POST request creating a
# new "Individual subscription" resource. It can also be retrieved from the "id"
# attribute in the payload body of that response.
# in: path
# type: string
# required: true
# get:
Giacomo Bernini
committed
# Query Subscription Information.
# The client can use this method for reading an individual subscription about
# Performance management notifications subscribed by the client.
# This method shall follow the provisions specified in the tables 6.4.8.3.2-1 and 6.4.8.3.2-2
# for URI query parameters, request and response data structures, and response codes.
# parameters:
# - name: Accept
Giacomo Bernini
committed
# Content-Types that are acceptable for the response.
# Reference: IETF RFC 7231
# in: header
# required: true
# type: string
# - name: Authorization
Giacomo Bernini
committed
# The authorization token for the request.
# Reference: IETF RFC 7235
# in: header
# required: false
# type: string
# - name: Version
Giacomo Bernini
committed
# Version of the API requested to use when responding to this request.
# in: header
# required: true
# type: string
# responses:
# 200:
Giacomo Bernini
committed
# 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.5.2.3.
# headers:
# Content-Type:
Giacomo Bernini
committed
# The MIME type of the body of the request.
# Reference: IETF RFC 7231
# type: string
# maximum: 1
# minimum: 1
# WWW-Authenticate:
Giacomo Bernini
committed
# Challenge if the corresponding HTTP request has not provided
# authorization, or error details if the corresponding HTTP
# request has provided an invalid authorization token.
# type: string
# maximum: 1
# minimum: 0
# Version:
Giacomo Bernini
committed
# Version of the API used in the response.
# type: string
# maximum: 1
# minimum: 1
# schema:
# $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription"
# 400:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
Giacomo Bernini
committed
# 401:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
Giacomo Bernini
committed
# 403:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
# 404:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
Giacomo Bernini
committed
# 405:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
Giacomo Bernini
committed
# 406:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
# 422:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
Giacomo Bernini
committed
# 500:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
Giacomo Bernini
committed
# 503:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
Giacomo Bernini
committed
# 504:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
Giacomo Bernini
committed
#
# delete:
Giacomo Bernini
committed
# Terminate Subscription.
# This method terminates an individual subscription.
# This method shall follow the provisions specified in the tables 6.4.8.3.5-1 and 6.4.8.3.5-2
# for URI query parameters, request and response data structures, and response codes.
# 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.
# parameters:
# - name: Authorization
Giacomo Bernini
committed
# The authorization token for the request.
# Reference: IETF RFC 7235
# in: header
# required: false
# type: string
# - name: Version
Giacomo Bernini
committed
# Version of the API requested to use when responding to this request.
# in: header
# required: true
# type: string
# responses:
# 204:
Giacomo Bernini
committed
# 204 NO CONTENT
#
# Shall be returned when the "Individual subscription" resource has been deleted successfully.
# The response body shall be empty.
# headers:
# WWW-Authenticate:
Giacomo Bernini
committed
# Challenge if the corresponding HTTP request has not provided
# authorization, or error details if the corresponding HTTP
# request has provided an invalid authorization token.
# type: string
# maximum: 1
# minimum: 0
# Version:
Giacomo Bernini
committed
# Version of the API used in the response.
# type: string
# maximum: 1
# minimum: 1
# 400:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
Giacomo Bernini
committed
# 401:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
Giacomo Bernini
committed
# 403:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
# 404:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
Giacomo Bernini
committed
# 405:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
Giacomo Bernini
committed
# 406:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
# 422:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
Giacomo Bernini
committed
# 500:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
Giacomo Bernini
committed
# 503:
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
Giacomo Bernini
committed
# 504:
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
components:
parameters:
PmJobId:
name: pmJobId
in: path
description: |
Identifier of the PM job.
This identifier can be retrieved from the resource referenced by the
"Location" HTTP header in the response to a POST request creating a
new "Individual PM job" resource. It can also be retrieved from the "id"
attribute in the payload body of that response.
required: true
style: simple
explode: false
schema:
type: string
ReportId:
name: reportId
in: path
description: |
Identifier of the performance report.
required: true
style: simple
explode: false
schema:
type: string
ThresholdId:
name: thresholdId
in: path
description: |
Identifier of the threshold.
This identifier can be retrieved from the resource referenced by the
"Location" HTTP header in the response to a POST request creating a
new "Individual threshold" resource. It can also be retrieved from the "id"
attribute in the payload body of that response.
required: true
style: simple
explode: false
schema:
type: string
requestBodies:
CreatePmJobRequest:
description: The VNF creation parameters
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest"
required: true
CreateThresholdRequest:
description: Request parameters to create a threshold resource.
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest"
required: true
responses:
PMJobs.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.5.2.7.
The HTTP response shall include a "Location" HTTP header that points to the created
"Individual PM job" resource.
headers:
Location:
description: The resource URI of the created PM Job
style: simple
explode: false
schema:
type: string
format: url
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:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"
PMJobs.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.5.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 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:
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
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
Version:
description: The used API version.
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:
application/json:
schema:
type: array
items:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"
IndividualPMJob.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.5.2.7.
headers:
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
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
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob"
IndividualPMJob.Patch.200:
description: |
200 OK
Shall be returned when the request has been processed successfully.
The response body shall contain a data structure of type "PmJobModifications".
headers:
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
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
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications"
IndividualPMJob.Delete.200:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualPerformanceReport.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.5.2.10.
headers:
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
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
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/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.5.2.9.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the
created threshold resource.
headers:
Location:
description: TThe resource URI of the created VNF instance
style: simple
explode: false
schema:
type: string
format: url
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
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
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold"
Thresholds.Get.200:
description: |
200 OK
Shall be returned when information about zero or more thresholds has been queried successfully.
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.
The response body shall contain in an array the representations of zero or more thresholds,
as defined in clause 6.5.2.9.
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:
Location:
description: The resource URI of the created VNF instance
style: simple
explode: false
schema:
type: string
format: url
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
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
Version:
description: The used API version.
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:
application/json:
schema:
type: array
items:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold"
IndividualThreshold.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.5.2.9.
headers:
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
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
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold"
IndividualThreshold.Patch.200:
description: |
200 OK
Shall be returned when the request has been processed successfully.
The response body shall contain a data structure of type "ThresholdModifications".
headers:
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
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
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications"
IndividualThreshold.Delete.200:
description: |
204 NO CONTENT
The threshold was 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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string