Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
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 V0.8.0
url: https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL009ed331_MANO_mgmt_stage_3/NFV-SOL009ed331v080.zip
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/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/CreatePMJobRequest"
responses:
"201":
$ref: "#/components/responses/pm_jobs.post.201"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/responses/504
get:
description: >
The client can use this method to retrieve information about PM jobs.
parameters:
- $ref: "#/components/parameters/filter.PmJob"
- $ref: "#/components/parameters/all_fields"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/exclude_fields"
- $ref: "#/components/parameters/exclude_default.PmJob"
- $ref: "#/components/parameters/nextpage_opaque_marker"
- $ref: "#/components/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/pm_jobs.get.200"
"400":
$ref: "#/components/responses/pm_jobs.get.400"
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/responses/504
/pm_jobs/{pmJobId}:
get:
description: >
The client can use this method for reading an individual PM job.
parameters:
- $ref: "#/components/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/pm_job.get.200"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/responses/504
delete:
description: >
This method terminates an individual PM job.
parameters:
- $ref: "#/components/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"204":
$ref: "#/components/responses/pm_job.delete.204"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/responses/504
/pm_jobs/{pmJobId}/reports/{reportId}:
get:
description: >
The client can use this method for reading an individual
performance report.
parameters:
- $ref: "#/components/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/pm_job.report.get.200"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/responses/504
/thresholds:
post:
description: >
The POST method can be used by the client to create a threshold.
parameters:
- $ref: "#/components/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/CreateThesholdRequest"
responses:
"201":
$ref: "#/components/responses/thresholds.post.201"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/responses/504
get:
description: >
The client can use this method to query information about thresholds.
parameters:
- $ref: "#/components/parameters/filter.Threshold"
- $ref: "#/components/parameters/nextpage_opaque_marker"
- $ref: "#/components/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/thresholds.get.200"
"400":
$ref: "#/components/responses/thresholds.get.400"
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/responses/504
/thresholds/{thresholdId}:
get:
description: >
The client can use this method for reading an individual threshold
parameters:
- $ref: "#/components/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/threshold.get.200"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/responses/504
delete:
description: >
This method allows to delete a threshold.
parameters:
- $ref: "#/components/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"204":
$ref: "#/components/responses/threshold.delete.204"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/responses/504
/subscriptions:
post:
description: >
The POST method creates a new subscription.
parameters:
- $ref: "#/components/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/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: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/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/parameters/nextpage_opaque_marker"
- $ref: "#/components/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/subscriptions.get.200"
"400":
$ref: "#/components/responses/subscriptions.get.400"
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/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/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"200":
$ref: "#/components/responses/subscription.get.200"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/responses/504
delete:
description: >
This method terminates an individual subscription.
parameters:
- $ref: "#/components/parameters/Version"
- $ref: "#/components/parameters/Accept"
- $ref: "#/components/parameters/Authorization"
responses:
"204":
$ref: "#/components/responses/subscription.delete.204"
"400":
$ref: ../responses/SOL009_resp.yaml#/responses/400
"401":
$ref: ../responses/SOL009_resp.yaml#/responses/401
"403":
$ref: ../responses/SOL009_resp.yaml#/responses/403
"404":
$ref: ../responses/SOL009_resp.yaml#/responses/404
"405":
$ref: ../responses/SOL009_resp.yaml#/responses/405
"406":
$ref: ../responses/SOL009_resp.yaml#/responses/406
"422":
$ref: ../responses/SOL009_resp.yaml#/responses/422
"500":
$ref: ../responses/SOL009_resp.yaml#/responses/500
"503":
$ref: ../responses/SOL009_resp.yaml#/responses/503
"504":
$ref: ../responses/SOL009_resp.yaml#/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_comps.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_comps.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_comps.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_comps.yaml#/components/schemas/Uri"
self:
description: >
URI of this resource.
$ref: "../components/SOL009_comps.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_comps.yaml#/components/schemas/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"ThresholdCrossedNotification" for this notification type.
$ref: "../components/SOL009_comps.yaml#/components/schemas/String"
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../components/SOL009_comps.yaml#/components/schemas/Identifier"
timeStamp:
description: >
Date and time of the generation of the notification.
$ref: "../components/SOL009_comps.yaml#/components/schemas/DateTime"
thresholdId:
description: >
Identifier of the threshold which has been crossed.
$ref: "../components/SOL009_comps.yaml#/components/schemas/Identifier"
crossingDirection:
description: >
An indication of whether the threshold was crossed in upward or downward direction.
$ref: "../components/SOL009_comps.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_comps.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_comps.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_comps.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_comps.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.
_links:
description: >
Links to resources related to this notification.
type: object
properties:
subscription:
description: >
Link to the related subscription.
$ref: "../components/SOL009_comps.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_comps.yaml#/components/schemas/NotificationLink"
threshold:
description: >
Link to the resource that represents the threshold that was crossed.
$ref: "../components/SOL009_comps.yaml#/components/schemas/NotificationLink"
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
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_comps.yaml#/components/schemas/Identifier"
notificationType:
description: >
Discriminator for the different notification types.
Shall be set to "PerformanceInformationAvailableNotification" for this
notification type.
$ref: "../components/SOL009_comps.yaml#/components/schemas/String"
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../components/SOL009_comps.yaml#/components/schemas/Identifier"
timeStamp:
description: >
Date and time of the generation of the notification.
$ref: "../components/SOL009_comps.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_comps.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_comps.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_comps.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_comps.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_comps.yaml#/components/schemas/NotificationLink"
pmJob:
description: >
Link to the resource that represents the PM job for which performance
information is available.
$ref: "../components/SOL009_comps.yaml#/components/schemas/NotificationLink"
PerformanceReport:
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_comps.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.
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
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_comps.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_comps.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.
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
841
842
id:
description: >
Identifier of this PM job.
$ref: "../components/SOL009_comps.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_comps.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_comps.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_comps.yaml#/components/schemas/Uri"
readyTime:
description: >
The time when the report was made available.
$ref: "../components/SOL009_comps.yaml#/components/schemas/DateTime"
expiryTime:
description: >
The time when the report will expire.
$ref: "../components/SOL009_comps.yaml#/components/schemas/DateTime"
fileSize:
description: >
The size of the report file in bytes, if known.
$ref: "../components/SOL009_comps.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_comps.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_comps.yaml#/components/schemas/Link"
required:
- self
- id
- objectType
- objectInstanceIds
- criteria
- _links
CreateThresholdRequest :
description: >
This type represents a request to create a threshold.
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
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_comps.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_comps.yaml#/components/schemas/IdentifierInManoEntity"
criteria:
description: >
Criteria that define this threshold.
$ref: "#/components/schemas/ThresholdCriteria"
- objectType
- objectInstanceId
- criteria
Threshold:
description: >
type: object
properties:
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
id:
description: >
Identifier of this threshold resource.
$ref: "../components/SOL009_comps.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_comps.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_comps.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_comps.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_comps.yaml#/components/schemas/Link"
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_comps.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_comps.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_comps.yaml#/components/schemas/DateTime"
value: