Newer
Older
$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'
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
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 creating a VNF snapshot resource based on a VNF
instance resource.
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 complete the underlying VNF LCM
operation occurrence, it shall reflect the result of the VNF snapshot creation
by updating the representation of 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"
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.
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.
responses:
201:
$ref: '#/components/responses/VnfSnapshots.Post.201'
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
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'
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"
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'
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
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"
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"
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
VnfSnapshotId:
name: vnfSnapshotId
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
requestBodies:
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.
The Content-Type header shall be set to "application/merge-patch+json" according to IETF RFC 7396.
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.20.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfSnapshotRequest"
required: true
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
RevertToVnfSnapshotRequest:
description: |
Parameters for the Revert to VNF snapshot operation, as defined in clause 5.5.2.23.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/RevertToVnfSnapshotRequest"
required: true
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:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
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
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
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"
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:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
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:
application/json:
schema:
$ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
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.