Newer
Older
title: SOL003 - VNF Lifecycle Management interface
description: |
SOL003 - VNF Lifecycle Management interface
Michele Carignani
committed
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to. In case of
discrepancies the published ETSI Group Specification takes precedence.
Giacomo Bernini
committed
Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: "2.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
Michele Carignani
committed
externalDocs:
description: ETSI GS NFV-SOL 003 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.06.01_60/gs_NFV-SOL003v030601p.pdf
- url: http://127.0.0.1/vnflcm/v2
- url: https://127.0.0.1/vnflcm/v2
Giacomo Bernini
committed
###############################################################################
# API Versions #
###############################################################################
/api_versions:
$ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
###############################################################################
# VNF instances #
###############################################################################
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
The POST method creates a new VNF instance resource based on a VNF package that is onboarded
and in "ENABLED" state. See clause 5.4.2.3.1.
requestBody:
$ref: '#/components/requestBodies/CreateVnfRequest'
$ref: '#/components/responses/VNFInstances.Post.201'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/VNFInstances.Post.422'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
The GET method queries information about multiple VNF instances. See clause 5.4.2.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
$ref: '#/components/responses/VNFInstances.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Individual VNF instance #
###############################################################################
#SOL003 location: 5.4.3.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
The GET method retrieves information about a VNF instance by reading an "Individual VNF instance" resource.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
$ref: '#/components/responses/IndividualVnfInstance.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
patch:
#SOL003 location: 5.4.3.3.4
This method modifies an "Individual VNF instance" resource. See clause 5.4.3.3.4.
requestBody:
$ref: '#/components/requestBodies/VnfInfoModificationRequest'
$ref: '#/components/responses/IndividualVnfInstance.Patch.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/IndividualVnfInstance.Patch.409'
$ref: '#/components/responses/IndividualVnfInstance.Patch.412'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
delete:
#SOL003 location: 5.4.3.3.5
This method deletes an "Individual VNF instance" resource. See clause 5.4.3.3.5.
$ref: '#/components/responses/IndividualVnfInstance.Delete.204'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/IndividualVnfInstance.Delete.409'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
###############################################################################
# Instantiate VNF task #
###############################################################################
/vnf_instances/{vnfInstanceId}/instantiate:
#SOL003 location: 5.4.4.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
The POST method instantiates a VNF instance. See clause 5.4.4.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/InstantiateVnfRequest'
$ref: '#/components/responses/InstantiateVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/InstantiateVnfInstance.Post.409'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Scale VNF task #
###############################################################################
/vnf_instances/{vnfInstanceId}/scale:
#SOL003 location: 5.4.5.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
The POST method requests to scale a VNF instance resource incrementally. See clause 5.4.5.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/ScaleVnfRequest'
$ref: '#/components/responses/ScaleVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: '#/components/responses/ScaleVnfInstance.Post.404'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/ScaleVnfInstance.Post.409'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Scale VNF to Level task #
###############################################################################
/vnf_instances/{vnfInstanceId}/scale_to_level:
#SOL003 location: 5.4.6.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
The POST method requests to scale a VNF instance resource to a target level. See clause 5.4.6.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/ScaleVnfToLevelRequest'
$ref: '#/components/responses/ScaleToLevelVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: '#/components/responses/ScaleToLevelVnfInstance.Post.404'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/ScaleToLevelVnfInstance.Post.409'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Change VNF Flavour task #
###############################################################################
/vnf_instances/{vnfInstanceId}/change_flavour:
#SOL003 location: 5.4.7.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
The POST method changes the deployment flavour of a VNF instance. See clause 5.4.7.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/ChangeVnfFlavourRequest'
$ref: '#/components/responses/ChangeFlavourVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: '#/components/responses/ChangeFlavourVnfInstance.Post.404'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/ChangeFlavourVnfInstance.Post.409'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Terminate VNF task #
###############################################################################
/vnf_instances/{vnfInstanceId}/terminate:
#SOL003 location: 5.4.8.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
The POST method triggers the VNFM to terminate a VNF instance and to request to the VIM the
release of its used virtualised resources. See clause 5.4.8.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/TerminateVnfRequest'
$ref: '#/components/responses/TerminateVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/TerminateVnfInstance.Post.409'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Heal VNF task #
###############################################################################
/vnf_instances/{vnfInstanceId}/heal:
#SOL003 location: 5.4.9.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
The POST method requests to heal a VNF instance. See clause 5.4.9.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/HealVnfRequest'
$ref: '#/components/responses/HealVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: '#/components/responses/HealVnfInstance.Post.404'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/HealVnfInstance.Post.409'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Operate VNF task #
###############################################################################
/vnf_instances/{vnfInstanceId}/operate:
#SOL003 location: 5.4.10.2
- $ref: '#/components/parameters/VnfInstanceId'
The POST method changes the operational state of a VNF instance. See clause 5.4.10.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/OperateVnfRequest'
$ref: '#/components/responses/OperateVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: '#/components/responses/OperateVnfInstance.Post.404'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/OperateVnfInstance.Post.409'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Change external VNF connectivity task #
###############################################################################
/vnf_instances/{vnfInstanceId}/change_ext_conn:
#SOL003 location: 5.4.11.2
- $ref: '#/components/parameters/VnfInstanceId'
The POST method changes the external connectivity of a VNF instance. See clause 5.4.11.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/ChangeExtVnfConnectivityRequest'
$ref: '#/components/responses/ChangeExtConnVnfInstance.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/ChangeExtConnVnfInstance.Post.409'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Change current VNF package task #
###############################################################################
/vnf_instances/{vnfInstanceId}/change_vnfpkg:
#SOL003 location: 5.4.11a.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
The POST method changes the current VNF package on which the VNF instance is based. See clause 5.4.11a.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/ChangeCurrentVnfPkgRequest'
$ref: '#/components/responses/ChangeVnfpkgVnfInstance.Post.202'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: '#/components/responses/ChangeVnfpkgVnfInstance.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# VNF LCM operation occurrences #
###############################################################################
The API consumer can use this method to query status information about multiple VNF lifecycle management
operation occurrences. See clause 5.4.12.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/VnfLcmOpOccs.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Individual VNF LCM operation occurrence #
###############################################################################
#SOL003 location: 5.4.13
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
The API consumer can use this method to retrieve status information about a VNF lifecycle management operation
occurrence by reading an "Individual VNF LCM operation occurrence" resource. See clause 5.4.13.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/IndividualVnfLcmOpOcc.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Retry operation task #
###############################################################################
/vnf_lcm_op_occs/{vnfLcmOpOccId}/retry:
#SOL003 location: 5.4.14
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
The POST method initiates retrying a VNF lifecycle operation if that operation has experienced a temporary
failure, i.e. the related "Individual VNF LCM operation occurrence" resource is in "FAILED_TEMP" state.
See clause 5.4.14.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/RetryVnfLcmOpOcc.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: '#/components/responses/RetryVnfLcmOpOcc.Post.404'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/RetryVnfLcmOpOcc.Post.409'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Rollback operation task #
###############################################################################
/vnf_lcm_op_occs/{vnfLcmOpOccId}/rollback:
#SOL003 location: 5.4.15
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
The POST method initiates rolling back a VNF lifecycle operation if that operation has experienced a temporary
failure, i.e. the related "Individual VNF LCM operation occurrence" resource is in "FAILED_TEMP" state.
See clause 5.4.15.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/RollbackVnfLcmOpOcc.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: '#/components/responses/RollbackVnfLcmOpOcc.Post.404'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/RollbackVnfLcmOpOcc.Post.409'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Fail operation task #
###############################################################################
/vnf_lcm_op_occs/{vnfLcmOpOccId}/fail:
#SOL003 location: 5.4.16
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
The POST method marks a VNF lifecycle management operation occurrence as "finally failed" if that operation
occurrence is in "FAILED_TEMP" state. See clause 5.4.16.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/FailVnfLcmOpOcc.Post.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: '#/components/responses/FailVnfLcmOpOcc.Post.404'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/FailVnfLcmOpOcc.Post.409'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Cancel operation task #
###############################################################################
/vnf_lcm_op_occs/{vnfLcmOpOccId}/cancel:
#SOL003 location: 5.4.17
parameters:
- $ref: '#/components/parameters/VnfLcmOpOccId'
The POST method initiates cancelling an ongoing VNF lifecycle operation while it is being executed or rolled
back, i.e. the related "Individual VNF LCM operation occurrence" resource is either in "STARTING" or
"PROCESSING" or "ROLLING_BACK" state. See clause 5.4.17.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/CancelVnfLcmOpOcc.Post.202'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: '#/components/responses/CancelVnfLcmOpOcc.Post.404'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: '#/components/responses/CancelVnfLcmOpOcc.Post.409'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Subscriptions #
###############################################################################
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
The POST method creates a new subscription. See clause 5.4.18.3.1.
requestBody:
$ref: '#/components/requestBodies/LccnSubscriptionRequest'
$ref: '#/components/responses/Subscriptions.Post.201'
$ref: '#/components/responses/Subscriptions.Post.303'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
422:
$ref: '#/components/responses/Subscriptions.Post.422'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
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 5.4.18.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
$ref: '#/components/responses/Subscriptions.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Individual subscription #
###############################################################################
#SOL003 location: 5.4.19
parameters:
- $ref: '#/components/parameters/SubscriptionId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
The GET method retrieves information about a subscription by reading an "Individual subscription" resource.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
$ref: '#/components/responses/IndividualSubscription.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
The DELETE method terminates an individual subscription. See clause 5.4.19.3.5.
$ref: '#/components/responses/IndividualSubscription.Delete.204'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Create VNF snapshot task #
###############################################################################
/vnf_instances/{vnfInstanceId}/create_snapshot:
#SOL003 location: 5.4.21.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
The POST method requests taking a snapshot a VNF instance and populating a previously created VNF snapshot
resource (refer to clause 5.4.23.3.1) with the snapshot content. See clause 5.4.21.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/CreateVnfSnapshotRequest'
$ref: '#/components/responses/CreateVnfSnapshotTask.Post.202'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: '#/components/responses/CreateVnfSnapshotTask.Post.404'
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: '#/components/responses/CreateVnfSnapshotTask.Post.409'
$ref: '#/components/responses/CreateVnfSnapshotTask.Post.422'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Revert to VNF snapshot task #
###############################################################################
/vnf_instances/{vnfInstanceId}/revert_to_snapshot:
#SOL003 location: 5.4.22.2
parameters:
- $ref: '#/components/parameters/VnfInstanceId'
The POST method requests reverting a VNF instance to a VNF snapshot. See clause 5.4.22.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/RevertToVnfSnapshotRequest'
$ref: '#/components/responses/RevertToVnfSnapshotTask.Post.202'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: '#/components/responses/RevertToVnfSnapshotTask.Post.404'
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: '#/components/responses/RevertToVnfSnapshotTask.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# VNF snapshots #
###############################################################################
#SOL003 location: 5.4.23.2
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
The POST method creates a new "Individual VNF snapshot" resource. See clause 5.4.23.3.1.
requestBody:
$ref: '#/components/requestBodies/CreateVnfSnapshotInfoRequest'
$ref: '#/components/responses/VnfSnapshots.Post.201'
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
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
get:
description: >
The GET method queries information about multiple VNF snapshots.
This method shall follow the provisions specified in the tables 5.4.23.3.2-1
and 5.4.23.3.2-2 for URI query parameters, request and response data structures,
and response codes.
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
$ref: '#/components/responses/VnfSnapshots.Get.200'
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Individual VNF snapshot #
###############################################################################
/vnf_snapshots/{vnfSnapshotInfoId}:
#SOL003 location: 5.4.24.2
parameters:
- $ref: '#/components/parameters/VnfSnapshotInfoId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
get:
#SOL003 location: 5.4.24.3.2
The GET method retrieves information about a VNF snapshot by reading an "Individual VNF snapshot" resource.
See clause 5.4.24.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
$ref: '#/components/responses/IndividualVnfSnapshot.Get.200'
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
patch:
#SOL003 location: 5.4.24.3.4
description: |
This method modifies an "Individual VNF snapshot" resource. See clause 5.4.24.3.4.
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/VnfSnapshotInfoModificationRequest'
responses:
200:
$ref: '#/components/responses/IndividualVnfSnapshot.Patch.200'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: '#/components/responses/IndividualVnfSnapshot.Patch.409'
$ref: '#/components/responses/IndividualVnfSnapshot.Patch.412'
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
delete:
#SOL003 location: 5.4.24.3.5
This method deletes an "Individual VNF snapshot" resource and the associated VNF snapshot information
managed by the VNFM, and any resource associated to the VNF snapshot managed by the VIM. See clause 5.4.24.3.5.
$ref: '#/components/responses/IndividualVnfSnapshot.Delete.204'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: '#/components/responses/IndividualVnfSnapshot.Delete.409'
412:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
/vnf_snapshots/{vnfSnapshotInfoId}/vnf_state_snapshot:
#SOL003 location: 5.4.25.2
parameters:
- $ref: '#/components/parameters/VnfSnapshotInfoId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
get:
#SOL003 location: 5.4.25.3.2
description: |
The GET method fetches the content of the VNF state snapshot.
This method shall follow the provisions specified in the tables 5.4.25.3.2-1 and 5.4.25.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: '#/components/parameters/Range'
responses:
200:
$ref: '#/components/responses/IndividualVnfSnapshotState.Get.200'
206:
$ref: '#/components/responses/IndividualVnfSnapshotState.Get.206'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: '#/components/responses/IndividualVnfSnapshotState.Get.409'
$ref: '#/components/responses/IndividualVnfSnapshotState.Get.416'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
components:
parameters:
VnfInstanceId:
name: vnfInstanceId
in: path
description: |
Identifier of the VNF instance for the VNF snapshot to be reverted to. This identifier can be retrieved from the resource
referenced by the "Location" HTTP header in the response to a POST request creating a new "Individual VNF instance" resource.
It can also be retrieved from the "id" attribute in the payload body of that response.
required: true
style: simple
explode: false
schema:
type: string
VnfLcmOpOccId:
name: vnfLcmOpOccId
in: path
description: |
Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource
referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation.
It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification.
required: true
style: simple
explode: false
schema:
type: string
SubscriptionId:
name: subscriptionId
in: path
description: |
Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location"
HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from
the "id" attribute in the payload body of that response.
required: true
style: simple
explode: false
schema:
type: string
VnfSnapshotInfoId:
in: path
description: |
Identifier of the "Individual VNF snapshot" resource. This identifier can be retrieved
from the resource referenced by the "Location" HTTP header in the response to a POST request
creating a new VNF snapshot resource. It can also be retrieved from the "id" attribute in
the payload body of that response.
required: true
style: simple
explode: false
schema:
type: string
Range:
name: Range
in: header
description: |
The request may contain a "Range" HTTP header to obtain single
range of bytes from a VNF state snapshot file. This can be used to
continue an aborted transmission.
If the "Range" header is present in the request and the VNFM
does not support responding to range requests with a 206
response, it shall return a 200 OK response instead.
schema:
type: string
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
CreateVnfRequest:
description: The VNF creation parameters
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfRequest"
required: true
VnfInfoModificationRequest:
description: |
Parameters for the VNF modification, as defined in clause 5.5.2.12.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest"
required: true
InstantiateVnfRequest:
description: Parameters for the VNF instantiation.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest"
required: true
ScaleVnfRequest:
description: Parameters for the scale VNF operation.
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfRequest"
required: true
ScaleVnfToLevelRequest:
description: Parameters for the scale VNF to Level operation.
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfToLevelRequest"
required: true
ChangeVnfFlavourRequest:
description: Parameters for the Change VNF Flavour operation.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ChangeVnfFlavourRequest"
required: true
TerminateVnfRequest:
description: Parameters for the VNF termination.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/TerminateVnfRequest"
required: true
HealVnfRequest:
description: Parameters for the Heal VNF operation.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/HealVnfRequest"
required: true
OperateVnfRequest:
description: Parameters for the Operate VNF operation.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/OperateVnfRequest"
required: true
ChangeExtVnfConnectivityRequest:
description: |
Parameters for the Change external VNF connectivity operation.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ChangeExtVnfConnectivityRequest"
required: true
ChangeCurrentVnfPkgRequest:
description: |
Parameters for the Change current VNF package operation, as defined in clause 5.5.2.11a.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ChangeCurrentVnfPkgRequest"
required: true
LccnSubscriptionRequest:
description: |
Details of the subscription to be created.
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest"
required: true
CreateVnfSnapshotRequest:
description: |
Parameters for the "Create VNF Snapshot" operation, as defined in clause 5.5.2.21.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfSnapshotRequest"
required: true
RevertToVnfSnapshotRequest:
description: |
Parameters for the Revert to VNF snapshot operation, as defined in clause 5.5.2.26.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/RevertToVnfSnapshotRequest"
required: true
CreateVnfSnapshotInfoRequest:
description: |
The VNF snapshot resource creation parameters, as defined in clause 5.5.2.20.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfSnapshotInfoRequest"
required: true
VnfSnapshotInfoModificationRequest:
description: |
Parameters for the VNF snapshot information modification, as defined in clause 5.5.2.24.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfoModificationRequest"
required: true
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
responses:
VNFInstances.Post.201:
description: |
201 CREATED
Shall be returned when a new "Individual VNF instance" resource and
the associated VNF instance identifier washas been created successfully.
The response body shall contain a representation of the created VNF instance,
as defined in clause 5.5.2.2.
The HTTP response shall include a "Location" HTTP header that contains the resource
URI of the created VNF instance.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
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
VNFInstances.Post.422:
description: |
422 Unprocessable Entity
Shall be returned upon the following error: The content
type of the payload body is supported and the payload
body of a request contains syntactically correct data
but the data cannot be processed.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI GS NFV-SOL 013 [8],
including rules for the presence of the response body.
Specifically in case of this resource, the response
code 422 shall also be returned if the VNF package
referenced by the "vnfdId" attribute in the
"CreateVnfRequest" structure is not in the "ENABLED"
state or does not exist. In this case, the "detail"
attribute in the "ProblemDetails" structure shall convey
more information about the erro
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
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
VNFInstances.Get.200:
description: |
200 OK
Shall be returned when information about zero or more VNF instances has been queried successfully.
The response body shall contain in an array the representations of zero or more VNF instances,
as defined in clause 5.5.2.2.
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, respectively.
If the VNFM supports alternative 2 (paging) according to clause 5.4.7.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 4.7.2.3.5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
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:
application/json:
schema:
type: array
items:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
IndividualVnfInstance.Get.200:
description: |
200 OK
Shall be returned when information about an individual VNF instance has been read successfully.
The response body shall contain a representation of the VNF instance, as defined in clause 5.5.2.2.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
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
IndividualVnfInstance.Patch.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
On success, the HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "Individual VNF LCM operation occurrence"
resource corresponding to the operation.
The response body shall be empty.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the "Individual VNF
instance" resource.
Typically, this is due to the fact that another LCM
operation is ongoing.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute should
convey more information about the error
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
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
IndividualVnfInstance.Patch.412:
description: |
412 Precondition Failed
Shall be returned upon the following error: A
precondition given in an HTTP request header is
not fulfilled.
Typically, this is due to an ETag mismatch,
indicating that the resource was modified by
another entity.
The response body should contain a
ProblemDetails structure, in which the "detail"
attribute should convey more information about the
error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
IndividualVnfInstance.Delete.204:
description: |
204 NO CONTENT
Shall be returned when the "Individual VNF instance" resource and the associated
VNF 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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the "Individual
VNF instance" resource is in INSTANTIATED state.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "Individual VNF LCM operation
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
occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the "Individual
VNF instance" resource is in INSTANTIATED state,
or that a required (see note) child attribute of the
"extensions" attribute has not been set.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "VNF LCM operation
occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
ScaleVnfInstance.Post.404:
description: |
404 NOT FOUND
Shall be returned upon the following error: The API
producer did not find a current representation for the
target resource or is not willing to disclose that one
exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI GS NFV-SOL 013 [8],
including rules for the presence of the response body.
Specifically in case of this task resource, the
response code 404 shall also be returned if the task
is not supported for the VNF instance represented by
the parent resource, which means that the task
resource consequently does not exist.
In this case, the response body shall be present, and
shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about
the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the "Individual
VNF instance" resource is in NOT_INSTANTIATED
state, that another lifecycle management operation is
ongoing, or that a required (see note) child attribute
of the "extensions" attribute has not been set.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "VNF LCM operation
occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
ScaleToLevelVnfInstance.Post.404:
description: |
404 NOT FOUND
Shall be returned upon the following error: The API
producer did not find a current representation for the
target resource or is not willing to disclose that one
exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI
GS NFV-SOL 013 [8], including rules for the
presence of the response body.
Specifically in case of this task resource, the
response code 404 shall also be returned if the task
is not supported for the VNF instance represented
by the parent resource, which means that the task
resource consequently does not exist.
In this case, the response body shall be present,
and shall contain a ProblemDetails structure, in
which the "detail" attribute shall convey more
information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the VNF
instance resource is in NOT_INSTANTIATED state,
that another lifecycle management operation is
ongoing, or that a required (see note) child attribute
of the "extensions" attribute has not been set.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "VNF LCM operation
occurrence" resource corresponding to the operation.
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
ChangeFlavourVnfInstance.Post.404:
description: |
404 NOT FOUND
Shall be returned upon the following error: The API
producer did not find a current representation for the
target resource or is not willing to disclose that one
exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI
GS NFV-SOL 013 [8], including rules for the
presence of the response body.
Specifically in case of this task resource, the
response code 404 shall also be returned if the task
is not supported for the VNF instance represented
by the parent resource, which means that the task
resource consequently does not exist.
In this case, the response body shall be present,
and shall contain a ProblemDetails structure, in
which the "detail" attribute shall convey more
information about the error
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the "Individual
VNF instance" resource is in NOT_INSTANTIATED
state, that another lifecycle management operation
is ongoing, or that a required (see note) child
attribute of the "extensions" attribute has not been
set.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
TerminateVnfInstance.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "VNF LCM operation
occurrence" resource corresponding to the operation.
headers:
Location:
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
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
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the "Individual
VNF instance" resource is in NOT_INSTANTIATED
state, that another lifecycle management operation is
ongoing, or that a required (see note) child attribute
of the "extensions" attribute has not been set.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "VNF LCM operation
occurrence" resource corresponding to the operation.
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
HealVnfInstance.Post.404:
description: |
404 NOT FOUND
Shall be returned upon the following error: The API
producer did not find a current representation for the
target resource or is not willing to disclose that one
exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI GS NFV-SOL 013 [8],
including rules for the presence of the response body.
Specifically in case of this task resource, the
response code 404 shall also be returned if the task
is not supported for the VNF instance represented by
the parent resource, which means that the task
resource consequently does not exist.
In this case, the response body shall be present, and
shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about
the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the "Individual
VNF instance" resource is in NOT_INSTANTIATED
state, that another lifecycle management operation is
ongoing, or that a required (see note) child attribute
of the "extensions" attribute has not been set.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
OperateVnfInstance.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "VNF LCM operation
occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
OperateVnfInstance.Post.404:
description: |
404 NOT FOUND
Shall be returned upon the following error: The API
producer did not find a current representation for
the target resource or is not willing to disclose that
one exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI
GS NFV-SOL 013 [8], including rules for the
presence of the response body.
Specifically in case of this task resource, the
response code 404 shall also be returned if the
task is not supported for the VNF instance
represented by the parent resource, which means
that the task resource consequently does not exist.
In this case, the response body shall be present,
and shall contain a ProblemDetails structure, in
which the "detail" attribute shall convey more
information about the error
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
OperateVnfInstance.Post.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the VNF
instance resource is in NOT_INSTANTIATED
state, that another lifecycle management operation
is ongoing, or that a required (see note) child
attribute of the "extensions" attribute has not been
set.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
ChangeExtConnVnfInstance.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "VNF LCM operation
occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
ChangeExtConnVnfInstance.Post.409:
description: |
409 CONFLICT
Shall be returned upon the following error:
The operation cannot be executed
currently, due to a conflict with the state of
the resource.
Typically, this is due to the fact that
another lifecycle management operation is
ongoing, or that a required (see note) child
attribute of the "extensions" attribute has
not been set.
The response body shall contain a
ProblemDetails structure, in which the
"detail" attribute shall convey more
information about the error
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
ChangeVnfpkgVnfInstance.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that contains the URI of
the newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
ChangeVnfpkgVnfInstance.Post.409:
description: |
409 CONFLICT
Shall be returned upon the following error:
The operation cannot be executed
currently, due to a conflict with the state of
the resource.
Typically, this is due to the fact that
another lifecycle management operation is
ongoing.
The response body shall contain a
ProblemDetails structure, in which the
"detail" attribute shall convey more
information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
VnfLcmOpOccs.Get.200:
description: |
200 OK
Shall be returned when status information for zero or more VNF lifecycle management
operation occurrences has been queried successfully.
The response body shall contain in an array the status information about zero or more
VNF lifecycle operation occurrences, as defined in clause 5.5.2.13.
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, respectively.
If the VNFM 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:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
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:
application/json:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
IndividualVnfLcmOpOcc.Get.200:
description: |
200 OK
Shall be returned when information about a VNF LCM operation occurrence washas been read successfully.
The response body shall contain status information about a VNF lifecycle management operation occurrence
(see clause 5.5.2.13).
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
RollbackVnfLcmOpOcc.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response shall have an empty payload body.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
RollbackVnfLcmOpOcc.Post.404:
description: |
404 NOT FOUND
Shall be returned upon the following error: The API
producer did not find a current representation for the
target resource or is not willing to disclose that one
exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI GS NFV-SOL 013 [8],
including rules for the presence of the response body.
Specifically in case of this task resource, the response
code 404 shall also be returned if the task is not
supported for the VNF LCM operation occurrence
represented by the parent resource, which means that
the task resource consequently does not exist.
In this case, the response body shall be present, and
shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about
the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
RollbackVnfLcmOpOcc.Post.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the VNF LCM operation
occurrence.
Typically, this is due to the fact that the VNF LCM
operation occurrence is not in FAILED_TEMP state, or
another error handling action is starting, such as retry
or fail.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
RetryVnfLcmOpOcc.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response shall have an empty payload body.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
Shall be returned upon the following error: The API
producer did not find a current representation for the
target resource or is not willing to disclose that one
exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI GS NFV-SOL 013 [8],
including rules for the presence of the response body.
Specifically in case of this task resource, the response
code 404 shall also be returned if the task is not
supported for the VNF LCM operation occurrence
represented by the parent resource, which means that
the task resource consequently does not exist.
In this case, the response body shall be present, and
shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about
the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
RetryVnfLcmOpOcc.Post.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the VNF LCM operation
occurrence.
Typically, this is due to the fact that the VNF LCM
operation occurrence is not in FAILED_TEMP state, or
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
another error handling action is starting, such as
rollback or fail.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
FailVnfLcmOpOcc.Post.200:
description: |
200 OK
Shall be returned when the state of the VNF lifecycle management operation occurrence
has been changed successfully.
The response bofyshall include a representation of the "Individual VNF lifecycle operation occurrence"
resource.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
FailVnfLcmOpOcc.Post.404:
description: |
404 NOT FOUND
Shall be returned upon the following error: The API
producer did not find a current representation for the
target resource or is not willing to disclose that one
exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI GS NFV-SOL 013 [8],
including rules for the presence of the response
body.
Specifically in case of this task resource, the
response code 404 shall also be returned if the task
is not supported for the VNF LCM operation
occurrence represented by the parent resource,
which means that the task resource consequently
does not exist.
In this case, the response body shall be present, and
shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about
the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
FailVnfLcmOpOcc.Post.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the VNF LCM operation
occurrence.
Typically, this is due to the fact that the VNF LCM
operation occurrence is not in FAILED_TEMP state,
or another error handling action is starting, such as
retry or rollback.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
CancelVnfLcmOpOcc.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response shall have an empty payload body.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
CancelVnfLcmOpOcc.Post.404:
description: |
404 NOT FOUND
Shall be returned upon the following error: The API
producer did not find a current representation for the
target resource or is not willing to disclose that one
exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI GS NFV-SOL 013 [8],
including rules for the presence of the response
body.
Specifically in case of this task resource, the
response code 404 shall also be returned if the task
is not supported for the VNF LCM operation
occurrence represented by the parent resource,
which means that the task resource consequently
does not exist.
In this case, the response body shall be present, and
shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about
the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
CancelVnfLcmOpOcc.Post.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the VNF LCM operation
occurrence.
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:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
Subscriptions.Post.201:
description: |
201 CREATED
Shall 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:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription"
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
Subscriptions.Post.303:
description: |
303 See Other
Shall be returned if a subscription with the same
callback URI and the same filter already exists
and the policy of the VNFM is to not create
redundant subscriptions.
The HTTP response shall include a "Location"
HTTP header that contains the resource URI of
the existing "Individual subscription" resource.
The response body shall be empty.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
Subscriptions.Post.422:
description: |
422 Unprocessable Entity
Shall be returned upon the following error: The
content type of the payload body is supported
and the payload body of a request contains
syntactically correct data but the data cannot be
processed.
The general cause for this error and its handling
is specified in clause 6.4 of ETSI
GS NFV-SOL 013 [8], including rules for the
presence of the response body.
Specifically in case of this resource, the response
code 422 shall also be returned if the VNFM has
tested the Notification endpoint as described in
clause 5.4.20.3.2 and the test has failed.
In this case, the "detail" attribute in the
"ProblemDetails" structure shall convey more
information about the error
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
Subscriptions.Get.200:
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 5.5.2.16.
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.
If the VNFM supports alternative 2 (paging) according to clause 5.4.7.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 4.7.2.3.5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
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:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription"
IndividualSubscription.Get.200:
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:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription"
IndividualSubscription.Delete.204:
description: |
204 NO CONTENT
Shall be returned when the "Individual subscription" resource has been 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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
CreateVnfSnapshotTask.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request was accepted for processing, but the processing
has not been completed.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that contains the URI of
the newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
CreateVnfSnapshotTask.Post.404:
description: |
404 NOT FOUND
SShall be returned upon the following error: The API
producer did not find a current representation for
the target resource or is not willing to disclose that
one exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI
GS NFV-SOL 013 [8], including rules for the
presence of the response body.
Specifically in case of this task resource, the
response code 404 shall also be returned if the task
is not supported for the VNF instance represented
by the parent resource, which means that the task
resource consequently does not exist.
In this case, the response body shall be present,
and shall contain a ProblemDetails structure, in
which the "detail" attribute shall convey more
information about the error
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
CreateVnfSnapshotTask.Post.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the VNF
instance resource is in NOT_INSTANTIATED state,
or that another lifecycle management operation is
ongoing.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
CreateVnfSnapshotTask.Post.422:
description: |
422 Unprocessable Entity
Shall be returned upon the following error: The
content type of the payload body is supported and
the payload body of a request contains syntactically
correct data but the data cannot be processed.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI
GS NFV-SOL 013 [8], including rules for the
presence of the response body.
Specifically in case of this resource, the response
code 422 shall also be returned if the provided
identifier of the target "Individual VNF snapshot"
resource for the VNF snapshot is invalid.
In this case, the "detail" attribute in the
"ProblemDetails" structure shall convey more
information about the error
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
RevertToVnfSnapshotTask.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request was accepted for processing, but the processing has
not been completed.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that contains the URI of
the newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
RevertToVnfSnapshotTask.Post.404:
description: |
404 NOT FOUND
Shall be returned upon the following error: The API
producer did not find a current representation for the
target resource or is not willing to disclose that one
exists.
The general cause for this error and its handling is
specified in clause 6.4 of ETSI
GS NFV-SOL 013 [8], including rules for the
presence of the response body.
Specifically in case of this task resource, the
response code 404 shall also be returned if the task
is not supported for the VNF instance represented
by the parent resource, which means that the task
resource consequently does not exist.
In this case, the response body shall be present,
and shall contain a ProblemDetails structure, in
which the "detail" attribute shall convey more
information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
RevertToVnfSnapshotTask.Post.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the VNF
instance resource is in NOT_INSTANTIATED state,
or that another lifecycle management operation is
ongoing.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
VnfSnapshots.Post.201:
description: |
201 CREATED
Shall be returned when an "Individual VNF snapshot" resource has been created
successfully.
The response body shall contain a representation of the new "Individual VNF snapshot"
resource, as defined in clause 5.5.2.22.
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
The HTTP response shall include a "Location" HTTP header that contains the resource URI
of the "Individual VNF snapshot" resource.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
VnfSnapshots.Get.200:
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 5.5.2.22.
If the VNFM 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:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
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:
application/json:
schema:
type: array
items:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
IndividualVnfSnapshot.Get.200:
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 5.5.2.22.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
IndividualVnfSnapshot.Patch.200:
description: |
200 OK
Shall be returned when the modification of VNF snapshot information has been accepted and completed.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfoModifications"
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
IndividualVnfSnapshot.Patch.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the "Individual VNF
snapshot" resource.
Typically, this is due to the fact another
modification is ongoing or that the "Individual VNF
snapshot" resource information is not empty due to
a previously successful modification or currently
being modified due to an underlying VNF snapshot
operation.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute should
convey more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
IndividualVnfSnapshot.Patch.412:
description: |
412 Precondition Failed
Shall be returned upon the following error: A
precondition given in an HTTP request header is
not fulfilled.
Typically, this is due to an ETag mismatch,
indicating that the resource was modified by
another entity.
The response body should contain a
ProblemDetails structure, in which the "detail"
attribute should convey more information about the
error
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
IndividualVnfSnapshot.Delete.204:
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:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
IndividualVnfSnapshot.Delete.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the VNF snapshot
is in use by some operation such as reverting a VNF
instance to a VNF snapshot or creating a VNF
snapshot package.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
IndividualVnfSnapshotState.Get.200:
description: |
200 OK
Shall be returned when the whole content of the VNF state snapshot file has been read successfully.
The payload body shall contain a copy of the VNF state snapshot file and the "Content-Type" HTTP
header shall be set according to the content type of the VNF state snapshot file. If the VNF state
snapshot content is encrypted, the header shall be set to the value "application/cms" (IETF RFC 7193).
If the content type cannot be determined, the header shall be set to the value "application/octet-stream".
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/*:
schema:
type: string
format: binary
IndividualVnfSnapshotState.Get.206:
description: |
206 PARTIAL CONTENT
If the VNFM supports range requests, this response shall be returned when a single consecutive byte
range from the content of the VNF state snapshot file has been read successfully according to the request.
The response body shall contain the requested part of the VNF state snapshot file. The "Content-Type" HTTP
header shall be set according to the content type of the VNF state snapshot file. If the content type cannot
be determined, the header shall be set to the value "application/octet-stream".
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Range:
required : true
style: simple
explode: false
schema:
type: string
content:
application/*:
schema:
type: string
format: binary
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
IndividualVnfSnapshotState.Get.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the VNF
snapshot creation process is not completed.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
IndividualVnfSnapshotState.Get.416:
description: |
416 RANGE NOT SATISFIABLE
Shall be returned upon the following error: The byte
range passed in the "Range" header did not match
any available byte range in the VNF state snapshot
file (e.g. "access after end of file").
The response body may contain a ProblemDetails
structure
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string