Newer
Older
openapi: 3.0.2
title: SOL005 - NS Lifecycle Management Interface
description: |
SOL005 - NS Lifecycle 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/rep/nfv/SOL005/issues
contact:
name: NFV-SOL WG
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
description: ETSI GS NFV-SOL 005 V3.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.05.01_60/gs_nfv-sol005v030501p.pdf
servers:
- url: http://127.0.0.1/nslcm/v2
- url: https://127.0.0.1/nslcm/v2
/api_versions:
$ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions
moscatelli
committed
/ns_instances:
Samir Medjiah
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
description: |
The GET method queries information about multiple NS instances. See clause 6.4.2.3.2.
- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
- $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
"200":
$ref: '#/components/responses/NsInstances.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
moscatelli
committed
post:
description: |
The POST method creates a new NS instance resource. See clause 6.4.2.3.1.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/NsInstanceCreateRequest'
responses:
"201":
$ref: '#/components/responses/NsInstances.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
moscatelli
committed
/ns_instances/{nsInstanceId}:
- $ref: '#/components/parameters/NsInstanceId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
description: |
The GET method retrieves information about an NS instance by reading an "Individual NS instance" resource.
See clause 6.4.3.3.2.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
"200":
$ref: '#/components/responses/IndividualNsInstance.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
moscatelli
committed
description: |
This method deletes an "Individual NS instance" resource. See clause 6.4.3.3.5.
"204":
$ref: '#/components/responses/IndividualNsInstance.Delete'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"412":
$ref: ../responses/SOL005_resp.yaml#/components/responses/412
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
moscatelli
committed
/ns_instances/{nsInstanceId}/instantiate:
- $ref: '#/components/parameters/NsInstanceId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
moscatelli
committed
post:
description: |
The POST method instantiates an NS instance. See clause 6.4.4.3.1.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/NsInstanceInstantiateRequest'
"202":
$ref: '#/components/responses/InstantiateNsInstance.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/ns_instances/{nsInstanceId}/scale:
- $ref: '#/components/parameters/NsInstanceId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
moscatelli
committed
post:
description: |
The POST method requests to scale an NS instance resource. See clause 6.4.5.3.1.
moscatelli
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/NsInstanceScaleRequest'
"202":
$ref: '#/components/responses/ScaleNsInstance.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/ns_instances/{nsInstanceId}/update:
- $ref: '#/components/parameters/NsInstanceId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
moscatelli
committed
post:
description: |
The POST method updates an NS instance. See clause 6.4.6.3.1.
moscatelli
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/NsInstanceUpdateRequest'
"202":
$ref: '#/components/responses/UpdateNsInstance.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/ns_instances/{nsInstanceId}/heal:
- $ref: '#/components/parameters/NsInstanceId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
description: |
The POST method requests to heal an NS instance. See clause 6.4.7.3.1.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/NsInstanceHealRequest'
"202":
$ref: '#/components/responses/HealNsInstance.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/ns_instances/{nsInstanceId}/terminate:
- $ref: '#/components/parameters/NsInstanceId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
description: |
The POST method terminates an NS instance. See clause 6.4.8.3.1.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/NsInstanceTerminateRequest'
"202":
$ref: '#/components/responses/TerminateNsInstance.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/ns_lcm_op_occs:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
description: |
The API consumer can use this method to query status information about multiple NS lifecycle management
operation occurrences. See clause 6.4.9.3.2.
- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
- $ref: ../components/SOL005_params.yaml#/components/parameters/fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
- in: query
name: exclude_default
description: >
- Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 [16] 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
- lcmCoordinations
- warnings
schema:
type: string
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
"200":
$ref: '#/components/responses/NsLcmOpOccs.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
moscatelli
committed
/ns_lcm_op_occs/{nsLcmOpOccId}:
- $ref: '#/components/parameters/NsLcmOpOccId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
moscatelli
committed
get:
description: |
The API consumer can use this method to retrieve status information about an NS lifecycle management operation
occurrence by reading an individual "NS LCM operation occurrence" resource. See clause 6.4.10.3.2.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
"200":
$ref: '#/components/responses/IndividualNsLcmOpOcc.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/ns_lcm_op_occs/{nsLcmOpOccId}/retry:
- $ref: '#/components/parameters/NsLcmOpOccId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
description: |
The POST method initiates retrying an 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. See clause 6.4.11.3.1.
"202":
$ref: '#/components/responses/NsLcmOpOccRetry.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/ns_lcm_op_occs/{nsLcmOpOccId}/rollback:
- $ref: '#/components/parameters/NsLcmOpOccId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
description: |
The POST method initiates rolling back 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. See clause 6.4.12.3.1.
"202":
$ref: '#/components/responses/NsLcmOpOccRollback.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/ns_lcm_op_occs/{nsLcmOpOccId}/continue:
- $ref: '#/components/parameters/NsLcmOpOccId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
moscatelli
committed
post:
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. See clause 6.4.13.3.1.
"202":
$ref: '#/components/responses/NsLcmOpOccContinue.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/fail:
- $ref: '#/components/parameters/NsLcmOpOccId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
description: |
The POST method marks an NS lifecycle management operation occurrence as "finally failed" if that
operation occurrence is in "FAILED_TEMP" state. See clause 6.4.14.3.1.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
"200":
$ref: '#/components/responses/NsLcmOpOccFail.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel:
- $ref: '#/components/parameters/NsLcmOpOccId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
description: |
The POST method initiates cancelling 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.
See clause 6.4.15.3.1.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/NsLcmOpOccCancelRequest'
"202":
$ref: '#/components/responses/NsLcmOpOccCancel.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/subscriptions:
Samir Medjiah
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
moscatelli
committed
get:
description: |
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. See clause 6.4.16.3.2.
- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
"200":
$ref: '#/components/responses/NsLcmSubscriptions.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
moscatelli
committed
post:
description: |
The POST method creates a new subscription. See clause 6.4.16.3.1.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/NsLcmSubscriptionRequest'
responses:
"201":
$ref: '#/components/responses/NsLcmSubscriptions.Post'
"303":
$ref: ../responses/SOL005_resp.yaml#/components/responses/303
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"422":
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
moscatelli
committed
/subscriptions/{subscriptionId}:
- $ref: '#/components/parameters/SubscriptionId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
description: |
The GET method retrieves information about a subscription by reading an "Individual subscription" resource.
See clause 6.4.17.3.2.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
moscatelli
committed
responses:
"200":
$ref: '#/components/responses/IndividualNsLcmSubscription.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
description: |
The DELETE method terminates an individual subscription. See clause 6.4.17.3.5.
"204":
$ref: '#/components/responses/IndividualNsLcmSubscription.Delete'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_snapshots:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
get:
description: |
The GET method queries information about multiple VNF snapshots. See clause 6.4.19.3.2.
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
- $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
responses:
"200":
$ref: '#/components/responses/VnfSnapshots.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_snapshots/{vnfSnapshotInfoId}:
parameters:
- $ref: '#/components/parameters/VnfSnapshotInfoId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
get:
description: |
The GET method retrieves information about a VNF snapshot by reading an "Individual VNF snapshot" resource.
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
responses:
"200":
$ref: '#/components/responses/IndividualVnfSnapshot.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
delete:
description: |
This method deletes an "Individual VNF snapshot" resource and the associated VNF snapshot information managed by
the NFVO and corresponding VNFM, and any resource associated to the VNF snapshot managed by the VIM.
responses:
"204":
$ref: '#/components/responses/IndividualVnfSnapshot.Delete'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
components:
parameters:
NsInstanceId:
name: nsInstanceId
in: path
description: |
Identifier of the NS instance.
required: true
style: simple
explode: false
schema:
type: string
NsLcmOpOccId:
name: nsLcmOpOccId
in: path
description: |
Identifier of a NS lifecycle management operation occurrence.
required: true
style: simple
explode: false
schema:
type: string
SubscriptionId:
name: subscriptionId
in: path
description: |
Identifier of this subscription.
required: true
style: simple
explode: false
schema:
type: string
VnfSnapshotInfoId:
name: vnfSnapshotInfoId
in: path
description: |
Identifier of the "Individual VNF snapshot" resource.
This identifier can be retrieved from the "id" attribute in the payload body of a response to a query to
"VNF snapshots" resource.
required: true
style: simple
explode: false
schema:
type: string
requestBodies:
NsInstanceCreateRequest:
description: |
The NS creation parameters, as defined in clause 6.5.2.7.
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/CreateNsRequest
required: true
moscatelli
committed
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
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
1030
1031
1032
1033
1034
1035
1036
1037
1038
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
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
NsInstanceInstantiateRequest:
description: |
Parameters for the instantiate NS operation, as defined in clause 6.5.2.11.
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/InstantiateNsRequest
required: true
NsInstanceScaleRequest:
description: |
Parameters for the scale NS operation, as defined in clause 6.5.2.14.
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/ScaleNsRequest
required: true
NsInstanceUpdateRequest:
description: |
Parameters for the update NS operation, as defined in clause 6.5.2.12.
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/UpdateNsRequest
required: true
NsInstanceHealRequest:
description: |
Parameters for the heal NS operation, as defined in clause 6.5.2.13.
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/HealNsRequest
required: true
NsInstanceTerminateRequest:
description: |
The terminate NS request parameters, as defined in clause 6.5.2.15.
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest
required: true
NsLcmOpOccCancelRequest:
description: |
The POST request to this resource shall include a CancelMode structure in the payload body to choose between
"graceful" and "forceful" cancellation.
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/CancelMode
required: true
NsLcmSubscriptionRequest:
description: |
Details of the subscription to be created, as defined in clause 6.5.2.2.
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest
required: true
responses:
NsInstances.Get:
description: |
200 OK
Shall be returned when information about zero or more NS instances has been queried successfully. The response
body shall contain in an array the representations of zero or more NS instances, as defined in clause 6.5.2.8.
If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields" (if supported)
or "exclude_default" URI parameters was supplied in the request, the data in the response body shall have been
transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013 [16], respectively.
If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 [16] for this resource,
inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013 [16].
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance
NsInstances.Post:
description: |
201 Created
Shall be returned when a new "Individual NS instance" resource and the associated NS instance identifier has
been created successfully. The response body shall contain a representation of the created NS instance, as
defined in clause 6.5.2.10. The HTTP response shall include a "Location" HTTP header that contains the resource
URI of the created NS instance.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
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.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance
IndividualNsInstance.Get:
description: |
200 OK
Shall be returned when information about an individual NS instance has been read successfully. The response
body shall contain a representation of the NS instance, as defined in clause 6.5.2.10.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
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.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance
IndividualNsInstance.Delete:
description: |
204 No Content
Shall be returned when the "Individual NS instance" resource and the associated NS identifier have been deleted
successfully. The response body shall be empty.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
content: {}
InstantiateNsInstance.Post:
description: |
202 ACCEPTED
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: The resource URI of the created NS instance
style: simple
explode: false
schema:
type: string
format: url
content: {}
ScaleNsInstance.Post:
description: |
202 ACCEPTED
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: The resource URI of the created NS instance
style: simple
explode: false
schema:
type: string
format: url
content: {}
UpdateNsInstance.Post:
description: |
202 ACCEPTED
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: The resource URI of the created NS instance
style: simple
explode: false
schema:
type: string
format: url
content: {}
HealNsInstance.Post:
description: |
202 ACCEPTED
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: The resource URI of the created NS instance
style: simple
explode: false
schema:
type: string
format: url
content: {}
TerminateNsInstance.Post:
description: |
202 ACCEPTED
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: The resource URI of the created NS instance
style: simple
explode: false
schema:
type: string
format: url
content: {}
NsLcmOpOccs.Get:
description: |
200 OK
Shall be returned when status information for zero or more NS lifecycle management operation occurrences has
been queried successfully. The response body shall contain in an array the status information about zero or
more NS lifecycle operation occurrences, as defined in clause 6.5.2.3. If the "filter" URI parameter or one
of the "all_fields", "fields", "exclude_fields" or "exclude_default" URI parameters was supplied in the request
and is supported, the data in the response body shall have been transformed according to the rules specified
in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013 [16], respectively. If the NFVO supports alternative 2
(paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 [16] for this resource, inclusion of the Link HTTP
header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013 [16].
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc
IndividualNsLcmOpOcc.Get:
description: |
200 OK
Shall be returned when information about an NS LCM operation occurrence has been read successfully. The response
body shall contain status information about an NS lifecycle management operation occurrence (see clause 6.5.2.3).
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
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.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc
NsLcmOpOccRetry.Post:
description: |
202 ACCEPTED
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: The resource URI of the created NS instance
style: simple
explode: false
schema:
type: string
format: url
content: {}
NsLcmOpOccRollback.Post:
description: |
202 ACCEPTED
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: The resource URI of the created NS instance
style: simple
explode: false
schema:
type: string
format: url
content: {}
NsLcmOpOccContinue.Post:
description: |
202 ACCEPTED
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: The resource URI of the created NS instance
style: simple
explode: false
schema:
type: string
format: url
content: {}
NsLcmOpOccFail.Post:
description: |
200 OK
Shall be returned when the state of the NS lifecycle management operation occurrence has been changed
successfully. The response shall include a representation of the "Individual NS lifecycle management
operation occurrence" resource.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
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.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc
NsLcmOpOccCancel.Post:
description: |
202 ACCEPTED
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: The resource URI of the created NS instance
style: simple
explode: false
schema:
type: string
format: url
content: {}
NsLcmSubscriptions.Get:
description: |
200 OK
Shall be returned when the list of subscriptions has been queried successfully. The response body shall
contain in an array the representations of all active subscriptions of the functional block that invokes
the method, i.e. zero or more representations of lifecycle change notification subscriptions as defined in
clause 6.5.2.4. If the "filter" URI parameter was supplied in the request, the data in the response body
shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013 [16].
If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 [16] for this
resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3
of ETSI GS NFV-SOL 013 [16].
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
Content-Type:
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.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription
NsLcmSubscriptions.Post:
description: |
201 Created\nShall be returned when the subscription has been
created successfully. The response body shall contain a representation
of the created "Individual subscription" resource. The HTTP response
shall include a "Location:" HTTP header that points to the created
"Individual subscription" resource.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
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.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription
IndividualNsLcmSubscription.Get:
description: |
200 OK
Shall be returned when information about an individual
subscription has been read successfully. The response body shall contain
a representation of the "Individual subscription" resource.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
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.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription
IndividualNsLcmSubscription.Delete:
description: |
204 NO CONTENT
Shall be returned when the "Individual subscription" resource has been deleted successfully. The response
body shall be empty.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
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
content: {}
VnfSnapshots.Get:
description: |
200 OK
Shall be returned when information about zero or more VNF snapshots was queried successfully.
The response body shall contain in an array the representations of zero or more "Individual VNF snapshot" resources,
as defined in clause 6.5.2.17.
If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource,
inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
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.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo
IndividualVnfSnapshot.Get:
description: |
200 OK
Shall be returned when information about an individual VNF snapshot was read successfully.
The response body shall contain a representation of the "Individual VNF snapshot" resource, as defined in clause
6.5.2.17.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
Content-Type:
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.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo
IndividualVnfSnapshot.Delete:
description: |
204 NO CONTENT
Shall be returned when the VNF snapshot resource and the associated VNF snapshot were deleted successfully.
The response body shall be empty.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
content: {}