Newer
Older
Giacomo Bernini
committed
#is not supported for the VNF LCM operation occurrence represented by the parent resource,
#which means that the task resource consequently does not exist.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#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 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 rollback or fail.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/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.
Giacomo Bernini
committed
In case of rolling back an occurrence of the "InstantiateVnf" operation, the VNFM shall
request to the VIM the release of the virtualised resources that were allocated for the related VNF instance.
The "rollback" task shall be supported by the VNFM for any VNF LCM operation occurrence that represents an
"InstantiateVnf" operation in FAILED_TEMP state.
This method shall follow the provisions specified in the tables 5.4.15.3.1-1 and 5.4.15.3.1-2
for URI query parameters, request and response data structures, and response codes.
In case of success of processing the asynchronous request, the "operationState" attribute
in the representation of the parent resource shall be changed to "ROLLING_BACK" and the applicable
"start" notification according to clause 5.6.2.2 shall be emitted to indicate that rollback of the
underlying VNF LCM operation occurrence is attempted.
- $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"
Giacomo Bernini
committed
#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 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.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#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 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 rollback or fail.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/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.
This method shall follow the provisions specified in the tables 5.4.16.3.1-1 and 5.4.16.3.1-2
for URI query parameters, request and response data structures, and response codes.
In case of success, the "operationState" attribute in the representation of the parent resource
shall be changed to "FAILED" and the applicable "result" notification according to clause 5.6.2.2
shall be emitted to indicate that the execution of the underlying VNF LCM operation occurrence
has finally and unrecoverably failed.
- $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"
Giacomo Bernini
committed
#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 LCM operation occurrence represented by the parent resource, which means
#that the task resource consequently does not exist.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#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 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.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/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'
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
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.
This method shall follow the provisions specified in the tables 5.4.17.3.1-1 and 5.4.17.3.1-2
for URI query parameters, request and response data structures, and response codes.
Before returning the "202 Accepted" response, the VNFM shall update the "isCancelPending"
and "cancelMode" attributes in the representation of the parent resource according to the
provisions in clause 5.5.2.13.
In case of success of processing the asynchronous request:
1) If the request has been processed in "STARTING" state, the "operationState" attribute
in the representation of the parent resource shall be changed to "ROLLED_BACK".
2) If the request has been processed in "PROCESSING" or "ROLLING_BACK" state,
the "operationState" attribute in the representation of the parent resource
shall be changed to "FAILED_TEMP".
In both cases, the VNFM shall update the "isCancelPending" and "cancelMode" attributes
in the representation of the parent resource according to the provisions in clause 5.5.2.13
to reflect the new status, and the applicable "result" notification according to clause 5.6.2.2
shall be emitted to indicate that the execution of the underlying VNF LCM operation occurrence
has temporarily failed.
Due to race conditions, the processing of the actual operation that is to be cancelled may eventually
still succeed, in which case the "operationState" attribute in the representation of the parent
resource shall represent the result of that operation, rather than the result of the cancellation.
- $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: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
#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 VNF LCM operation occurrence.
#Typically, this is due to the fact that the operation occurrence is not in STARTING,
#PROCESSING or ROLLING_BACK state.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/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.
This method shall follow the provisions specified in the tables 5.4.18.3.1-1 and 5.4.18.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 subscription"
resource as defined in clause 5.4.3 shall have been created. This method shall not trigger any notification.
Creation of two "Individual subscription" resources with the same callback URI and the same filter
can result in performance degradation and will provide duplicates of notifications to the NFVO,
and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating
an "Individual subscription" resource if another "Individual subscription" resource with the same
filter and callback URI already exists (in which case it shall return the "201 Created" response code),
or may decide to not create a duplicate "Individual subscription" resource (in which case it shall
return a "303 See Other" response code referencing the existing "Individual subscription" resource
with the same filter and callback URI).
requestBody:
$ref: '#/components/requestBodies/LccnSubscriptionRequest'
$ref: '#/components/responses/Subscriptions.Post.201'
Giacomo Bernini
committed
#303 SEE OTHER
#Shall be returned if a subscription with the same callback URI and the same filter already exists
Giacomo Bernini
committed
#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.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/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: "../../responses/SOL002SOL003_resp.yaml#/components/responses/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"
Query Subscription Information.
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.
- $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
Query Subscription Information.
The GET method retrieves information about a subscription by reading an "Individual subscription" resource.
This method shall follow the provisions specified in the tables 5.4.19.3.2-1 and 5.4.19.3.2-2
for URI query parameters, request and response data structures, and response codes.
- $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.
This method shall follow the provisions specified in the tables 5.4.19.3.5-1 and 5.4.19.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 subscription" resource
shall not exist any longer. This means that no notifications for that subscription shall be
sent to the formerly-subscribed API consumer.
NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed
API consumer for a certain time period after the deletion.
$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.
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 the VNF snapshot creation
by updating the corresponding "Individual VNF snapshot" resource indicated by
the "vnfSnapshotInfoId" attribute of the "CreateVnfSnapshotRequest" that is
included in the payload body of the request.
This method shall follow the provisions specified in the tables 5.4.21.3.1-1
and 5.4.21.3.1-2 for URI query parameters, request and response data structures,
and response codes.
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
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:
#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 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.
$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:
#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.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/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.
This method shall follow the provisions specified in the tables 5.4.22.3.1-1
and 5.4.22.3.1-2 for URI query parameters, request and response data structures,
and response codes.
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
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:
#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 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.
$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:
#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.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/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.
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
As a result of successfully executing this method, a new "Individual VNF snapshot"
resource as defined in clause 5.4.24 shall have been created.
The creation of an "Individual VNF snapshot" resource can be performed for two reasons:
- To create an "Individual VNF snapshot" resources that can later be populated by a
new VNF snapshot taken from a VNF instance (refer to clause 5.4.21.3.1).
- To create an "Individual VNF snapshot" resource that can be populated with information
gathered from a VNF snapshot package extraction. In this case, the API consumer indicates
the source of the VNF snapshot package in the payload body of the POST request to the
present resource.
In the second case, for a successful execution of the operation, the values in the
"VnfSnapshotInfo" data structure representing the "Individual VNF snapshot" resource
shall be applied as follows:
- If the request (refer to clause 5.5.2.20) includes the "vnfSnapshot" attribute,
the VNFM shall apply the "VnfSnapshotInfo" with such provided information.
- If the request (refer to clause 5.5.2.20) does not include the "vnfSnapshot"
attribute, the VNFM shall first fetch the VNF snapshot record from the source VNF
snapshot package signalled by the "vnfSnapshotPkgId" attribute in the request and
then apply the "VnfSnapshotInfo" from the fetched VNF snapshot record.
This method shall follow the provisions specified in the tables 5.4.23.3.1-1
and 5.4.23.3.1-2 for URI query parameters, request and response data structures,
and response codes.
requestBody:
$ref: '#/components/requestBodies/CreateVnfSnapshotInfoRequest'
$ref: '#/components/responses/VnfSnapshots.Post.201'
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
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: "../../responses/SOL002SOL003_resp.yaml#/components/responses/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"
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'
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
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.
This method shall follow the provisions specified in the tables 5.4.24.3.2-1 and 5.4.24.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/responses/IndividualVnfSnapshot.Get.200'
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
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"
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
patch:
#SOL003 location: 5.4.24.3.4
description: |
This method modifies an "Individual VNF snapshot" resource.
Changes are applied to the VNF snapshot information managed by the VNFM and are reflected in the
representation of this resource. The VNFM shall reject the modification request if the "vnfSnapshot"
attribute in the "VnfSnapshotInfo" structure representing the "Individual VNF snapshot" resource
is not empty, or the resource is associated to an ongoing VNF snapshot operation (e.g., a VNF
snapshot creation process has started).
This method shall follow the provisions specified in the tables 5.4.24.3.4-1 and 5.4.24.3.4-2
for URI query parameters, request and response data structures, and response codes.
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: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
412:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/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.
As the result of successfully executing this method, the "Individual VNF snapshot" resource
shall not exist any longer.
This method shall follow the provisions specified in the tables 5.4.24.3.5-1 and 5.4.24.3.5-2
for URI query parameters, request and response data structures, and response codes.
responses:
204:
$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:
#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.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/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'
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
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: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
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"
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
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
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
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
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
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