Newer
Older
swagger: "2.0"
info:
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 005 V2.4.1
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/nslcm/v1"
schemes:
- https
consumes:
- "application/json"
produces:
rameshnaraya
committed
- "application/json"
###############################################################################
# NSInstances #
###############################################################################
'/ns_instances':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.2
post:
summary: Create a NS instance resource.
description: >
The POST method creates a new NS instance resource.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "CreateNsRequest"
properties:
CreateNsRequest:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/CreateNsRequest"
description: >
The NS creation parameters, as defined in clause 6.5.2.7.
responses:
description: >
201 Created
A NS Instance identifier was created successfully.
The response body shall contain a representation of
the created NS instance, as defined in clause 6.5.2.8.
The HTTP response shall include a "Location" HTTP
header that contains the resource URI of the created
NS instance.
schema:
type: "object"
properties:
NsInstance:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
Content-Type:
type: "string"
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
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.
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
get:
rameshnaraya
committed
Query NS Instances.
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
The GET method queries information about multiple NS instances.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.2.3.2-1 and 6.4.2.3.2-2.
parameters:
- name: "filter"
in: "query"
required: false
type: "string"
description: >
"Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI
query string. The OSS/BSS may supply filtering parameters.
All attribute names that appear in the NsInstance and in data types
referenced from it shall be supported in attribute-based filtering parameters"
- name: "all_fields"
in: "query"
required: false
type: "string"
description: >
"Include all complex attributes in the response. See clause 4.3.3 for details.
The NFVO shall support this parameter."
- name: "fields"
in: "query"
required: false
type: "string"
description: >
"Complex attributes to be included into the response. See clause 4.3.3 for
details. The NFVO should support this parameter."
- name: "exclude_fields"
in: "query"
required: false
type: "string"
description: >
"Complex attributes to be excluded from the response. See clause 4.3.3 for
details. The NFVO should support this parameter."
- name: "exclude_default"
in: "query"
required: false
type: "string"
description: >
"Indicates to exclude the following complex attributes from the response.
See clause 4.3.3 for details. The NFVO shall support this parameter.
The following attributes shall be excluded from the NsInstance structure in
the response body if this parameter is provided, or none of the parameters
"all_fields," "fields", "exclude_fields", "exclude_default" are provided:
- vnfInstances
- pnfInfo
- virtualLinkInfo
- vnffgInfo
- sapInfo
- nsScaleStatus
- additionalAffinityOrAntiAffinityRules"
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
responses:
200:
description: >
Information about zero or more NS instances was
queried successfully.
The response body shall contain representations of
zero or more NS instances, as defined in
clause 6.5.2.8.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
maximum: 1
minimum: 0
schema:
type: array
items:
properties:
NsInstance:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Individual NS instance #
###############################################################################
'/ns_instances/{nsInstanceId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.3
parameters:
- name: nsInstanceId
description: >
Identifier of the NS instance.
in: path
type: string
required: true
get:
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
description: >
The GET method retrieves information about a NS instance by
reading an individual NS instance resource.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
200:
description: >
200 OK
Information about an individual NS instance was queried successfully.
The response body shall contain a representation of the NS instance.
schema:
type: "object"
properties:
NsInstance:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
headers:
Content-Type:
type: "string"
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message body.
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.
maximum: 1
minimum: 0
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
delete:
description: >
Delete NS Identifier
This method deletes an individual NS instance resource.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
responses:
204:
description: >
204 No Content
The NS instance resource and the associated NS
identifier were deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
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
maximum: 1
minimum: 0
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-INSTANTIATED"
412:
$ref: "responses/SOL005_resp.yaml#/responses/412"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Instantiate NS task #
###############################################################################
'/ns_instances/{nsInstanceId}/instantiate':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.4
parameters:
- name: nsInstanceId
description: >
Identifier of the NS instance to be instantiated.
in: path
type: string
required: true
post:
description: >
The POST method requests to instantiate a NS instance resource.
parameters:
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
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "InstantiateNsRequest"
properties:
InstantiateNsRequest:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/InstantiateNsRequest"
description: >
Parameters for the instantiate NS operation, as defined in clause 6.5.2.10.
responses:
202:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
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
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-INSTANTIATED"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Scale NS task #
###############################################################################
'/ns_instances/{nsInstanceId}/scale':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.5
parameters:
- name: nsInstanceId
description: >
Identifier of the NS instance to be scaled.
in: path
type: string
required: true
post:
description: >
The POST method requests to scale a NS instance resource.
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "ScaleNsRequest"
properties:
ScaleNsRequest:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/ScaleNsRequest"
Parameters for the scale NS operation, as defined in clause 6.5.2.13.
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
responses:
202:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Update NS task #
###############################################################################
'/ns_instances/{nsInstanceId}/update':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.6
parameters:
- name: nsInstanceId
description: >
Identifier of the NS instance to be updated.
in: path
type: string
required: true
post:
description: >
Scale NS instance.
The POST method requests to scale a NS instance resource.
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "UpdateNsRequest"
properties:
UpdateNsRequest:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/UpdateNsRequest"
Parameters for the update NS operation, as defined in clause 6.5.2.11.
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
###############################################################################
'/ns_instances/{nsInstanceId}/heal':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.7
parameters:
- name: nsInstanceId
description: >
Identifier of the NS instance to be healed.
in: path
type: string
required: true
post:
summary: Heal a NS instance.
description: >
The POST method requests to heal a NS instance resource.
This method shall follow the provisions specified in the Tables 6.4.7.3.1-1 and
6.4.7.3.1-2 for URI query parameters,
request and response data structures, and response codes.
624
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
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
HealNsRequest:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/HealNsRequest"
Parameters for the heal NS operation, as defined in clause 6.5.2.12.
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
###############################################################################
'/ns_instances/{nsInstanceId}/terminate':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.8
parameters:
- name: nsInstanceId
description: >
The identifier of the NS instance to be terminated.
in: path
type: string
required: true
post:
summary: Terminate a NS instance.
description: >
Terminate NS task.
The POST method terminates a NS instance. This method can only be
used with a NS instance in the INSTANTIATED
state. Terminating a NS instance does not delete the NS instance identifier,
but rather transitions the NS into the NOT_INSTANTIATED state.
This method shall support the URI query parameters, request and
response data structures, and response codes, as
specified in the Tables 6.4.8.3.1-1 and 6.8.8.3.1-2.
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
TerminateNsRequest:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest"
The terminate NS request parameters, as defined in clause 6.5.2.14.
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# NS LCM operation occurrences #
###############################################################################
'/ns_lcm_op_occs':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.9
get:
summary: Query multiple NS LCM operation occurrences.
rameshnaraya
committed
Get Operation Status.
The client can use this method to query status information about multiple NS lifecycle management operation
occurrences.
This method shall follow the provisions specified in the Tables 6.4.9.3.2-1 and 6.4.9.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: "filter"
in: "query"
required: false
type: "string"
description: >
Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI query string.
The OSS/BSS may supply an attribute filter.
All attribute names that appear in the NsLcmOpOcc and in data types referenced
rameshnaraya
committed
from it shall be supported in filtering parameters.
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
- name: "fields"
in: "query"
required: false
type: "string"
description: >
Complex attributes to be included into the response. See clause 4.3.3 for details. The
NFVO should support this parameter.
- name: "exclude_fields"
in: "query"
required: false
type: "string"
description: >
Complex attributes to be excluded from the response. See clause 4.3.3 for details.
The NFVO should support this parameter.
- name: "exclude_default"
in: "query"
required: false
type: "string"
description: >
Indicates to exclude the following complex attributes from the response. See
clause 4.3.3 for details. The NFVO shall support this parameter.
The following attributes shall be excluded from the NsLcmOpOcc structure in the
response body if this parameter is provided:
- operationParams
- changedVnfInfo
- error
- resourceChanges
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
rameshnaraya
committed
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
responses:
200:
description: >
Status information for zero or more NS lifecycle
management operation occurrences was queried successfully.
The response body shall contain representations of
zero or more NS instances, as defined in
clause 5.5.2.13.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
maximum: 1
minimum: 0
schema:
type: array
items:
properties:
NsLcmOpOcc:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Individual NS lifecycle operation occurrence #
###############################################################################
'/ns_lcm_op_occs/{nsLcmOpOccId}':
rameshnaraya
committed
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.10
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence.
in: path
type: string
required: true
get:
summary: Read an individual NS LCM operation occurrence resource.
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
description: >
The client can use this method to retrieve status information about
a NS lifecycle management operation occurrence by
reading an individual "NS LCM operation occurrence" resource.
This method shall follow the provisions specified in the
Tables 6.4.10.3.2-1 and 6.4.10.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
200:
description: >
200 OK
Information about an individual NS instance was queried successfully.
The response body shall contain status information
about a NS lifecycle management operation
occurrence (see clause 6.5.2.3).
properties:
NsLcmOpOcc:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
headers:
Content-Type:
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message body.
rameshnaraya
committed
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.
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
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Retry operation task #
###############################################################################
'/ns_lcm_op_occs/{nsLcmOpOccId}/retry':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.11
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be retried.
This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
to a POST request triggering a NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
attribute in the NsLcmOperationOccurrenceNotification.
in: path
type: string
required: true
post:
summary: Retry a NS lifecycle management operation occurrence.
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
description: >
The POST method initiates retrying a NS lifecycle management operation
if that operation has experienced a temporary
failure, i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
This method shall follow the provisions specified in the
Tables 6.4.11.3.1-1 and 6.4.11.3.1-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
responses:
202:
$ref: "responses/SOL005_resp.yaml#/responses/202"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists-NS-LCM"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Rollback a NS lifecycle management operation occurrence. #
###############################################################################
'/ns_lcm_op_occs/{nsLcmOpOccId}/rollback':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.12
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be rolled back.
This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
to a POST request triggering a NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
attribute in the NsLcmOperationOccurrenceNotification.
in: path
required: true
type: string
post:
summary: Rollback a NS lifecycle management operation occurrence.
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
description: >
The POST method initiates rolling back a NS lifecycle operation
if that operation has experienced a temporary failure,
i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
This method shall follow the provisions specified in the
Tables 6.4.12.3.1-1 and 6.4.12.3.1-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
responses:
202:
$ref: "responses/SOL005_resp.yaml#/responses/202"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-not-found"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Continue a NS lifecycle management operation occurrence. #
###############################################################################
'/ns_lcm_op_occs/{nsLcmOpOccId}/continue':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.13
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be continued.
in: path
required: true
type: string
post:
summary: Continue a NS lifecycle management operation occurrence.
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
description: >
The POST method initiates continuing an NS lifecycle operation if that operation has experienced a temporary failure,
i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
This method shall follow the provisions specified in the Tables 6.4.13.3.1-1 and 6.4.13.3.1-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
responses:
202:
$ref: "responses/SOL005_resp.yaml#/responses/202"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-not-found"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Fail operation task #
###############################################################################
'/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/fail':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.14
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be marked as "failed".
This identifier can be retrieved from the resource referenced by
he "Location" HTTP header in the response
to a POST request triggering a NS LCM operation.
It can also be retrieved from the "nsLcmOpOccId"
attribute in the NsLcmOperationOccurrenceNotification.
in: path
required: true
type: string
post:
summary: Mark a NS lifecycle management operation occurrence as failed.
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
description: >
The POST method marks a NS lifecycle management operation
occurrence as "finally failed" if that operation
occurrence is in "FAILED_TEMP" state.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
responses:
200:
schema:
type: "object"
description: >
The state of the NS lifecycle management operation
occurrence was changed successfully.
The response shall include a representation of the NS
lifecycle management operation occurrence resource.
properties:
NsLcmOpOcc:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
headers:
Content-Type:
type: "string"
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
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.
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-not-found"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Cancel operation task #
###############################################################################
'/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.15
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be canceled.
This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
to a POST request triggering a NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
attribute in the NsLcmOperationOccurrenceNotification.
in: path
required: true
type: string
post:
summary: Cancel a NS lifecycle management operation occurrence.
description: >
The POST method initiates canceling an ongoing NS lifecycle
management operation while it is being executed or
rolled back, i.e. the related "NS LCM operation occurrence" is
either in "PROCESSING" or "ROLLING_BACK" state.
This method shall follow the provisions specified in the
Tables 6.4.15.3.1-1 and 6.4.15.3.1-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "CancelMode"
properties:
CancelMode:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/CancelMode"
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
description: >
The POST request to this resource shall include a CancelMode
structure in the payload body to choose between "graceful" and
"forceful" cancellation.
responses:
202:
$ref: "responses/SOL005_resp.yaml#/responses/202"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists-NS-LCM"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
description: >
rameshnaraya
committed
409 Conflict.
Error: The operation cannot be executed currently, due
to a conflict with the state of the NS LCM operation
occurrence resource.
Typically, this is due to the fact that the operation
occurrence is not in STARTING, PROCESSING or
ROLLING_BACK state.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
maximum: 1
minimum: 0
schema:
$ref: "definitions/SOL005_def.yaml#/definitions/ProblemDetails"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Subscriptions #
###############################################################################
'/subscriptions':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.16
summary: Subscribe to NS lifecycle change notifications.
description: >
The POST method creates a new subscription.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.16.3.1-1 and 6.4.16.3.1-2.
Creation of two subscription resources with the same callbackURI and the same filter can result in performance
degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases.
Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the
same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide
to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing
the existing subscription resource with the same filter and callbackUri).
parameters:
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "LccnSubscriptionRequest"
properties:
LccnSubscriptionRequest:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest"
Details of the subscription to be created, as defined in clause 6.5.2.2.
description: >
201 Created
The subscription was created successfully.
The response body shall contain a representation of
the created subscription resource.
The HTTP response shall include a "Location:"
HTTP header that points to the created subscription resource.
properties:
LccnSubscription:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription"
Content-Type:
type: "string"
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
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.
303:
description: >
rameshnaraya
committed
See Other.
A subscription with the same callbackURI and the
same filter already exits and the policy of the NFVO
is to not create redundant subscriptions.
The HTTP response shall include a "Location"
HTTP header that contains the resource URI of the
existing subscription resource.
The response body shall be empty.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
minimum: 0
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-task-not-suported-NS-LCM"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
get:
rameshnaraya
committed
Query Subscription Information.
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
The GET method queries the list of active subscriptions of the
functional block that invokes the method. It can be used e.g. for
resynchronization after error situations.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
responses:
200:
The list of subscriptions was queried successfully.
The response body shall contain the representations of
all active subscriptions of the functional block that
headers:
Content-Type:
type: "string"
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
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.
maximum: 1
minimum: 0
type: array
items:
properties:
LccnSubscription:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription"
400:
description: >
rameshnaraya
committed
Bad Request.
Invalid attribute-based filtering parameters.
The response body shall contain a ProblemDetails structure, in
which the "detail" attribute should convey more information about
the error.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
maximum: 1
minimum: 0
schema:
$ref: "definitions/SOL005_def.yaml#/definitions/ProblemDetails"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-task-not-suported-NS-LCM"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Individual subscription #
###############################################################################
'/subscriptions/{subscriptionId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.17
parameters:
- name: subscriptionId
description: >
Identifier of this subscription.
in: path
type: string
required: true
get:
description: >
The GET method retrieves information about a subscription by reading an individual subscription resource.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.17.3.2-1 and 6.4.17.3.2-2
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
description: >
200 OK
The operation has completed successfully.
The response body shall contain a representation of
the subscription resource.
properties:
LccnSubscription:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription"
headers:
Content-Type:
type: "string"
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message body.
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.
maximum: 1
minimum: 0
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-task-not-suported-NS-LCM"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
delete:
description: >
The DELETE method terminates an individual subscription.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.17.3.5-1 and 6.4.17.3.5-2.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
responses:
204:
description: >
The subscription resource was deleted successfully.
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.
maximum: 1
minimum: 0
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
##################################################################################
# Notification endpoint #
# Dummy URI is used for testing. #
# In real, resource URI is provided by the client when creating the subscription.#
##################################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsLcmOperationOccurrenceNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.18
post:
summary: Notify about NS lifecycle change
description: >
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.18.3.1-1 and 6.4.18.3.1-2.
A notification about lifecycle changes triggered by a NS LCM.
operation occurrence.
in: body
required: true
schema:
properties:
NsLcmOperationOccurrenceNotification:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOperationOccurrenceNotification"
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
204:
description: >
The notification was delivered successfully.
headers:
WWW-Authenticate:
type: "string"
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.
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
minimum: 0
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsIdentifierCreationNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.18
post:
summary: Notify about NS lifecycle change
description: >
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.18.3.1-1 and 6.4.18.3.1-2.
parameters:
- name: NsIdentifierCreationNotification
description: >
A notification about the creation of a NS identifier and the related
NS instance resource.
in: body
required: true
schema:
properties:
NsIdentifierCreationNotification:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsIdentifierCreationNotification"
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
204:
description: >
204 No Content
The notification was delivered successfully.
headers:
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.
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
$ref: "responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsIdentifierDeletionNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.18
post:
summary: Notify about NS lifecycle change
description: >
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.18.3.1-1 and 6.4.18.3.1-2.
parameters:
- name: NsIdentifierDeletionNotification
description: >
A notification about the deletion of a NS identifier and the related
NS instance resource.
in: body
required: true
schema:
properties:
NsIdentifierDeletionNotification:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsIdentifierDeletionNotification"
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
204:
description: >
204 No Content
The notification was delivered successfully.
headers:
WWW-Authenticate:
type: "string"
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.
maximum: 1
minimum: 0
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
Query NS Instances.
The GET method queries information about multiple NS instances.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.2.3.2-1 and 6.4.2.3.2-2.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
204 No Content
The notification endpoint was tested successfully.
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.
maximum: 1
minimum: 0
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"