Newer
Older
Giacomo Bernini
committed
version: "1.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: SOL003 - VNF Lifecycle Management interface
SOL003 - VNF Lifecycle Management interface definition
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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.
In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based
filtering mechanism is defined. This mechanism is currently not
included in the corresponding OpenAPI design for this GS version. Changes
to the attribute-based filtering mechanism are being considered in v2.5.1
of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
design.
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
license:
name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
![Michele Carignani Michele Carignani's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Michele Carignani
committed
externalDocs:
Giacomo Bernini
committed
description: ETSI GS NFV-SOL 003 V2.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf
basePath: "/vnflcm/v1"
schemes:
- https
consumes:
- "application/json"
produces:
- "application/json"
paths:
Giacomo Bernini
committed
###############################################################################
# API Versions #
###############################################################################
Giacomo Bernini
committed
'/api_versions':
Giacomo Bernini
committed
$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
###############################################################################
# VNF instances #
###############################################################################
'/vnf_instances':
#SOL003 location: 5.4.2
post:
Create VNF Identifier.
The POST method creates a new VNF instance resource.
This method shall follow the provisions specified in the tables 5.4.2.3.1-1 and 5.4.2.3.1-2
for URI query parameters, request and response data structures, and response codes.
As the result of successfully executing this method, a new "Individual VNF instance"
resource as defined in clause 5.4.3 shall have been created, and the value of the
"instantiationState" attribute in the representation of that resource shall be "NOT_INSTANTIATED".
A notification of type VnfIdentifierCreationNotification shall be triggered as part of successfully
executing this method as defined in clause 5.5.2.18.
parameters:
- name: createVnfRequest
description: The VNF creation parameters
in: body
required: true
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfRequest"
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
description: >
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:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Location:
description: The resource URI of the created VNF instance.
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.
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
Query VNF.
The GET method queries information about multiple VNF instances.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
Samir Medjiah
committed
- name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
The VNFM shall support receiving this parameter as part of the URI query string.
The NFVO may supply this parameter.
All attribute names that appear in the VnfInstance and in data types referenced from
it shall be supported by the VNFM in the filter expression.
Samir Medjiah
committed
in: query
required: false
type: string
- name: all_fields
description: >
Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
The VNFM shall support this parameter.
Samir Medjiah
committed
in: query
required: false
type: string
- name: fields
description: >
Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
The VNFM should support this parameter.
Samir Medjiah
committed
in: query
required: false
type: string
- name: exclude_fields
description: >
Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
The VNFM should support this parameter.
Samir Medjiah
committed
in: query
required: false
type: string
- name: exclude_default
description: >
Indicates to exclude the following complex attributes from the response.
See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter.
Samir Medjiah
committed
The following attributes shall be excluded from the VnfInstance structure
in the response body if this parameter is provided, or none of the parameters
"all_fields", "fields", "exclude_fields", "exclude_default" are provided:
Samir Medjiah
committed
- vnfConfigurableProperties
Samir Medjiah
committed
- instantiatedVnfInfo
- metadata
- extensions
in: query
required: false
type: string
- name: nextpage_opaque_marker
description: >
Marker to obtain the next page of a paged response. Shall be supported by the
VNFM if the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of
ETSI GS NFV-SOL 013 for this resource.
Samir Medjiah
committed
in: query
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
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:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
schema:
type: array
items:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# Individual VNF instance #
###############################################################################
'/vnf_instances/{vnfInstanceId}':
#SOL003 location: 5.4.3.2
parameters:
- name: vnfInstanceId
description: >
Identifier of the VNF instance. 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 instance resource. It can also
be retrieved from the "id" attribute in the payload body of that
response.
in: path
type: string
required: true
The GET method retrieves information about a VNF instance by reading an "Individual VNF instance" resource.
This method shall follow the provisions specified in the tables 5.4.3.3.2-1 and 5.4.3.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
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:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
405:
moscatelli
committed
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
moscatelli
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
patch:
#SOL003 location: 5.4.3.3.4
description: >
moscatelli
committed
Modify VNF Information.
This method modifies an "Individual VNF instance" resource.
Changes to the VNF configurable properties are applied to the configuration in the VNF instance,
and are reflected in the representation of this resource.
Other changes are applied to the VNF instance information managed by the VNFM, and are reflected
in the representation of this resource.
This method shall follow the provisions specified in the tables 5.4.3.3.4-1 and 5.4.3.3.4-2
for URI query parameters, request and response data structures, and response codes.
The steps and conditions that apply as the result of successfully executing this method are
specified in clause 5.4.1.2.
- name: VnfInfoModificationRequest
Parameters for the VNF modification, as defined in clause 5.5.2.12.
The Content-Type header shall be set to "application/merge-patch+json" according to IETF RFC 7396.
required: true
in: body
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest"
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The Content-Type header shall be set to
"application/merge-patch+json" according to IETF RFC 7396.
in: header
required: true
type: string
enum:
- application/merge-patch+json
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
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.
moscatelli
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Location:
description: The resource URI of the created VNF instance
type: string
format: url
maximum: 1
minimum: 1
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
type: string
maximum: 1
minimum: 0
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
409:
Giacomo Bernini
committed
#description: >
#409 CONFLICT
Giacomo Bernini
committed
#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.
moscatelli
committed
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
412:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
delete:
#SOL003 location: 5.4.3.3.5
description: >
moscatelli
committed
Delete VNF Identifier.
This method deletes an "Individual VNF instance" resource.
This method shall follow the provisions specified in the tables 5.4.3.3.5-1 and 5.4.3.3.5-2
for URI query parameters, request and response data structures, and response codes.
As the result of successfully executing this method, the "Individual VNF instance" resource
shall not exist any longer.
A notification of type "VnfIdentifierDeletionNotification" shall be triggered as part of successfully
executing this method as defined in clause 5.5.2.19.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
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.
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
409:
Giacomo Bernini
committed
#description: >
#409 CONFLICT
Giacomo Bernini
committed
#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.
moscatelli
committed
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
412:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Instantiate VNF task #
###############################################################################
'/vnf_instances/{vnfInstanceId}/instantiate':
#SOL003 location: 5.4.4.2
parameters:
- name: vnfInstanceId
description: >
Identifier of the VNF instance. 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 instance resource. It can also
be retrieved from the "id" attribute in the payload body of that
response.
in: path
type: string
required: true
#SOL003 location: 5.4.4.3.1
description: >
Instantiate VNF.
The POST method instantiates a VNF instance.
This method shall follow the provisions specified in the tables 5.4.4.3.1-1 and 5.4.4.3.1-2
for URI query parameters, request and response data structures, and response codes.
The steps and conditions that apply as the result of successfully executing this method
are specified in clause 5.4.1.2.
In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
it shall set the "instantiationState" attribute to the value "INSTANTIATED" and the "vnfState"
attribute to the value "STARTED" in the representation of the "Individual VNF instance" resource.
parameters:
- name: InstantiateVnfRequest
description: Parameters for the VNF instantiation.
in: body
required: true
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest"
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
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
occurrence" resource corresponding to the operation.
Location:
description: The resource URI of the created VNF instance
maximum: 1
minimum: 1
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
409:
Giacomo Bernini
committed
#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 "Individual VNF instance" resource is in INSTANTIATED state,
#or that a required child attribute of the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
###############################################################################
# Scale VNF task #
###############################################################################
'/vnf_instances/{vnfInstanceId}/scale':
#SOL003 location: 5.4.5.2
parameters:
- name: vnfInstanceId
description: >
Identifier of the VNF instance to be scaled. 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.
in: path
type: string
required: true
#SOL003 location: 5.4.5.3.1
description: >
Scale VNF.
The POST method requests to scale a VNF instance resource incrementally.
This method shall follow the provisions specified in the tables 5.4.5.3.1-1 and 5.4.5.3.1-2
for URI query parameters, request and response data structures, and response codes.
The steps and conditions that apply as the result of successfully executing this method are
specified in clause 5.4.1.2.
In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
it shall reflect the result of scaling the VNF instance by updating the "scaleStatus" attribute
in the representation of the "Individual VNF instance" resource.
parameters:
- name: ScaleVnfRequest
description: Parameters for the scale VNF operation.
in: body
required: true
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfRequest"
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
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 VNF instance
type: string
format: url
maximum: 1
minimum: 1
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
404:
Giacomo Bernini
committed
#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,
#including rules for the presence of the response body.
#Specifically in case of this task resource, the response code 404 shall also 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.
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
409:
Giacomo Bernini
committed
#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 "Individual VNF instance" resource is in
#NOT_INSTANTIATED state, or that another lifecycle management operation is ongoing, or that
#a required child attribute of the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
###############################################################################
# Scale VNF to Level task #
###############################################################################
'/vnf_instances/{vnfInstanceId}/scale_to_level':
#SOL003 location: 5.4.6.2
parameters:
- name: vnfInstanceId
description: >
Identifier of the VNF instance to be scaled to a target level. 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.
in: path
type: string
required: true
#SOL003 location: 5.4.6.3.1
description: >
Scale VNF to Level.
The POST method requests to scale a VNF instance resource to a target level.
This method shall follow the provisions specified in the tables 5.4.6.3.1-1 and 5.4.6.3.1-2
for URI query parameters, request and response data structures, and response codes.
The steps and conditions that apply as the result of successfully executing this method are
specified in clause 5.4.1.2.
In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
it shall reflect the result of scaling the VNF instance by updating the "scaleStatus" attribute
in the representation of the "Individual VNF instance" resource.
parameters:
- name: ScaleVnfToLevelRequest
description: Parameters for the scale VNF to Level operation.
in: body
required: true
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfToLevelRequest"
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
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 VNF instance
type: string
format: url
maximum: 1
minimum: 1
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
type: string
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
404:
Giacomo Bernini
committed
#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,
#including rules for the presence of the response body.
#Specifically in case of this task resource, the response code 404 shall also 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.
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
409:
Giacomo Bernini
committed
#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 child attribute of
#the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
###############################################################################
# Change VNF Flavour task #
###############################################################################
'/vnf_instances/{vnfInstanceId}/change_flavour':
#SOL003 location: 5.4.7.2
parameters:
- name: vnfInstanceId
description: >
The identifier of the VNF instance of which the deployment flavour
is requested to be changed. 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.
in: path
type: string
required: true
Change VNF Flavour.
This method shall follow the provisions specified in the tables 5.4.7.3.1-1 and 5.4.7.3.1-2
for URI query parameters, request and response data structures, and response codes.
The steps and conditions that apply as the result of successfully executing this method
are specified in clause 5.4.1.2.
In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence,
it shall set the "flavourId" attribute in the representation of the "Individual VNF instance"
resource to the value of the "newFlavourId" attribute passed in the "ChangeVnfFlavourRequest"
data in the POST request.