Newer
Older
openapi: 3.0.2
info:
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
title: SOL009 - NFV-MANO Performance Management Interface
description: >
SOL009 - NFV-MANO 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 and has not been
approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact:
name: NFV-SOL WG
externalDocs:
description: ETSI GS NFV-SOL 009 V3.3.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf
servers:
- url: http://0.0.0.0/nfvmanopm/v1
description: >
API HTTP Server
- url: https://0.0.0.0/nfvmanopm/v1
description: >
API HTTPS Server
paths:
/api_versions:
$ref: ../endpoints/SOL009_endpoints.yaml#/endpoints/api_versions
/pm_jobs:
post:
description: >
Creates a PM job.
This method shall follow the provisions specified in the tables
6.5.3.3.1-1 and 6.5.3.3.1-2 for URI query parameters, request and
response data structures, and response codes.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/CreatePMJobRequest"
responses:
"201":
$ref: "#/components/responses/pm_jobs.post.201"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
get:
description: >
The client can use this method to retrieve information about PM jobs.
parameters:
- $ref: "#/components/parameters/filter.PmJob"
- $ref: "../components/SOL009_params.yaml#/components/parameters/all_fields"
- $ref: "../components/SOL009_params.yaml#/components/parameters/fields"
- $ref: "../components/SOL009_params.yaml#/components/parameters/exclude_fields"
- $ref: "#/components/parameters/exclude_default.PmJob"
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/pm_jobs.get.200"
"400":
$ref: "#/components/responses/pm_jobs.get.400"
"401":
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/pm_jobs/{pmJobId}:
get:
description: >
The client can use this method for reading an individual PM job.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/pm_job.get.200"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
delete:
description: >
This method terminates an individual PM job.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"204":
$ref: "#/components/responses/pm_job.delete.204"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/pm_jobs/{pmJobId}/reports/{reportId}:
get:
description: >
The client can use this method for reading an individual
performance report.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/pm_job.report.get.200"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/thresholds:
post:
description: >
The POST method can be used by the client to create a threshold.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/CreateThesholdRequest"
responses:
"201":
$ref: "#/components/responses/thresholds.post.201"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
get:
description: >
The client can use this method to query information about thresholds.
parameters:
- $ref: "#/components/parameters/filter.Threshold"
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/thresholds.get.200"
"400":
$ref: "#/components/responses/thresholds.get.400"
"401":
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/thresholds/{thresholdId}:
get:
description: >
The client can use this method for reading an individual threshold
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/threshold.get.200"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
delete:
description: >
This method allows to delete a threshold.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"204":
$ref: "#/components/responses/threshold.delete.204"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/subscriptions:
post:
description: >
The POST method creates a new subscription.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/CreateSubscriptionRequest"
responses:
"201":
$ref: "#/components/responses/subscriptions.post.201"
"303":
$ref: "#/components/responses/subscriptions.post.303"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
get:
description: >
The client can use this method to query the list of active subscriptions
to performance management notifications subscribed by the client.
parameters:
- $ref: "#/components/parameters/filter.PmSubscription"
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/subscriptions.get.200"
"400":
$ref: "#/components/responses/subscriptions.get.400"
"401":
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
/subscriptions/{subscriptionId}:
get:
description: >
The client can use this method for reading an individual subscription
about performance management notifications subscribed by the client.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/subscription.get.200"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
delete:
description: >
This method terminates an individual subscription.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"204":
$ref: "#/components/responses/subscription.delete.204"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
components:
schemas:
PmSubscriptionRequest:
description: >
This type represents a subscription request.
type: object
properties:
filter:
description: >
Filter settings for this subscription, to define the subset of all
notifications this subscription relates to. A particular notification
is sent to the subscriber if the filter matches, or if there is no filter.
$ref: "#/components/schemas/PmNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
authentication:
description: >
Authentication parameters to configure the use of Authorization when
sending notifications corresponding to this subscription, as defined
in clause 8.3.4 of ETSI GS NFV-SOL 013.
This attribute shall only be present if the subscriber requires authorization
of notifications.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"
required:
- callbackUri
PmSubscription:
description: >
This type represents a subscription.
type: object
properties:
id:
description: >
Identifier that identifies the subscription
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
filter:
description: >
Filter settings for this subscription, to define the subset of all
notifications this subscription relates to. A particular notification
is sent to the subscriber if the filter matches, or if there is no filter.
$ref: "#/components/schemas/PmNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
type: object
properties:
links:
description: >
Links to resources related to this resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
self:
description: >
URI of this resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
required:
- links
- self
required:
- id
- callbackUri
ThresholdCrossedNotification:
description: >
This type represents a notification that is sent when a threshold has been crossed.
NOTE: The timing of sending this notification is determined by the capability of
the producing entity to evaluate the threshold crossing condition.
The notification shall be triggered by the NFV-MANO functional entity when
a threshold has been crossed.
type: object
properties:
id:
description: >
Identifier of this notification. If a notification is sent multiple times due
to multiple subscriptions, the "id" attribute of all these notifications shall
have the same value.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"ThresholdCrossedNotification" for this notification type.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
timeStamp:
description: >
Date and time of the generation of the notification.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
thresholdId:
description: >
Identifier of the threshold which has been crossed.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
crossingDirection:
description: >
An indication of whether the threshold was crossed in upward or downward direction.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/CrossingDirectionType"
objectType:
description: >
Type of measured object.The applicable measured object type for a measurement
is defined in clause 8.2 of ETSI GS NFV-IFA 031.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
objectInstanceId:
description: >
Identifier of the measured object instance. This attribute shall contain the
identifier of the instance of the measure object according to their type.
See also definitions in clause 8.2 of ETSI GS NFV-IFA 031
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
subObjectInstanceId:
description: >
Identifier of the sub-object of the measured object to which the measurement
applies. Shall be present if this is required in clause 8.2 of ETSI GS NFV-IFA 031
for the related measured object type. Shall be absent otherwise.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
performanceMetric:
description: >
Performance metric associated with the threshold.
This attribute shall contain the related "Measurement Name" value as defined
in clause 8.4 of ETSI GS NFV-IFA 031
$ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
performanceValue:
description: >
Value of the metric that resulted in threshold crossing.
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"
_links:
description: >
Links to resources related to this notification.
type: object
properties:
subscription:
description: >
Link to the related subscription.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
objectInstance:
description: >
Link to the resource representing the measured object instance to which
the notified change applies. Shall be present if the measured object
instance information is accessible as a resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
description: >
Link to the resource that represents the threshold that was crossed.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
required:
- subscription
- objectInstance
required:
- id
- notificationType
- subscriptionId
- timeStamp
- thresholdId
- crossingDirection
- objectType
- objectInstanceId
- performanceMetric
- performanceValue
- _links
PerformanceInformationAvailableNotification:
description: >
This notification informs the receiver that performance information is available.
type: object
properties:
id:
description: >
Identifier of this notification. If a notification is sent multiple times due
to multiple subscriptions, the "id" attribute of all these notifications shall
have the same value.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
notificationType:
description: >
Discriminator for the different notification types.
Shall be set to "PerformanceInformationAvailableNotification" for this
notification type.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
timeStamp:
description: >
Date and time of the generation of the notification.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
objectType:
description: >
Type of measured object.
The applicable measured object type for a measurement is defined in clause 8.2
of ETSI GS NFV-IFA 031.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
objectInstanceId:
description: >
Type of measured object.
The applicable measured object type for a measurement is defined in clause 8.2
of ETSI GS NFV-IFA 031
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
subObjectInstanceId:
description: >
Identifier of the sub-object of the measured object instance for which the
measurements have been taken. Shall be present if the related PM job has been
set up to measure a sub-object instance of the measured object instance and a
sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031 for the related
measured object type. Shall be absent otherwise.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
_links:
description: >
Links to resources related to this notification.
type: object
properties:
subscription:
description: >
Link to the related subscription.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
objectInstance:
description: >
Link to the resource representing the measured object instance to which the
notification applies. Shall be present if the measured object instance
information is accessible as a resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
pmJob:
description: >
Link to the resource that represents the PM job for which performance
information is available.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
description: >
Link from which the available performance information of data type
"PerformanceReport" can be obtained.
This link should point to an "Individual performance report" resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
required:
- subscription
- pmJob
- performanceReport
required:
- id
- notificationType
- subscriptionId
- timeStamp
- objectType
- objectInstanceId
- _links
CreatePmJobRequest:
description: >
This type represents a request to create a PM job.
objectType:
description: >
Type of measured object. The applicable measured object type for a measurement
is defined in clause 8.2 of ETSI GS NFV-IFA 031.
type: string
objectInstanceIds:
description: >
Identifiers of the measured object instance for which performance information
is requested to be collected. This attribute shall contain the identifier of
the instance of the measure object according to their type.
See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
If more than one identifier is provided, values shall all refer to measured
object instances of the same type, for which the same criteria is then applicable.
type: array
items:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
minItems: 1
subObjectInstanceIds:
description: >
Identifiers of the sub-object instances of the measured object instance for
which performance information is requested to be collected.
May be present if a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031
for the related measured object type.
If this attribute is present, the cardinality of the "objectInstanceIds"
attribute shall be 1.
If this attribute is absent and a sub-object is defined in clause 8.2 of
ETSI GS NFV-IFA 031 for the related measured object type, measurements will
be taken for all sub-object instances of the measured object instance.
type: array
items:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
criteria:
description: >
Criteria of the collection of performance information.
$ref: "#/components/schemas/PmJobCriteria"
- objectType
- objectInstanceIds
- criteria
This type represents a PM job.
id:
description: >
Identifier of this PM job.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
objectType:
description: >
Type of measured object. The applicable measured object type for a measurement is
defined in clause 8.2 of ETSI GS NFV-IFA 031.
type: string
objectInstanceIds:
description: >
Identifiers of the measured object instance for which performance information
is collected. This attribute shall contain the identifier of the instance of
the measure object according to their type.
See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
type: array
items:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
minItems: 1
subObjectInstanceIds:
description: >
Identifiers of the sub-object instances of the measured object instance for
which performance information is requested to be collected.
May be present if a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031
for the related measured object type.
If this attribute is present, the cardinality of the "objectInstanceIds"
attribute shall be 1.
If this attribute is absent and a sub-object is defined in clause 8.2 of
ETSI GS NFV-IFA 031 for the related measured object type, measurements will
be taken for all sub-object instances of the measured object instance.
type: array
items:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
criteria:
description: >
Criteria of the collection of performance information.
$ref: "#/components/schemas/PmJobCriteria"
reports:
description: >
Information about available reports collected by this PM job.
type: array
items:
type: object
properties:
href:
description: >
The Uri where the report can be obtained.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
readyTime:
description: >
The time when the report was made available.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
expiryTime:
description: >
The time when the report will expire.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
fileSize:
description: >
The size of the report file in bytes, if known.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
required:
- href
- readyTime
_links:
description: >
Links for this resource.
type: object
properties:
self:
description: >
URI of this resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
objects:
description: >
Links to resources representing the measured object instances for which
performance information is collected. Shall be present if the measured
object instance information is accessible as a resource.
type: array
items:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
- id
- objectType
- objectInstanceIds
- criteria
- _links
CreateThresholdRequest :
description: >
This type represents a request to create a threshold.
objectType:
description: >
Type of measured object. The applicable measured object type for a measurement
is defined in clause 8.2 of ETSI GS NFV-IFA 031.
type: string
objectInstanceId:
description: >
Identifier of the measured object instance associated with this threshold.
This attribute shall contain the identifier of the instance of the measure
object according to their type.
See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
subjObjectInstanceIds:
description: >
Identifiers of the sub-object instances of the measured object instance
associated with this threshold.
May be present if a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031
for the related measured object type.
If this attribute is absent and a sub-object is defined in clause 8.2 of ETSI
GS NFV-IFA 031 for the related measured object type, thresholds will be set
for all sub-object instances of the measured object instance.
type: array
items:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
criteria:
description: >
Criteria that define this threshold.
$ref: "#/components/schemas/ThresholdCriteria"
- objectType
- objectInstanceId
- criteria
Threshold:
description: >
type: object
properties:
id:
description: >
Identifier of this threshold resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
objectType:
description:
Type of measured object. The applicable measured object type for a measurement
is defined in clause 8.2 of ETSI GS NFV-IFA 031.
type: string
objectInstanceId:
description: >
Identifier of the measured object instance associated with the threshold.
This attribute shall contain the identifier of the instance of the measure
object according to their type.
See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
subjObjectInstanceIds:
description: >
Identifiers of the sub-object instances of the measured object instance
associated with this threshold.
May be present if a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031
for the related measured object type.
If this attribute is absent and a sub-object is defined in clause 8.2 of ETSI
GS NFV-IFA 031 for the related measured object type, thresholds are set for
all sub-object instances of the measured object instance.
type: array
items:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
criteria:
description: >
Criteria that define this threshold.
$ref: "#/components/schemas/ThresholdCriteria"
_links:
description: >
Links for this resource.
type: object
properties:
self:
description: >
URI for this resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
object:
description: >
Link to a resource representing the measured object instance for which performance
information is collected. Shall be present if the measured object instance information
is accessible as a resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
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
required:
- self
required:
- id
- objectType
- objectInstanceId
- subjObjectInstanceIds
- criteria
- _links
PerformanceReport:
description: >
This type defines the format of a performance report provided by the NFV-MANO functional
entity to the API consumer as a result of collecting performance information as part
of a PM job.
type: object
properties:
entries:
description: >
List of performance information entries. Each performance report entry is for a given
metric of a given object (i.e. measured object instance) corresponding to the related
measured object types, but can include multiple collected values.
type: array
items:
type: object
properties:
objectType:
description: >
Type of measured object. The applicable measured object type for a measurement is
defined in clause 8.2 of ETSI GS NFV-IFA 031.
type: string
objectInstanceId:
description: >
The object instance (i.e. measured object instance) for which the performance metric
is reported. This attribute shall contain the identifier of the instance of the
measure object according to their type.
See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference"
subObjectInstanceId:
description: >
Identifier of the sub-object instance of the measured object instance for which the
performance metric is reported. Shall be present if this is required in clause 8.2
of ETSI GS NFV-IFA 031 [1] for the related measured object type.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
performanceMetric:
description: >
Name of the metric collected. This attribute shall contain the related
"Measurement Name" value as defined in clause 8.4 of ETSI GS NFV-IFA 031.
type: string
performanceValues:
description: >
List of performance values with associated timestamp.
type: array
items:
type: object
properties:
timeStamp:
description: >
Time stamp indicating when the data was collected.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
value:
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"
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
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"
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
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"
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
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"
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
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"
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
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"
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729