Newer
Older
openapi: 3.0.2
info:
title: SOL005 - VNF Snapshot Package Management interface
description: |
SOL005 - VNF Snapshot Package Management interface
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG.
In case of discrepancies the published ETSI Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
contact:
name: NFV-SOL WG
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 005 V3.3.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020701p.pdf
servers:
- url: http://127.0.0.1/vnfsnapshotpkgm/v1
- url: https://127.0.0.1/vnfsnapshotpkgm/v1
paths:
###############################################################################
# API Versions #
###############################################################################
/api_versions:
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
/vnf_snapshot_packages:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
post:
description: |
The POST method creates a new "Individual VNF snapshot package" resource.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/CreateVnfSnapshotPkgInfoRequest'
responses:
201:
$ref: '#/components/responses/VnfSnapshotPackages.Post.200'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
401:
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
403:
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
404:
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
405:
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
406:
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
409:
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
416:
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
500:
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
503:
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
504:
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
get:
description: |
The GET method queries the information of the VNF packages matching the filter.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
- $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
responses:
200:
$ref: '#/components/responses/VnfSnapshotPackages.Get.200'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_snapshot_packages/{vnfSnapshotPkgId}:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
get:
description: |
The GET method reads the information of an individual VNF snapshot package.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
responses:
200:
$ref: '#/components/responses/IndividualVNFSnapshotPackage.Get.200'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
patch:
description: |
The PATCH method updates the information of a VNF snapshot package.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
requestBody:
$ref: '#/components/requestBodies/VnfSnapshotPkgInfoModifications'
responses:
200:
$ref: '#/components/responses/IndividualVNFSnapshotPackage.Patch.200'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
401:
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
403:
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
404:
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
405:
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
406:
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
409:
# 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 state of the VNF snapshot package
# resource is in a state other than CREATED, ERROR_EXTRACTING or AVAILABLE.
# The response body shall contain a ProblemDetails structure, in which the "detail"
# attribute shall convey more information about the error.
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
416:
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
500:
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
503:
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
504:
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
delete:
description: |
The DELETE method deletes an "Individual VNF snapshot package" resource.
responses:
204:
$ref: '#/components/responses/IndividualVNFSnapshotPackage.Delete.204'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
401:
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
403:
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
404:
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
405:
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
406:
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
409:
# 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 operational state of the
# VNF snapshot package resource is other than CREATED, ERROR or AVAILABLE.
# The response body shall contain a ProblemDetails structure, in which
# the "detail" attribute shall convey more information about the error.
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
416:
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
500:
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
503:
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
504:
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
get:
description: |
The GET method fetches the content of a VNF snapshot package.
The content of the package is provided as onboarded to the NFVO,
or as built by the NFVO.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
responses:
200:
$ref: '#/components/responses/VnfSnapshotPackageContent.Get.200'
206:
$ref: '#/components/responses/VnfSnapshotPackageContent.Get.206'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
put:
description: |
The PUT method uploads the content of a VNF package.
The payload body contains a ZIP file that represents the VNF snapshot package.
The "Content-Type" HTTP header shall be set according to the type of the file, i.e.
to "application/zip" for a VNF snapshot package. The VNF snapshot package format
is defined in ETSI GS NFV-SOL 010.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
responses:
202:
$ref: '#/components/responses/VnfSnapshotPackageContent.Put.202'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/upload_from_uri:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
post:
description: |
The POST method provides the information for the NFVO to get the content of
a VNF snapshot package.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
requestBody:
$ref: '#/components/requestBodies/UploadVnfSnapshotPkgFromUriRequest'
responses:
202:
$ref: '#/components/responses/UploadFromUri.Post.202'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
401:
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
403:
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
404:
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
405:
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
406:
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
409:
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
416:
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
500:
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
503:
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
504:
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/build:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
- $ref: '#/components/parameters/VnfSnapshotPkgId'
post:
description: |
The POST method provides the information for the NFVO to start building
the content of a VNF snapshot package.
If the request to build the content of a VNF snapshot package is accepted, the NFVO
shall allocate a globally unique identifier to the VNF snapshot package (i.e.,
"vnfSnapshotPkgUniqueId"). To proceed with the packaging process, the NFVO shall
collect the constituent information and artifacts as indicated by the input information
in the request:
- "vnfSnapshotInfoId": references the VNF snapshot to be packaged.
- one or more "vnfcSnapshotInfoId" referencing specific VNFC snapshot constituents in
the VNF snapshot.
Both identifiers are assumed to be known by the NFVO (as it holds the information of
available VNF snapshot of VNF that are part of the NS instance) and can also be retrieved
by the NFVO from the VNFM from the "id" attribute of the applicable "VnfSnapshot" in the
body of the response to a GET request querying the "Individual VNF snapshot" or the
"VNF snapshots" resource of the VNF LCM interface as specified in clause 5.4 of
ETSI GS NFV-SOL 003.
The API consumer may indicate whether the VNF snapshotted resources on the NFVI shall
be included into the VNF snapshot package file or be left on the NFVI as external image
artifacts to the VNF snapshot package file. In case of building the VNF snapshot package
with snapshotted resources as external image artifacts, the NFVO shall set the value of
the "imageUri" and "imagePath" as specified in clause 11.5.3.2.
The NFVO shall determine whether there is any conflict for building the content of the
VNF snapshot package, and in particular, determine if the VNF snapshot is complete by
checking the "createdAt" information of the VNF snapshot resource.
In addition, the NFVO shall update the "state" attribute of the "VnfSnapshotPkgInfo"
during the build process as specified in clause 11.6.
The NFVO shall build the VNF snapshot Package.
NOTE: The format and provisions for building a VNF snapshot package are specified in
ETSI GS NFV-SOL 010.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
requestBody:
$ref: '#/components/requestBodies/BuildVnfSnapshotPkgRequest'
responses:
202:
$ref: '#/components/responses/BuildVnfSnapshotPkg.Post.202'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
401:
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
403:
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
404:
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
405:
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
406:
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
409:
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
416:
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
500:
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
503:
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
504:
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/extract:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
post:
description: |
The POST method provides the information for the NFVO to start extracting the content of
a VNF snapshot package.
To proceed with the extraction process, the NFVO shall have been provided either with:
- a valid "Individual VNF snapshot" identifier, indicated by the input parameter "vnfSnapshotInfoId".
This identifier corresponds to a known "Individual VNF snapshot" resource of the VNF LCM interface
that the NFVO can obtain from the VNFM., or
- a valid "Individual VNF instance" identifier, indicated by the input parameter "vnfInstanceId".
This identifier corresponds to a known "Individual VNF instance" resource of the VNF LCM interface
that the NFVO can obtain from the VNFM.
The NFVO shall determine whether there is any conflict for extracting the content of the VNF snapshot
package, and in particular:
- determine if the "Individual VNF snapshot" resource can be populated with the extracted content of
the VNF snapshot package, i.e., the "vnfSnapshot" attribute of the "Individual VNF snapshot" resource
is empty.
- determine if the content of the VNF snapshot package is available, and thus the "state" attribute of
the "VNF snapshot package" resource has a value equal to "AVAILABLE".
In addition, the NFVO shall update the "state" attribute of the "VnfSnapshotPkgInfo" during the extraction
process and change it to "EXTRACTING".
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
requestBody:
$ref: '#/components/requestBodies/ExtractVnfSnapshotPkgRequest'
responses:
202:
$ref: '#/components/responses/ExtractVnfSnapshotPkg.Post.202'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
401:
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
403:
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
404:
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
405:
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
406:
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
409:
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
416:
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
500:
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
503:
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
504:
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/cancel:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
post:
description: |
The POST method provides the information for the NFVO to cancel the ongoing operation related to
the content of a VNF snapshot package.
In case of success of processing the asynchronous request:
1) If the request has been processed in "UPLOADING", "BUILDING" or "PROCESSING" state, the "state"
attribute in the representation of the "Individual VNF snapshot package" resource shall be changed
to"ERROR".
2) If the request has been processed in "EXTRACTING" state, the "state" attribute in the representation
of the "Individual VNF snapshot package" resource shall be changed to "ERROR_EXTRACTING".
In both cases, the NFVO shall update the "isCancelPending" attribute in the representation of the
"Individual VNF snapshot package" resource according to the provisions in clause 11.5.2.3 to reflect
the new status.
Due to race conditions, the processing of the actual operation that is to be cancelled may eventually
still succeed, in which case the "state" attribute in the representation of the "Individual VNF snapshot
package" resource shall represent the result of that operation, rather than the result of the cancellation.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
requestBody:
$ref: '#/components/requestBodies/CancelVnfSnapshotPkgOperationRequest'
responses:
202:
$ref: '#/components/responses/CancelVnfSnapshotPkg.Post.202'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
401:
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
403:
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
404:
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
405:
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
406:
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
409:
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
416:
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
500:
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
503:
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
504:
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_snapshot_packages/{vnfSnapshotPkgId}/ext_artifacts_access:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
get:
description: |
The GET method reads the access configuration information that is used by the NFVO to get
the content of external VNF snapshot package artifacts.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
responses:
200:
$ref: '#/components/responses/ExternalArtifactsAccess.Get.200'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
put:
description: |
The PUT method provides the access configuration information for the NFVO to download
the content of external VNF package artifacts.
As precondition for invoking this method, the "Individual VNF snapshot package" resource
shall have been created, and the value of "state" attribute in the representation of the
"Individual VNF snapshot package" resource shall equal to "CREATED" or "ERROR".
The resource representation in the payload body of the PUT request shall replace the current
state of the resource.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/VnfSnapshotPkgExtArtifactsAccessInfo'
responses:
200:
$ref: '#/components/responses/ExternalArtifactsAccess.Put.200'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_snapshot_packages/{vnfSnapshotPkgId}/artifacts/{artifactPath}:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
- $ref: '#/components/parameters/ArtifactPath'
get:
description: |
The GET method fetches the content of an artifact within the VNF snapshot package.
If the VNF snapshot package is a result of a building process (refer to
"Build VNF snapshot package content task" resource in clause 11.4.6), and the referred
"Individual VNF snapshot package artifact" is external to the main VNF snapshot package
file, the NFVO shall return a "302 Found" response code referencing the external artifact
resource. To fetch the "Individual VNF snapshot package artifact" from URI indicated by
the "Location" header, the OSS/BSS will have to be authorized to access the resource referred
by the new URI. Furthermore, as indicated by the "302 Found" response code, the OSS/BSS will
have to use the original URI of the present "Individual VNF snapshot package artifact" resource
in future requests.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
responses:
200:
$ref: '#/components/responses/IndividualArtifact.Get.200'
206:
$ref: '#/components/responses/IndividualArtifact.Get.206'
302:
$ref: '#/components/responses/IndividualArtifact.Get.302'
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
components:
parameters:
VnfSnapshotPkgId:
name: vnfSnapshotPkgId
in: path
description: |
Identifier of the VNF snapshot package. The identifier is allocated by the NFVO.
This identifier can be retrieved from the "id" attribute of the applicable "VnfSnapshotPkgInfo" in the body of
the response to requesting the creation of a new "Individual VNF snapshot package" resource or in a response to
a GET request querying the "Individual VNF snapshot package" or the "VNF snapshot packages" resource.
required: true
style: simple
explode: false
schema:
type: string
ArtifactPath:
name: artifactPath
in: path
description: |
For an artifact contained as a file in the VNF snapshot package, this variable shall contain a sequence
of one or path segments representing the path of the artifact within the VNF snapshot package, relative
to the root of the package.
EXAMPLE: foo/bar/m%40ster.sh
For an external artifact represented as a URI in the VNF snapshot package manifest, this variable shall
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
contain a sequence of one or more path segments as synthesized by the NFVO (see clause 11.5.3.3) representing
this artifact.
This identifier can be retrieved from the "artifactPath" attribute of the applicable "additionalArtifacts"
entry in the body of the response to a GET request querying the "Individual VNF snapshot package" or the
"VNF snapshot packages" resource.
Since multiple path segments are allowed to be contained in this variable, the "/" character that separates
these segments is not percent-encoded. Each individual segment is percent-encoded if necessary as defined
in clause 4.1 of ETSI GS NFV-SOL 013.
required: true
style: simple
explode: false
schema:
type: string
requestBodies:
CreateVnfSnapshotPkgInfoRequest:
description: |
"VNF snapshot package" resource creation parameters, as defined in clause 11.5.2.2.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/CreateVnfSnapshotPkgInfoRequest
required: true
VnfSnapshotPkgInfoModifications:
description: |
"VNF snapshot package" resource modification parameters, as defined in clause 11.5.2.4.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgInfoModifications
required: true
UploadVnfSnapshotPkgFromUriRequest:
description: |
Request parameters for uploading the content of a VNF snapshot package, as defined in clause 11.5.2.5.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/UploadVnfSnapshotPkgFromUriRequest
required: true
BuildVnfSnapshotPkgRequest:
description: |
Request parameters for building the content of a VNF snapshot package, as defined in clause 11.5.2.6.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/BuildVnfSnapshotPkgRequest
required: true
ExtractVnfSnapshotPkgRequest:
description: |
Request parameters for extracting the content of a VNF snapshot package, as defined in clause 11.5.2.7.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/ExtractVnfSnapshotPkgRequest
required: true
CancelVnfSnapshotPkgOperationRequest:
description: |
Request parameters for cancelling an ongoing operation related to the content of a VNF snapshot package,
as defined in clause 11.5.2.8.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/CancelVnfSnapshotPkgOperationRequest
required: true
VnfSnapshotPkgExtArtifactsAccessInfo:
description: VOID
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgExtArtifactsAccessInfo
required: true
responses:
VnfSnapshotPackages.Post.200:
description: |
200 OK
Shall be returned when an "Individual VNF snapshot package" resource has been created successfully.
The response body shall contain a representation of the new "Individual VNF snapshot package" resource,
as defined in clause 11.5.2.3.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the
"Individual VNF snapshot package" resource.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Location:
description: The resource URI of the created VNF Snapshot Package.
style: simple
explode: false
schema:
type: string
format: url
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ../definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgInfo
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
VnfSnapshotPackages.Get.200:
description: |
200 OK
Shall be returned when information about zero or more VNF snapshot packages has been queried successfully.
The response body shall contain in an array the VNF snapshot package info representations that match the
attribute filter, i.e. zero or more VNF snapshot package info representations as defined in clause 11.5.2.3.
If the "filter" URI parameter or one of the "all_fields", "fields", "exclude_fields" or "exclude_default" URI
parameters was supplied in the request and is supported, the data in the response body shall have been
transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively.
If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this
resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3
of ETSI GS NFV-SOL 013.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: ../definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgInfo
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
IndividualVNFSnapshotPackage.Get.200:
description: |
200 OK
Shall be returned when information of the VNF snapshot package has been read successfully.
The response body shall contain the VNF snapshot package info representation defined in clause 12.5.2.3.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ../definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgInfo
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
IndividualVNFSnapshotPackage.Patch.200:
description: |
200 OK
Shall be returned when the operation has been completed successfully.
The response body shall contain attribute modifications for an "Individual VNF snapshot package" resource.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ../definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgInfoModifications
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
IndividualVNFSnapshotPackage.Delete.204:
description: |
204 NO CONTENT
Shall be returned when the VNF snapshot package has been deleted successfully.
The response body shall be empty.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
VnfSnapshotPackageContent.Get.200:
description: |
200 OK
Shall be returned when the whole content of the VNF snapshot package file has been read
successfully.
The response body shall include a copy of the VNF snapshot package file.
The "Content-Type" HTTP header shall be set according to the type of the file, i.e. to
"application/zip" for a VNF snapshot package. The VNF snapshot package format is defined
in ETSI GS NFV-SOL 010.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the