Newer
Older
$ref: '#/components/responses/RevertToVnfSnapshotTask.Post.202'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: '#/components/responses/RevertToVnfSnapshotTask.Post.404'
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: '#/components/responses/RevertToVnfSnapshotTask.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# VNF snapshots #
###############################################################################
#SOL003 location: 5.4.23.2
- $ref: ../../components/SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL003_params.yaml#/components/parameters/Version
The POST method creates a new "Individual VNF snapshot" resource. See clause 5.4.23.3.1.
requestBody:
$ref: '#/components/requestBodies/CreateVnfSnapshotInfoRequest'
$ref: '#/components/responses/VnfSnapshots.Post.201'
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
get:
description: >
The GET method queries information about multiple VNF snapshots.
This method shall follow the provisions specified in the tables 5.4.23.3.2-1
and 5.4.23.3.2-2 for URI query parameters, request and response data structures,
and response codes.
parameters:
- $ref: '#/components/parameters/filter_vnf_snapshots'
- $ref: ../../components/SOL003_params.yaml#/components/parameters/all_fields_vnfm
- $ref: ../../components/SOL003_params.yaml#/components/parameters/fields_vnfm
- $ref: ../../components/SOL003_params.yaml#/components/parameters/exclude_fields_vnfm
- $ref: '#/components/parameters/exclude_default_vnf_snapshots'
- $ref: ../../components/SOL003_params.yaml#/components/parameters/nextpage_opaque_marker_vnfm
$ref: '#/components/responses/VnfSnapshots.Get.200'
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
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/SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL003_params.yaml#/components/parameters/Version
get:
#SOL003 location: 5.4.24.3.2
The GET method retrieves information about a VNF snapshot by reading an "Individual VNF snapshot" resource.
See clause 5.4.24.3.2.
- $ref: ../../components/SOL003_params.yaml#/components/parameters/Accept
$ref: '#/components/responses/IndividualVnfSnapshot.Get.200'
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
patch:
#SOL003 location: 5.4.24.3.4
description: |
This method modifies an "Individual VNF snapshot" resource. See clause 5.4.24.3.4.
parameters:
- $ref: ../../components/SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL003_params.yaml#/components/parameters/ContentType
- $ref: ../../components/SOL003_params.yaml#/components/parameters/If-Unmodified-Since
- $ref: ../../components/SOL003_params.yaml#/components/parameters/If-Match
requestBody:
$ref: '#/components/requestBodies/VnfSnapshotInfoModificationRequest'
responses:
200:
$ref: '#/components/responses/IndividualVnfSnapshot.Patch.200'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: '#/components/responses/IndividualVnfSnapshot.Patch.409'
$ref: '#/components/responses/IndividualVnfSnapshot.Patch.412'
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
delete:
#SOL003 location: 5.4.24.3.5
This method deletes an "Individual VNF snapshot" resource and the associated VNF snapshot information
managed by the VNFM, and any resource associated to the VNF snapshot managed by the VIM. See clause 5.4.24.3.5.
$ref: '#/components/responses/IndividualVnfSnapshot.Delete.204'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: '#/components/responses/IndividualVnfSnapshot.Delete.409'
412:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
/vnf_snapshots/{vnfSnapshotInfoId}/vnf_state_snapshot:
#SOL003 location: 5.4.25.2
parameters:
- $ref: '#/components/parameters/VnfSnapshotInfoId'
- $ref: ../../components/SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL003_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/SOL003_params.yaml#/components/parameters/Accept
- $ref: '#/components/parameters/Range'
responses:
200:
$ref: '#/components/responses/IndividualVnfSnapshotState.Get.200'
206:
$ref: '#/components/responses/IndividualVnfSnapshotState.Get.206'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: '#/components/responses/IndividualVnfSnapshotState.Get.409'
$ref: '#/components/responses/IndividualVnfSnapshotState.Get.416'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
filter_vnf_instances:
name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI
GS NFV-SOL 013 [8].
The VNFM shall support receiving this parameter as part of the URI query string. The
NFVO may supply this parameter.
All attribute names that appear in the VnfInstance and in data types referenced from it
shall be supported by the VNFM in the filter expression.
in: query
required: false
schema:
type: string
exclude_default_vnf_instances:
name: exclude_default
in: query
description: >-
Indicates to exclude the following complex attributes from the response. See clause 5.3
of ETSI GS NFV-SOL 013 [8] for details. The VNFM shall support this parameter.
The following attributes shall be excluded from the VnfInstance structure in the
response body if this parameter is provided, or none of the parameters "all_fields",
"fields", "exclude_fields", "exclude_default" are provided:
- vnfConfigurableProperties
- vimConnectionInfo
- instantiatedVnfInfo
- metadata
- extensions
required: false
schema:
type: string
filter_vnf_lcm_op_occs:
name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI
GS NFV-SOL 013 [8].
The VNFM shall support receiving this parameter as part of the URI query
string. The NFVO may supply this parameter.
All attribute names that appear in the VnfLcmOpOcc and in data types
referenced from it shall be supported by the VNFM in the filter expression.
in: query
required: false
schema:
type: string
exclude_default_vnf_lcm_op_occs:
name: exclude_default
in: query
description: >-
Indicates to exclude the following complex attributes from the response. See
clause 5.3 of ETSI GS NFV-SOL 013 [8] for details. The VNFM shall support
this parameter.
The following attributes shall be excluded from the VnfLcmOpOcc structure in
the response body if this parameter is provided, or none of the parameters
"all_fields," "fields", "exclude_fields", "exclude_default" are provided:
- operationParams
- error
- resourceChanges
- changedInfo
- changedExtConnectivity
- lcmCoordinations
- modificationsTriggeredByVnfPkgChange
- warnings
required: false
schema:
type: string
filter_subscriptions:
name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI
GS NFV-SOL 013 [8].
The VNFM shall support receiving this parameter as part of the URI query
string. The NFVO may supply this parameter.
All attribute names that appear in the LccnSubscription and in data types
referenced from it shall be supported by the VNFM in the filter expression.
in: query
required: false
schema:
type: string
filter_vnf_snapshots:
name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI
GS NFV-SOL 013 [8].
The VNFM shall support receiving this parameter as part of the URI query
string. The NFVO may supply this parameter.
All attribute names that appear in the VnfSnapshot and in data types
referenced from it shall be supported by the VNFM in the filter expression.
in: query
required: false
schema:
type: string
exclude_default_vnf_snapshots:
name: exclude_default
in: query
description: >-
Indicates to exclude the following complex attributes from the response.
See clause 5.3 of ETSI GS NFV-SOL 013 [8] for details. The VNFM shall
support this parameter.
The following attributes shall be excluded from the VnfSnapshot structure
in the response body if this parameter is provided, or none of the
parameters "all_fields," "fields", "exclude_fields", "exclude_default" are
provided:
- vnfInstance
- vnfcSnapshots
required: false
schema:
type: string
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
CreateVnfRequest:
description: The VNF creation parameters
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfRequest"
required: true
CancelModeRequest:
description:
The POST request to this resource shall include a CancelMode structure in the message content to choose between
"graceful" and "forceful" cancellation.
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/CancelMode"
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
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/SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfRequest"
required: true
ScaleVnfToLevelRequest:
description: Parameters for the scale VNF to Level operation.
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfToLevelRequest"
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
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/SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest"
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
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
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
responses:
VNFInstances.Post.201:
description: |
201 CREATED
Shall be returned when a new "Individual VNF instance" resource and
the associated VNF instance identifier washas been created successfully.
The response body shall contain a representation of the created VNF instance,
as defined in clause 5.5.2.2.
The HTTP response shall include a "Location" HTTP header that contains the resource
URI of the created VNF instance.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
VNFInstances.Post.422:
description: |
Shall be returned upon the following error: The content type of the message content is supported and the
message content of a request contains syntactically correct data but the data cannot be processed.
The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [8],
including rules for the presence of the response body.
Specifically in case of this resource, the response code 422 shall also be returned if the VNF package
referenced by the "vnfdId" attribute in the "CreateVnfRequest" structure is not in the "ENABLED" state or
does not exist. In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more
information about the error.
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../General_Definitions/SOL003_def.yaml#/definitions/ProblemDetails"
1661
1662
1663
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
VNFInstances.Get.200:
description: |
200 OK
Shall be returned when information about zero or more VNF instances has been queried successfully.
The response body shall contain in an array the representations of zero or more VNF instances,
as defined in clause 5.5.2.2.
If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields"
(if supported) or "exclude_default" URI parameters was supplied in the request, the data in the response
body shall have been transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of
ETSI GS NFV-SOL 013, respectively.
If the VNFM supports alternative 2 (paging) according to clause 5.4.7.2.1 of ETSI GS NFV-SOL 013
for this resource, inclusion of the Link HTTP header in this response shall follow the provisions
in clause 4.7.2.3.5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
IndividualVnfInstance.Get.200:
description: |
200 OK
Shall be returned when information about an individual VNF instance has been read successfully.
The response body shall contain a representation of the VNF instance, as defined in clause 5.5.2.2.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
ETag:
description: >
Used to provide the current entity-tag for the selected resource representation. It can be sent in
"200 OK", "201 Created" and "204 No Content" responses.
style: simple
schema:
type: string
Last-Modified:
description: >
Used to provide a timestamp indicating the date and time at which the server believes the selected resource
representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses.
style: simple
schema:
type: string
format: date-time
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
IndividualVnfInstance.Patch.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
On success, the HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "Individual VNF LCM operation occurrence"
resource corresponding to the operation.
The response body shall be empty.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the "Individual VNF
instance" resource.
Typically, this is due to the fact that another LCM
operation is ongoing.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute should
convey more information about the error
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../General_Definitions/SOL003_def.yaml#/definitions/ProblemDetails"
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
IndividualVnfInstance.Patch.412:
description: |
412 Precondition Failed
Shall be returned upon the following error: A
precondition given in an HTTP request header is
not fulfilled.
Typically, this is due to an ETag mismatch,
indicating that the resource was modified by
another entity.
The response body should contain a
ProblemDetails structure, in which the "detail"
attribute should convey more information about the
error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
IndividualVnfInstance.Delete.204:
description: |
204 NO CONTENT
Shall be returned when the "Individual VNF instance" resource and the associated
VNF identifier were deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the "Individual
VNF instance" resource is in INSTANTIATED state.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../General_Definitions/SOL003_def.yaml#/definitions/ProblemDetails"
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that
contains the URI of the newly-created "Individual VNF LCM operation
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
occurrence" resource corresponding to the operation.
headers:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Shall be returned upon the following error: The
operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the "Individual
VNF instance" resource is in INSTANTIATED state,
or that a required (see note) child attribute of the
"extensions" attribute has not been set.
The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey
more information about the error.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple