Newer
Older
title: SOL005 - NS Performance Management Interface
description: |
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to. In case of
discrepancies the published ETSI Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues
contact:
name: NFV-SOL WG
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
description: ETSI GS NFV-SOL 005 V3.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.05.01_60/gs_nfv-sol005v030501p.pdf
servers:
- url: http://127.0.0.1/nspm/v2
- url: https://127.0.0.1/nspm/v2
moscatelli
committed
###############################################################################
# API Versions #
###############################################################################
moscatelli
committed
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
moscatelli
committed
moscatelli
committed
###############################################################################
# PM Jobs #
###############################################################################
rameshnaraya
committed
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.2
moscatelli
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
rameshnaraya
committed
post:
The POST method creates a PM job. See clause 7.4.2.3.1.
requestBody:
$ref: '#/components/requestBodies/CreatePmJobRequest'
moscatelli
committed
responses:
rameshnaraya
committed
201:
$ref: '#/components/responses/PmJobs.Post.201'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: '#/components/responses/PmJobs.Post.422'
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
rameshnaraya
committed
get:
The API consumer can use this method to retrieve information about PM jobs. See clause 7.4.2.3.2.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
- $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
rameshnaraya
committed
responses:
$ref: '#/components/responses/PmJobs.Get.200'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
moscatelli
committed
###############################################################################
# Individual PM job #
###############################################################################
rameshnaraya
committed
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.3
parameters:
- $ref: '#/components/parameters/PmJobId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
rameshnaraya
committed
get:
The API consumer can use this method for reading an individual PM job. See clause 7.4.3.3.2.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
rameshnaraya
committed
responses:
200:
$ref: '#/components/responses/IndividualPmJob.Get.200'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
This method allows to modify an "individual PM job" resource. See clause 7.4.3.3.4.
- $ref: '#/components/parameters/ContentTypeMergePatchJSON'
requestBody:
$ref: '#/components/requestBodies/PmJobModifications'
$ref: '#/components/responses/IndividualPmJob.Patch.200'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: '#/components/responses/IndividualPmJob.Patch.412'
$ref: '#/components/responses/IndividualPmJob.Patch.422'
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
rameshnaraya
committed
delete:
This method terminates an individual PM job. See clause 7.4.3.3.5.
rameshnaraya
committed
responses:
204:
$ref: '#/components/responses/IndividualPmJob.Delete.204'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
rameshnaraya
committed
moscatelli
committed
###############################################################################
# Individual performance report #
###############################################################################
/pm_jobs/{pmJobId}/reports/{reportId}:
rameshnaraya
committed
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.4
parameters:
- $ref: '#/components/parameters/PmJobId'
- $ref: '#/components/parameters/ReportId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
rameshnaraya
committed
get:
The API consumer can use this method for reading an individual performance
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
rameshnaraya
committed
responses:
200:
$ref: '#/components/responses/IndividualPerformanceReport.Get.200'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
rameshnaraya
committed
moscatelli
committed
###############################################################################
# Thresholds #
###############################################################################
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.5
moscatelli
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
rameshnaraya
committed
post:
The POST method can be used by the API consumer to create
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/CreateThresholdRequest'
rameshnaraya
committed
responses:
201:
$ref: '#/components/responses/Thresholds.Post.201'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: '#/components/responses/Thresholds.Post.422'
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
The API consumer can use this method to query information about thresholds. See clause 7.4.5.3.2.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
responses:
200:
$ref: '#/components/responses/Thresholds.Get.200'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
moscatelli
committed
###############################################################################
# Individual threshold #
###############################################################################
/thresholds/{thresholdId}:
moscatelli
committed
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.6
parameters:
- $ref: '#/components/parameters/ThresholdId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
rameshnaraya
committed
get:
The API consumer can use this method for reading an individual
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
rameshnaraya
committed
responses:
200:
$ref: '#/components/responses/IndividualThreshold.Get.200'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
This method allows to modify an "Individual threshold" resource. See clause 7.4.6.3.4.
rameshnaraya
committed
parameters:
- $ref: '#/components/parameters/ContentTypeMergePatchJSON'
requestBody:
$ref: '#/components/requestBodies/ThresholdModifications'
rameshnaraya
committed
responses:
200:
$ref: '#/components/responses/IndividualThreshold.Patch.200'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: '#/components/responses/IndividualThreshold.Patch.412'
$ref: '#/components/responses/IndividualThreshold.Patch.422'
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
rameshnaraya
committed
delete:
This method allows to delete a threshold. See clause 7.4.6.3.5.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
rameshnaraya
committed
responses:
204:
$ref: '#/components/responses/IndividualThreshold.Delete.204'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
moscatelli
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
moscatelli
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
###############################################################################
# Subscriptions #
###############################################################################
# '/subscriptions':
# #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.7
# parameters:
# - name: Authorization
# The authorization token for the request.
# Reference: IETF RFC 7235.
# in: header
# required: false
# type: string
# - name: Version
# Version of the API requested to use when responding to this request.
# in: header
# required: true
# type: string
#
# post:
# summary: Subscribe to PM notifications.
# The POST method creates a new subscription.
# This method shall follow the provisions specified in the Tables 7.4.7.3.1-1 and 7.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 shall exist as defined
# in clause 7.4.8. This method shall not trigger any notification.
# Creation of two subscription resources with the same callbackURI and the same filter can result in performance
# degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases.
# Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the
# same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide
# to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing
# the existing subscription resource with the same filter and callbackUri)
# parameters:
# - name: Accept
# Content-Types that are acceptable for the response.
# Reference: IETF RFC 7231.
# in: header
# required: true
# type: string
# - name: Content-Type
# The MIME type of the body of the request.
# Reference: IETF RFC 7231.
# in: header
# required: true
# type: string
# - name: body
# in: body
# required: true
# schema:
# $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscriptionRequest"
# Details of the subscription to be created.
# responses:
# 201:
# 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 7.5.2.3.
# The HTTP response shall include a "Location" HTTP
# header that contains the resource URI of the created subscription resource.
# schema:
# $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscription"
# headers:
# Content-Type:
# type: string
# The MIME type of the body of the response.This header
# field shall be present if the response has a non-empty message
# body.
# maximum: 1
# minimum: 1
# WWW-Authenticate:
# type: string
# Challenge if the corresponding HTTP request has not provided
# authorization, or error details if the corresponding HTTP request
# has provided an invalid authorization token.
# maximum: 1
# minimum: 0
# Version:
# Version of the API used in the response.
# type: string
# maximum: 1
# minimum: 1
# 303:
# $ref: "../responses/SOL005_resp.yaml#/components/responses/303"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
#
# get:
# summary: Query PM related subscriptions.
# The 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 7.4.7.3.2-1 and 7.4.7.3.2-2 for URI query parameters,
# request and response data structures, and response codes.
# parameters:
# - name: filter
# in: query
# required: false
# type: string
# Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
# The NFVO shall support receiving this parameter as part of the URI query string.
# The OSS/BSS may supply this parameter.
# All attribute names that appear in the PmSubscription and in data types referenced from it
# shall be supported by the NFVO in the filter expression.
# - name: nextpage_opaque_marker
# in: query
# required: false
# type: string
# Marker to obtain the next page of a paged response. Shall be supported by the NFVO
# if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of
# ETSI GS NFV-SOL 013 for this resource.
# - name: Accept
# Content-Types that are acceptable for the response.
# Reference: IETF RFC 7231.
# in: header
# required: true
# type: string
# responses:
# 200:
# 200 OK
#
# Shall be returned when the list of subscriptions has
# been queried successfully.
# The response body shall contain the representations of
# all active subscriptions of the functional block that
# invokes the method, as defined in clause 7.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 NFVO supports alternative 2 (paging) according to
# clause 5.4.2.1 of ETSI GS NFV SOL 013 for this resource,
# inclusion of the Link HTTP header in this response shall
# follow the provisions in clause 5.4.2.3 of
# ETSI GS NFV SOL 013.
#
# headers:
# Content-Type:
# description: The MIME type of the body of the response.
# type: string
# maximum: 1
# minimum: 1
# WWW-Authenticate:
# type: string
# Challenge if the corresponding HTTP request has not provided
# authorization, or error details if the corresponding HTTP request
# has provided an invalid authorization token.
# maximum: 1
# minimum: 0
# Version:
# Version of the API used in the response.
# type: string
# maximum: 1
# minimum: 1
# Link:
# 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/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscription"
# 400:
# $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
###############################################################################
# Individual subscription #
###############################################################################
# '/subscriptions/{subscriptionId}':
# #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.8
# parameters:
# - name: subscriptionId
# Identifier of the subscription.
# This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
# to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the
# payload body of that response.
# in: path
# type: string
# required: true
# - name: Authorization
# The authorization token for the request.
# Reference: IETF RFC 7235
# in: header
# required: true
# type: string
# - name: Version
# Version of the API requested to use when responding to this request.
# in: header
# required: true
# type: string
#
# get:
# summary: Query a single PM related subscription.
# 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 7.4.8.3.2-1 and 7.4.8.3.2-2 for URI query parameters,
# request and response data structures, and response codes.
# parameters:
# - name: Accept
# Content-Types that are acceptable for the response.
# Reference: IETF RFC 7231
# in: header
# required: true
# type: string
# responses:
# 200:
# 200 OK
#
# Shall be returned when the subscription has been read successfully.
# The response body shall contain a representation of
# the subscription resource, as defined in clause 7.5.2.3.
# schema:
# $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscription"
# headers:
# Content-Type:
# type: string
# The MIME type of the body of the response.This header
# field shall be present if the response has a non-empty message
# body.
# WWW-Authenticate:
# type: string
# Challenge if the corresponding HTTP request has not provided
# authorization, or error details if the corresponding HTTP request
# has provided an invalid authorization token.
# maximum: 1
# minimum: 0
# Version:
# Version of the API used in the response.
# type: string
# maximum: 1
# minimum: 1
# 400:
# $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
#
# delete:
# summary: Terminate a subscription.
# This method terminates an individual subscription.
# This method shall follow the provisions specified in the
# Tables 7.4.8.3.5-1 and 7.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: Accept
# Content-Types that are acceptable for the response.
# Reference: IETF RFC 7231.
# in: header
# required: true
# type: string
# responses:
# 204:
# 204 NO CONTENT
#
# Shall be returned when the subscription resource has been
# deleted successfully.
# The response body shall be empty.
# headers:
# WWW-Authenticate:
# type: string
# Challenge if the corresponding HTTP request has not provided
# authorization, or error details if the corresponding HTTP request
# has provided an invalid authorization token.
# maximum: 1
# minimum: 0
# Version:
# Version of the API used in the response.
# type: string
# maximum: 1
# minimum: 1
# 400:
# $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
# $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
components:
parameters:
ContentTypeMergePatchJSON:
name: Content-Type
in: header
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
required: true
schema:
type: string
enum:
- application/merge-patch+json
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 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 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/SOL005NSPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest"
required: true
PmJobModifications:
content:
application/json:
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJobModifications"
required: true
CreateThresholdRequest:
description: |
Request parameters to create a new "Individual threshold" resource.
content:
application/json:
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest"
required: true
ThresholdModifications:
content:
application/json:
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/ThresholdModifications"
required: true
responses:
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
description: |
201 CREATED
Shall be returned when the "Individual PM job" has been created successfully.
The response body shall contain a representation of
the created PM job resource, as defined in clause 7.5.2.7.
The HTTP response shall include a "Location" HTTP
header that points to the created "Individual PM job" resource.
headers:
Content-Type:
description: |
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message body.
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: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"
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
PmJobs.Post.422:
description: |
422 Unprocessable Entity
content type of the payload body is supported and the payload body of a request contains syntactically correct
data but the data cannot be processed.
The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
including rules for the presence of the response body.
Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested
the Notification endpoint as described in clause 7.4.9.3.2 and the test has failed.
In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information about
the error
headers:
Content-Type:
description: |
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message body.
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: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
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
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 7.5.2.7.
If the "filter" URI parameter or one of the "all_fields", "fields", "include_fields",
"exclude_fields" or "exclude_default" URI parameters was supplied in the request and is
supported, 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 NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of
ETSI GS NFV SOL 013 for this resource, inclusion of the Link HTTP header
in this response shall follow the provisions in clause 5.4.2.3 of
ETSI GS NFV SOL 013.
headers:
Content-Type:
description: |
The MIME type of the body of the request. 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: |
Version of the API used in the response.
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/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"
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
description: |
200 OK
Shall be returned when information about an individual
PM job has been queried successfully.
The response body shall contain a representation of
the "Individual PM job resource", as defined in clause 7.5.2.7.
headers:
Content-Type:
description: |
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message body.
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: |