NFVManoPerformanceManagement.yaml 75.2 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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:
Giacomo Bernini's avatar
Giacomo Bernini committed
19
20
  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
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

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:
43
44
45
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
46
47
48
49
50
51
      requestBody:
        $ref: "#/components/requestBodies/CreatePMJobRequest"
      responses:
        "201": 
          $ref: "#/components/responses/pm_jobs.post.201"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
52
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
53
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
54
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
55
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
56
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
57
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
58
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
59
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
60
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
61
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
62
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
63
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
64
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
65
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
66
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
67
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
68
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
69
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
70
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
71
72
73
74
75
    get:
      description: >
        The client can use this method to retrieve information about PM jobs.
      parameters:
        - $ref: "#/components/parameters/filter.PmJob"
76
77
78
        - $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"
79
        - $ref: "#/components/parameters/exclude_default.PmJob"
80
81
82
83
        - $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"
84
85
86
87
88
89
      responses:
        "200": 
          $ref: "#/components/responses/pm_jobs.get.200"
        "400": 
          $ref: "#/components/responses/pm_jobs.get.400"
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
90
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
91
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
92
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
93
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
94
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
95
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
96
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
97
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
98
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
99
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
100
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
101
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
102
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
103
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
104
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
105
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
106
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
107
108

  /pm_jobs/{pmJobId}:
Giacomo Bernini's avatar
Giacomo Bernini committed
109
110
    parameters:
      - $ref: "#/components/parameters/pmJobId"
111
112
113
114
    get:
      description: >
        The client can use this method for reading an individual PM job. 
      parameters:
115
116
117
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
118
119
120
121
      responses:
        "200": 
          $ref: "#/components/responses/pm_job.get.200"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
122
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
123
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
124
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
125
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
126
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
127
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
128
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
129
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
130
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
131
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
132
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
133
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
134
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
135
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
136
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
137
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
138
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
139
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
140
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
141
142
143
144
    delete:
      description: >
        This method terminates an individual PM job.
      parameters:
145
146
147
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
148
149
150
151
      responses:
        "204": 
          $ref: "#/components/responses/pm_job.delete.204"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
152
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
153
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
154
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
155
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
156
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
157
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
158
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
159
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
160
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
161
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
162
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
163
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
164
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
165
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
166
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
167
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
168
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
169
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
170
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
171
172
  
  /pm_jobs/{pmJobId}/reports/{reportId}:
Giacomo Bernini's avatar
Giacomo Bernini committed
173
174
175
    parameters:
      - $ref: "#/components/parameters/pmJobId"
      - $ref: "#/components/parameters/reportId"
176
177
178
179
180
    get:
      description: >
        The client can use this method for reading an individual 
        performance report. 
      parameters:
181
182
183
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
184
185
186
187
      responses:
        "200": 
          $ref: "#/components/responses/pm_job.report.get.200"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
188
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
189
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
190
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
191
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
192
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
193
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
194
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
195
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
196
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
197
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
198
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
199
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
200
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
201
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
202
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
203
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
204
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
205
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
206
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
207
208
209
210
211
212

  /thresholds:
    post:
      description: >
        The POST method can be used by the client to create a threshold.
      parameters:
213
214
215
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
216
217
218
219
220
221
      requestBody:
        $ref: "#/components/requestBodies/CreateThesholdRequest"
      responses:
        "201": 
          $ref: "#/components/responses/thresholds.post.201"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
222
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
223
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
224
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
225
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
226
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
227
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
228
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
229
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
230
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
231
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
232
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
233
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
234
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
235
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
236
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
237
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
238
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
239
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
240
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
241
242
243
244
245
    get:
      description: >
        The client can use this method to query information about thresholds.
      parameters:
        - $ref: "#/components/parameters/filter.Threshold"
246
247
248
249
        - $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"
250
251
252
253
254
255
      responses:
        "200": 
          $ref: "#/components/responses/thresholds.get.200"
        "400": 
          $ref: "#/components/responses/thresholds.get.400"
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
256
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
257
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
258
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
259
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
260
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
261
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
262
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
263
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
264
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
265
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
266
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
267
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
268
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
269
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
270
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
271
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
272
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
273
274
    
  /thresholds/{thresholdId}:
Giacomo Bernini's avatar
Giacomo Bernini committed
275
276
    parameters:
      - $ref: "#/components/parameters/thresholdId"
277
278
279
280
    get:
      description: >
        The client can use this method for reading an individual threshold 
      parameters:
281
282
283
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
284
285
286
287
      responses:
        "200": 
          $ref: "#/components/responses/threshold.get.200"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
288
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
289
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
290
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
291
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
292
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
293
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
294
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
295
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
296
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
297
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
298
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
299
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
300
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
301
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
302
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
303
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
304
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
305
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
306
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
307
308
309
310
    delete:
      description: >
        This method allows to delete a threshold.
      parameters:
311
312
313
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
314
315
316
317
      responses:
        "204": 
          $ref: "#/components/responses/threshold.delete.204"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
318
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
319
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
320
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
321
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
322
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
323
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
324
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
325
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
326
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
327
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
328
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
329
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
330
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
331
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
332
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
333
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
334
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
335
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
336
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
337
338
339
340
341
342

  /subscriptions:
    post:
      description: >
        The POST method creates a new subscription.
      parameters:
343
344
345
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
346
347
348
349
350
351
352
353
      requestBody:
        $ref: "#/components/requestBodies/CreateSubscriptionRequest"
      responses:
        "201": 
          $ref: "#/components/responses/subscriptions.post.201"
        "303": 
          $ref: "#/components/responses/subscriptions.post.303"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
354
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
355
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
356
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
357
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
358
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
359
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
360
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
361
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
362
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
363
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
364
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
365
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
366
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
367
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
368
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
369
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
370
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
371
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
372
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
373
374
375
376
377
378
    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"
379
380
381
382
        - $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"
383
384
385
386
387
388
      responses:
        "200": 
          $ref: "#/components/responses/subscriptions.get.200"
        "400": 
          $ref: "#/components/responses/subscriptions.get.400"
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
389
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
390
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
391
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
392
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
393
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
394
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
395
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
396
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
397
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
398
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
399
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
400
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
401
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
402
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
403
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
404
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
405
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
406
407

  /subscriptions/{subscriptionId}:
Giacomo Bernini's avatar
Giacomo Bernini committed
408
409
    parameters:
      - $ref: "#/components/parameters/subscriptionId"
410
411
412
413
414
    get:
      description: >
        The client can use this method for reading an individual subscription 
        about performance management notifications subscribed by the client.
      parameters:
415
416
417
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
418
419
420
421
      responses:
        "200": 
          $ref: "#/components/responses/subscription.get.200"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
422
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
423
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
424
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
425
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
426
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
427
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
428
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
429
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
430
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
431
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
432
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
433
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
434
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
435
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
436
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
437
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
438
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
439
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
440
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
441
442
443
444
    delete:
      description: >
        This method terminates an individual subscription.
      parameters:
445
446
447
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
448
449
450
451
      responses:
        "204": 
          $ref: "#/components/responses/subscription.delete.204"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
452
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
453
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
454
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
455
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
456
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
457
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
458
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
459
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
460
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
461
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
462
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
463
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
464
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
465
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
466
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
467
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
468
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
469
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
470
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487

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.
488
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
489
490
491
492
493
494
495
        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.
496
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"
497
498
499
500
501
502
503
504
505
506
507
      required:
        - callbackUri

    PmSubscription:
      description: >
        This type represents a subscription. 
      type: object
      properties:
        id:
          description: >
            Identifier that identifies the subscription
508
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
509
510
511
512
513
514
515
516
517
518
519
520
521
522
        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.
523
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
524
525
526
            self:
              description: >
                URI of this resource.
527
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
          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.
551
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
552
553
554
555
        notificationType:
          description: >
            Discriminator for the different notification types. Shall be set to 
            "ThresholdCrossedNotification" for this notification type.
556
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
557
558
559
        subscriptionId:
          description: >  
            Identifier of the subscription that this notification relates to.
560
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
561
562
563
        timeStamp:
          description: >
            Date and time of the generation of the notification.
564
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
565
566
567
        thresholdId:
          description: >
            Identifier of the threshold which has been crossed.
568
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
569
570
571
        crossingDirection:
          description: >
            An indication of whether the threshold was crossed in upward or downward direction.
572
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/CrossingDirectionType"
573
574
575
576
        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.
577
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
578
579
580
581
582
        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 
583
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
584
585
586
587
588
        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.
589
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
590
591
592
593
594
        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
595
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
596
597
598
599
600
        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.
Giacomo Bernini's avatar
Giacomo Bernini committed
601
602
603
604
605
        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"
606
607
608
609
610
611
612
613
        _links:
          description: >
            Links to resources related to this notification.
          type: object
          properties:
            subscription:
              description: >
                Link to the related subscription. 
614
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
615
616
617
618
619
            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.
620
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
621
            threshold:
622
623
              description: >
                Link to the resource that represents the threshold that was crossed.
624
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
          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.
651
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
652
653
654
655
656
        notificationType:
          description: >
            Discriminator for the different notification types. 
            Shall be set to "PerformanceInformationAvailableNotification" for this 
            notification type.
657
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
658
659
660
        subscriptionId:
          description: >
            Identifier of the subscription that this notification relates to.
661
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
662
663
664
        timeStamp:
          description: >
            Date and time of the generation of the notification.
665
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
666
667
668
669
670
        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.
671
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
672
673
674
675
676
        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 
677
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
678
679
680
681
682
683
684
        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.
685
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
686
687
688
689
690
691
692
693
        _links:
          description: >
            Links to resources related to this notification.
          type: object
          properties:
            subscription:
              description: >
                Link to the related subscription. 
694
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
695
696
697
698
699
            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. 
700
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
701
702
703
704
            pmJob:
              description: >
                Link to the resource that represents the PM job for which performance 
                information is available.
705
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
706
            PerformanceReport:
707
708
709
710
              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. 
711
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
          required:
            - subscription
            - pmJob
            - performanceReport
      required:
        - id
        - notificationType
        - subscriptionId
        - timeStamp
        - objectType
        - objectInstanceId
        - _links

    CreatePmJobRequest:
      description: >
727
        This type represents a request to create a PM job. 
728
729
      type: object
      properties:
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
        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:
745
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
746
747
748
749
750
751
752
753
754
755
756
757
758
759
          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:
760
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
761
762
763
764
        criteria:
          description: >
            Criteria of the collection of performance information.
          $ref: "#/components/schemas/PmJobCriteria"
765
      required:
766
767
768
        - objectType
        - objectInstanceIds
        - criteria
769
770
771

    PmJob:
      description: >
772
        This type represents a PM job. 
773
774
      type: object
      properties:
775
776
777
        id:
          description: >
            Identifier of this PM job.
778
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
779
780
781
782
783
784
785
786
787
788
789
790
791
        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:
792
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
793
794
795
796
797
798
799
800
801
802
803
804
805
806
          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:
807
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
808
809
810
811
812
813
814
815
816
817
818
819
820
821
        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.
822
                $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
823
824
825
              readyTime:
                description: >
                  The time when the report was made available.
826
                $ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
827
828
829
              expiryTime:
                description: >
                  The time when the report will expire.
830
                $ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
831
832
833
              fileSize:
                description: >
                  The size of the report file in bytes, if known.
834
                $ref: "../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
835
836
837
838
839
840
841
842
843
844
845
            required:
              - href
              - readyTime
        _links:
          description: >
            Links for this resource.
          type: object
          properties:
            self:
              description: >
                  URI of this resource.
846
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
847
848
849
850
851
852
853
            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:
854
                $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
855
856
          required:
            - self
857
      required:
858
859
860
861
862
        - id
        - objectType
        - objectInstanceIds
        - criteria
        - _links
863
864
865

    CreateThresholdRequest :
      description: >
866
        This type represents a request to create a threshold. 
867
868
      type: object
      properties:
869
870
871
872
873
874
875
876
877
878
879
        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.
880
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
881
882
883
884
885
886
887
888
889
890
891
        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:
892
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
893
894
895
896
        criteria:
          description: >
            Criteria that define this threshold.
          $ref: "#/components/schemas/ThresholdCriteria"
897
      required:
898
899
900
        - objectType
        - objectInstanceId
        - criteria
901
902
903
904
905
906

    Threshold:
      description: >

      type: object
      properties:
907
908
909
        id:
          description: >
            Identifier of this threshold resource.
910
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
911
912
913
914
915
916
917
918
919
920
921
        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.
922
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
923
924
925
926
927
928
929
930
931
932
933
        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:
934
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
935
936
937
938
939
940
941
942
943
944
945
946
        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.
947
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
948
949
950
951
952
            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.
953
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"
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
          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.