Newer
Older
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
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
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
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
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
type: string
OperationState:
description: >-
Operation state
type: string
format: enum
enum:
- STARTING
- PROCESSING
- COMPLETED
- FAILED
AppInstanceName:
description: Name of the application instance.
type: string
AppInstanceDescription:
description: Human-readable description of the application instance to be created.
type: string
AppDId:
description: 'Identifier of this MEC application descriptor. This attribute shall be globally unique.'
type: string
AppProvider:
description: 'Provider of the application and of the AppD.'
type: string
AppName:
description: 'Name to identify the MEC application.'
type: string
AppSoftVersion:
description: 'Identifies the version of software of the MEC application.'
type: string
AppDVersion:
description: 'Identifies the version of the application descriptor.'
type: string
AppPkgId:
description: Identifier of the onboarded application package.
type: string
InstantiationState:
description: Instantiation state of the application instance
type: string
enum:
- NOT_INSTANTIATED
- INSTANTIATED
InstantiatedAppState:
description: >-
'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.'
type: object
required:
- operationalState
properties:
operationalState:
$ref: '#/components/schemas/OperationalState'
OperationalState:
description: Operational state is applicable in the instantiation state INSTANTIATED
type: string
enum:
- STARTED
- STOPPED
AppInstanceInfo.links:
description: >-
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
$ref: '#/components/schemas/LinkType'
instantiate:
$ref: '#/components/schemas/LinkType'
terminate:
$ref: '#/components/schemas/LinkType'
operate:
$ref: '#/components/schemas/LinkType'
LcmOperation:
description: >-
Type of the actual LCM operation represented by this application instance LCM operation occurrence
type: string
format: enum
enum:
- INSTATIATE
- OPERATE
- TERMINATE
AppLcmOpOccNotification:
description: >-
'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers'
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- appLcmOpOccId
- appInstanceId
- _links
properties:
id:
$ref: '#/components/schemas/AppLcmOpOccNotification.Id'
notificationType:
$ref: '#/components/schemas/AppLcmOpOcc.NotificationType'
subscriptionId:
$ref: '#/components/schemas/SubscriptionId'
timeStamp:
$ref: '#/components/schemas/TimeStamp'
appLcmOpOccId:
$ref: '#/components/schemas/AppLcmOpOccId'
appInstanceId:
$ref: '#/components/schemas/AppInstanceId'
_links:
$ref: '#/components/schemas/AppLcmOpOccNotification.links'
AppLcmOpOccNotification.Id:
description: >-
''
type: string
AppLcmOpOcc.NotificationType:
description: >-
Discriminator for the different notification types
type: string
enum:
- STARTING
- PROCESSING
- COMPLETED
- FAILED
SubscriptionId:
description: >-
Identifier of the subscription related to this notification.
type: string
AppLcmOpOccId:
description: >-
Identifier of application lifecycle management operation occurrence.
type: string
AppLcmOpOccNotification.links:
description: >-
Links to resources related to this resource.
type: object
required:
- appInstance
- subscription
- appLcmOpOcc
properties:
appInstance:
$ref: '#/components/schemas/LinkType'
subscription:
$ref: '#/components/schemas/LinkType'
appLcmOpOcc:
$ref: '#/components/schemas/LinkType'
InstantiateAppRequest:
properties:
locationConstraints:
# description': Defines the location constraints for the application instance to be created. See note 3.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': LocationConstraints
$ref: '#/components/schemas/LocationConstraints'
selectedMECHostInfo:
description: Describes the information of selected host for the application instance. See note 2.
items:
$ref: '#/components/schemas/MECHostInformation'
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: MECHostInformation
vimConnectionInfo:
description: 'Information about VIM connections to be used for managing the resources for the application instance, or refer to external / externally-managed virtual links.
This attribute shall only be supported and may be present if application-related resource management in direct mode is applicable. See note 2.'
items:
$ref: '#/components/schemas/VimConnectionInfo'
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: VimConnectionInfo
virtualComputeDescriptor:
# description': Describes CPU, Memory and acceleration requirements of the virtual machine for the application instance to be created. See note 1.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': VirtualComputeDescription
$ref: '#/components/schemas/VirtualComputeDescription'
virtualStorageDescriptor:
description: Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1.
items:
$ref: '#/components/schemas/VirtualStorageDescriptor'
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: VirtualStorageDescriptor
required:
- selectedMECHostInfo
type: object
x-etsi-notes: "NOTE 1:\tThis attribute may be provided in the InstantiateAppRequest structure to override the same attribute in the AppD. \nNOTE 2:\tThis field applies to Mm3 reference point only.\nNOTE 3:\tThis field applies to Mm1 reference point only."
x-etsi-ref: 6.2.2.7
LinkType:
properties:
href:
description: URI referring to a resource
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: URI
required:
- href
type: object
x-etsi-ref: 6.5.2
LocationConstraints:
description: >-
'The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776'
type: object
required:
- countryCode
properties:
countryCode:
$ref: '#/components/schemas/CountryCode'
civicAddressElement:
type: array
items:
$ref: '#/components/schemas/CivicAddressElement'
CountryCode:
description: 'The two-letter ISO 3166 country code in capital letters.'
type: string
CivicAddressElement:
description: >-
'The civic address.'
type: object
required:
- caType
- caValue
properties:
caType:
$ref: '#/components/schemas/CaType'
caValue:
$ref: '#/components/schemas/CaValue'
CaType:
description: >-
'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.'
type: integer
CaValue:
description: >-
'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.'
type: string
MECHostInformation:
properties:
hostId:
#description: 'User defined MEC host ID. '
$ref: '#/components/schemas/KeyValuePairs'
#x-etsi-mec-cardinality: '1'
#x-etsi-mec-origin-type: KeyValuePairs
hostName:
description: Human-readable name of MEC host.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
required:
- hostId
type: object
x-etsi-ref: 6.2.2.17
OperateAppRequest:
properties:
changeStateTo:
#description: "The desired operational state: \nSTARTED: the application instance is up and running.\nSTOPPED: the application instance stops operation."
# x-etsi-mec-cardinality: '1'
$ref: '#/components/schemas/ChangeStateTo'
gracefulStopTimeout:
description: The time interval (in seconds) to wait for the application instance to be taken out of service during graceful stop, before stopping the application. See note 1 and note 2.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
stopType:
#description: 'The stop type'
#x-etsi-mec-cardinality: 0..1
$ref: '#/components/schemas/StopType'
required:
- changeStateTo
type: object
x-etsi-notes: "NOTE 1:\tThe \"stopType\" and \"gracefulStopTimeout\" attributes shall be absent, when the \"changeStateTo\" attribute is equal to \"STARTED\". \nNOTE 2:\tThe \"gracefulStopTimeout\" attribute shall be present, when the \"changeStateTo\" is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"GRACEFUL\". The \"gracefulStopTimeout\" attribute shall be absent, when the \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"FORCEFUL\". \nNOTE 3:\tThe request shall be treated as if the \"stopType\" attribute was set to \"FORCEFUL\", when the \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is absent."
x-etsi-ref: 6.2.2.8
StopType:
description: >-
Signals forceful or graceful stop
type: string
enum:
- FORCEFUL
- GRACEFUL
ChangeStateTo:
description: 'The desired operational state'
type: string
format: enum
enum:
- STARTED
- STOPPED
ProblemDetails:
properties:
detail:
description: A human-readable explanation specific to this occurrence of the problem
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
instance:
description: A URI reference that identifies the specific occurrence of the problem
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: URI
status:
description: The HTTP status code for this occurrence of the problem
format: uint32
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uint32
title:
description: A short, human-readable summary of the problem type
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
type:
description: A URI reference according to IETF RFC 3986 that identifies the problem type
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: URI
type: object
TerminateAppRequest:
properties:
gracefulTerminationTimeout:
description: "This attribute is only applicable in case of graceful termination. It defines the time to wait for the application instance to be taken out of service before shutting down the application and releasing the resources. \nThe unit is seconds.\nIf not given and the \"terminationType\" attribute is set to \"GRACEFUL\", it is expected to wait for the successful taking out of service of the application, no matter how long it takes, before shutting down the application and releasing the resources."
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
terminationType:
# description: 'Indicates whether forceful or graceful termination is requested.'
# x-etsi-mec-cardinality: '1'
$ref: '#/components/schemas/TerminationType'
required:
- terminationType
type: object
x-etsi-notes: "NOTE:\tIf the application instance is still in service, requesting forceful termination can adversely impact service."
x-etsi-ref: 6.2.2.9
TimeStamp:
properties:
nanoSeconds:
description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
format: Uint32
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uint32
seconds:
description: "The seconds part of the Time. Time is defined as Unix-time since January\_1, 1970, 00:00:00 UTC."
format: Uint32
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uint32
required:
- seconds
- nanoSeconds
type: object
x-etsi-ref: 6.2.5.4
TerminationType:
description: >-
'Indicates whether forceful or graceful termination is requested.'
type: string
format: enum
enum:
- FORCEFUL
- GRACEFUL
VimConnectionInfo:
properties:
accessInfo:
#description: 'Authentication credentials for accessing the VIM, and other access-related information such as tenants or infrastructure resource groups (see note). The applicable keys are dependent on the content of vimType.If the VimConnectionInfo structure is part of an HTTP response payload body, sensitive attributes that are children of this attributes (such as passwords) shall not be included.If the VimConnectionInfo structure is part of an HTTP request payload body, sensitive attributes that are children of this attribute (such as passwords) shall be present if they have not been provisioned out of band.'
$ref: '#/components/schemas/KeyValuePairs'
#x-etsi-mec-cardinality: 0..1
#x-etsi-mec-origin-type: KeyValuePairs
extra:
#description: VIM type specific additional information. The applicable structure, and whether or not this attribute is available, is dependent on the content of vimType.
$ref: '#/components/schemas/KeyValuePairs'
#x-etsi-mec-cardinality: 0..1
#x-etsi-mec-origin-type: KeyValuePairs
id:
description: The identifier of the VIM Connection. This identifier is managed by the MEO.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
interfaceInfo:
#description: 'Information about the interface or interfaces to the VIM, if applicable, such as the URI of an interface endpoint to communicate with the VIM. The applicable keys are dependent on the content of vimType.Alternatively, such information may have been configured into the VNFM and bound to the vimId.'
$ref: '#/components/schemas/KeyValuePairs'
#x-etsi-mec-cardinality: 0..1
#x-etsi-mec-origin-type: KeyValuePairs
vimId:
description: 'The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise.'
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
vimType:
description: 'Discriminator for the different types of the VIM information.The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. '
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
required:
- id
- vimType
type: object
x-etsi-ref: 6.2.2.18
VirtualComputeDescription:
description: Ref NFV
type: string
VirtualStorageDescriptor:
description: Ref NFV
type: string
KeyValuePairs:
description: >-
'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'
type: object
additionalProperties: true
responses:
204:
description: No Content
206:
description: Partial content
400:
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
401:
description: 'Unauthorized : used when the client did not submit credentials.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
403:
description: 'Forbidden : operation is not allowed given the current status of the resource.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
404:
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
406:
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
409:
description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
412:
description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when
using ETags to avoid write conflicts when using PUT'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
414:
description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
415:
description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
416:
description: 'Range Not Satisfiable .'
422:
description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
example:
application/problem+json:
problemDetails:
type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets'
title: Too many targets
status: '422'
detail: The target area for the request is considered too large
instance: /meAppClient.example.com/77777/msgs/abc
429:
description: 'Too Many Requests : used when a rate limiter has triggered.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'