Newer
Older
title: SOL003 - VNF Fault Management Notification interface
SOL003 - VNF Fault Management Notification interface
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to. In case of
discrepancies the published ETSI Group Specification takes precedence.
Giacomo Bernini
committed
Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
contact:
name: NFV-SOL WG
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
Michele Carignani
committed
externalDocs:
description: ETSI GS NFV-SOL 003 V3.3.4
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf
servers:
- url: http://127.0.0.1/callback/v1
- url: https://127.0.0.1/callback/v1
###############################################################################
# Notification endpoint AlarmNotification #
###############################################################################
/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification:
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
Notify.
The POST method notifies a VNF alarm or that the alarm list has been rebuilt.
The API consumer shall have previously created an "Individual subscription resource" with a matching filter.
This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2
for URI query parameters, request and response data structures, and response codes.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/AlarmNotification'
$ref: '#/components/responses/AlarmNotification.Post.204'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
e.g. during subscription.
This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2
for URI query parameters, request and response data structures, and response codes.
$ref: '#/components/responses/AlarmNotification.Get.204'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
###############################################################################
# Notification endpoint AlarmClearedNotification #
###############################################################################
/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmClearedNotification:
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
Notify.
The POST method notifies a VNF alarm or that the alarm list has been rebuilt.
The API consumer shall have previously created an "Individual subscription resource" with a matching filter.
This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2
for URI query parameters, request and response data structures, and response codes.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/AlarmClearedNotification'
$ref: '#/components/responses/AlarmClearedNotification.Post.204'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
e.g. during subscription.
This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2
for URI query parameters, request and response data structures, and response codes.
$ref: '#/components/responses/AlarmClearedNotification.Get.204'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
###############################################################################
# Notification endpoint AlarmListRebuiltNotification #
###############################################################################
/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmListRebuiltNotification:
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
Notify.
The POST method notifies a VNF alarm or that the alarm list has been rebuilt.
The API consumer shall have previously created an "Individual subscription resource" with a matching filter.
This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2
for URI query parameters, request and response data structures, and response codes.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/AlarmListRebuiltNotification'
$ref: '#/components/responses/AlarmListRebuiltNotification.Post.204'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
e.g. during subscription.
This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2
for URI query parameters, request and response data structures, and response codes.
$ref: '#/components/responses/AlarmListRebuiltNotification.Get.204'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
components:
requestBodies:
AlarmNotification:
description: Information of a VNF alarm.
content:
application/json:
schema:
$ref: "../VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification"
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
required: true
AlarmClearedNotification:
description: Information of the clearance of a VNF alarm
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification"
required: true
AlarmListRebuiltNotification:
description: Information that the alarm list has been rebuilt by the VNFM
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"
required: true
responses:
AlarmNotification.Post.204:
description: |
204 NO CONTENT
Shall be returned when the notification has been delivered successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
AlarmNotification.Get.204:
description: |
204 NO CONTENT
Shall be returned to indicate that the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
AlarmClearedNotification.Post.204:
description: |
204 NO CONTENT
Shall be returned when the notification has been delivered successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
AlarmClearedNotification.Get.204:
description: |
204 NO CONTENT
Shall be returned to indicate that the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
AlarmListRebuiltNotification.Post.204:
description: |
204 NO CONTENT
Shall be returned when the notification has been delivered successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
AlarmListRebuiltNotification.Get.204:
description: |
204 NO CONTENT
Shall be returned to indicate that the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string