Newer
Older
title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management'
description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.'
license:
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
name: ETSI Forge
url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api
description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.2.1'
url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.02.01_60/gs_MEC01002v020201p.pdf'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
tags:
- name: app-lcm
description: App lifecycle management
- name: app-lcm-notifications
description: App lifecycle management notifications
- url: https://localhost/app_lcm/v1
variables: {}
- 'app-lcm'
summary: 'Create an application instance resource'
description: Create an application instance resource
$ref: '#/components/schemas/CreateAppInstanceRequest'
required: true
description: An application instance identifier and the related resource has been created successfully.
headers: {}
application/json:
$ref: '#/components/schemas/AppInstanceInfo'
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
- 'app-lcm'
summary: 'Queries information relating to on-boarded application packages in the MEO'
description: queries information relating to on-boarded application packages in the MEO
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
- name: filter
in: query
description: Attribute-based filtering parameters according to ETSI GS MEC 009
style: form
explode: true
schema:
type: string
- name: all_fields
in: query
description: Include all complex attributes in the response.
style: form
explode: true
schema:
type: string
- name: fields
in: query
description: Complex attributes of AppPkgInfo to be included into the response
style: form
explode: true
schema:
type: string
- name: exclude_fields
in: query
description: Complex attributes of AppPkgInfo to be excluded from the response.
style: form
explode: true
schema:
type: string
- name: exclude_default
in: query
description: Indicates to exclude the following complex attributes of AppPkgInfo from the response.
style: form
explode: true
schema:
type: string
description: Array the representations of zero or more application instances
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppInstanceInfo'
description: ''
contentMediaType: application/json
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/app_instances/{appInstanceId}:
- 'app-lcm'
summary: 'Retrieves the information of an individual application instance via reading an individual application instance.'
description: Retrieves the information of an individual application instance via reading an individual application instance.
parameters:
- name: appInstanceId
in: path
description: Identifier of an individual application instance
required: true
style: simple
schema:
type: string
description: Contains a representation of the read resource.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppInstanceInfo'
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
- 'app-lcm'
summary: 'Deletes an individual application instance resource.'
description: Deletes an individual application instance resource.
parameters:
- name: appInstanceId
in: path
description: Identifier of an individual application instance
required: true
style: simple
schema:
type: string
description: No Content
headers: {}
content: {}
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/subscriptions:
- 'app-lcm-notifications'
summary: 'subscribe to the notification of application instance related change'
description: subscribe to the notification of application instance related change
- $ref: '#/components/schemas/AppInstSubscriptionRequest'
- $ref: '#/components/schemas/AppLcmOpOccSubscriptionRequest'
- $ref: '#/components/schemas/AppInstIdCreationSubscriptionRequest'
- $ref: '#/components/schemas/AppInstIdDeletionSubscriptionRequest'
contentMediaType: application/json
required: true
description: a representation of the created SubscriptionInfo.
headers: {}
oneOf:
- $ref: '#/components/schemas/AppInstSubscriptionInfo'
- $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo'
- $ref: '#/components/schemas/AppInstIdCreationSubscriptionInfo'
- $ref: '#/components/schemas/AppInstIdDeletionSubscriptionInfo'
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
callbacks:
notification:
'{$request.body#/callbackUri}':
post:
summary: 'Callback POST used to send a notification'
description: 'Notification for informing the subscribers about operational state of application instance resources or state changes of an application LCM operation occurrence. It depends on subscription type.'
operationId: notificationPOST
requestBody:
description: Subscription notification
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AppInstNotification'
- $ref: '#/components/schemas/AppLcmOpOccNotification'
responses:
'204':
description: "No content"
- 'app-lcm-notifications'
summary: 'Retrieves the information of multiple subscriptions to notifications related to an application instance.'
description: Retrieves the information of multiple subscriptions to notifications related to an application instance.
- name: subscriptionType
in: query
description: Query parameter to filter on a specific subscription type.
style: form
explode: true
schema:
$ref: '#/components/schemas/AppInstanceSubscriptionType'
description: List of all subscriptions is returned.
headers: {}
$ref: '#/components/schemas/AppInstanceSubscriptionLinkList'
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/subscriptions/{subscriptionId}:
- 'app-lcm-notifications'
summary: 'Used to represent an individual subscription to notifications about application package changes.'
description: Used to represent an individual subscription to notifications about application package changes.
operationId: individualSubscriptionGET
parameters:
- name: subscriptionId
in: path
description: Represents an individual subscription to notification related to an application instance
required: true
style: simple
schema:
type: string
description: Representation of the resource.
headers: {}
- $ref: '#/components/schemas/AppInstSubscriptionInfo'
- $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo'
- $ref: '#/components/schemas/AppInstIdCreationSubscriptionInfo'
- $ref: '#/components/schemas/AppInstIdDeletionSubscriptionInfo'
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
- 'app-lcm-notifications'
summary: 'Deletes the individual subscription to notifications about application package changes in MEO.'
description: Deletes the individual subscription to notifications about application package changes in MEO.
parameters:
- name: subscriptionId
in: path
description: Represents an individual subscription to notification related to an application instance
required: true
style: simple
schema:
type: string
description: No Content
headers: {}
content: {}
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/user_defined_notification:
- 'app-lcm-notifications'
summary: 'Delivers a notification from the application lifecycle management resource to the subscriber.'
description: Delivers a notification from the application lifecycle management resource to the subscriber.
- $ref: '#/components/schemas/AppInstNotification'
- $ref: '#/components/schemas/AppLcmOpOccNotification'
- $ref: '#/components/schemas/AppInstanceIdentifierCreationNotification'
- $ref: '#/components/schemas/AppInstanceIdentifierDeletionNotification'
contentMediaType: application/json
required: true
description: No Content
headers: {}
content: {}
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/app_instances/{appInstanceId}/instantiate:
post:
tags:
- 'app-lcm'
summary: 'Deletes the individual subscription to notifications about application package changes in MEO.'
description: task of instantiating an application instance.
parameters:
- name: appInstanceId
in: path
description: Identifier of an individual application instance
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/InstantiateAppRequest'
description: accepted for processing, but the processing has not yet been completed.
headers: {}
content: {}
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
piscione
committed
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
787
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
837
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
888
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
921
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
954
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
989
990
991
992
993
994
995
996
997
998
999
1000
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
## Resources of application lifecycle management on Mm1
/app_instances/{appInstanceId}/terminate:
post:
tags:
- 'app-lcm'
summary: 'terminate an application instance.'
description: terminate an application instance.
operationId: appLcmTerminatePOST
parameters:
- name: appInstanceId
in: path
description: Identifier of an individual application instance
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/TerminateAppRequest'
required: true
responses:
'202':
description: accepted for processing, but the processing has not yet been completed.
headers: {}
content: {}
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
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.'
headers: {}
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.'
headers: {}
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'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/app_instances/{appInstanceId}/operate:
post:
tags:
- 'app-lcm'
summary: 'change the operational state, i.e. start or stop, of the application instance'
description: change the operational state, i.e. start or stop, of the application instance
operationId: appLcmOperatePOST
parameters:
- name: appInstanceId
in: path
description: Identifier of an individual application instance
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OperateAppRequest'
required: true
responses:
'202':
description: accepted for processing, but the processing has not yet been completed.
headers: {}
content: {}
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
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.'
headers: {}
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.'
headers: {}
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'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/app_lcm_op_occs:
get:
tags:
- 'app-lcm'
summary: 'retrieves information of operation status about multiple application instance lifecycle management operation occurrences'
description: retrieves information of operation status about multiple application instance lifecycle management operation occurrences
operationId: appLcmOpOccsGET
parameters:
- name: filter
in: query
description: Attribute-based filtering parameters according to ETSI GS MEC 009
style: form
explode: true
schema:
type: string
- name: all_fields
in: query
description: Include all complex attributes in the response.
style: form
explode: true
schema:
type: string
- name: fields
in: query
description: Complex attributes of AppLcmOpOcc to be excluded from the response.
style: form
explode: true
schema:
type: string
- name: exclude_fields
in: query
description: Complex attributes of AppLcmOpOcc to be excluded from the response.
style: form
explode: true
schema:
type: string
- name: exclude_default
in: query
description: Indicates to exclude the following complex attributes of AppLcmOpOcc from the response.
style: form
explode: true
schema:
type: string
responses:
'200':
description: Status information for zero or more application instance lifecycle management operation occurrences was queried successfully
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppLcmOpOcc'
description: ''
contentMediaType: application/json
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
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.'
headers: {}
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.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/app_lcm_op_occs/{appLcmOpOccId}:
get:
tags:
- 'app-lcm'
summary: 'reads the status information of an individual application LCM operation occurrence'
description: reads the status information of an individual application LCM operation occurrence
operationId: appLcmOpOccsbyIdGET
parameters:
- name: appLcmOpOccId
in: path
description: Identifies an individual application LCM operation occurrence
required: true
style: simple
schema:
type: string
responses:
'200':
description: Information about an application LCM operation occurrence was read successfully
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppLcmOpOcc'
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
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.'
headers: {}
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.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/app_lcm_op_occs/{appLcmOpOccId}/cancel:
post:
tags:
- 'app-lcm'
summary: 'cancel an ongoing application lifecycle operation whose related "Individual application LCM operation occurrence" resource is in "PROCESSING" state.'
description: cancel an ongoing application lifecycle operation whose related "Individual application LCM operation occurrence" resource is in "PROCESSING" state.
operationId: appLcmCancelPOST
parameters:
- name: appLcmOpOccId
in: path
description: Identifies an individual application LCM operation occurrence
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CancelMode'
required: true
responses:
'202':
description: The request was accepted for processing, but it is possible that the processing is not yet completed.
headers: {}
content: {}
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
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.'
headers: {}
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.'
headers: {}
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'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/app_lcm_op_occs/{appLcmOpOccId}/fail:
post:
tags:
- 'app-lcm'
summary: marks an application lifecycle management operation occurrence as "finally failed"
description: marks an application lifecycle management operation occurrence as "finally failed"
operationId: appLcmFailPOST
parameters:
- name: appLcmOpOccId
in: path
description: Identifies an individual application LCM operation occurrence
required: true
style: simple
schema:
type: string
responses:
'202':
description: Shall be returned when the state of the application lifecycle management operation occurrence has been changed successfully
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppLcmOpOcc'
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
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.'
headers: {}
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.'
headers: {}
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'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/app_lcm_op_occs/{appLcmOpOccId}/retry:
post:
tags:
- 'app-lcm'
summary: initiate retrying an application lifecycle operation that has experience a temporary failure
description: initiate retrying an application lifecycle operation that has experience a temporary failure
operationId: appLcmRetryPOST
parameters:
- name: appLcmOpOccId
in: path
description: Identifies an individual application LCM operation occurrence
required: true
style: simple
schema:
type: string
responses:
'202':
description: The request was accepted for processing, but it is possible that the processing is not yet completed
headers: {}
content: {}
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
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.'
headers: {}
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.'
headers: {}
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'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
## Resources of MEPM's application lifecycle management on Mm3
/app_instances/{appInstanceId}/configure_platform_for_app:
post:
tags:
- 'app-lcm'
summary: provide configuration information in AppD to the MEPM-V, intended to configure the MEP to run the application instance.
description: provide configuration information in AppD to the MEPM-V, intended to configure the MEP to run the application instance.
operationId: appInstancesConfigPlatformPOST
parameters:
- name: appInstanceId
in: path
description: The identifier of the application instance.
required: true
style: simple
schema:
type: string
requestBody:
description: The payload body in the request contains the information necessary to provide configuration information in AppD
content:
application/json:
schema:
$ref: './definitions/MEC010p2_definitions.yaml#/definitions/ConfigPlatformForAppRequest'
piscione
committed
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
responses:
'202':
description: The request was accepted for processing, but it is possible that the processing is not yet completed
headers: {}
content: {}
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
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.'
headers: {}
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.'
headers: {}
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'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
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
components:
schemas:
AppLcmOpOcc:
title: AppLcmOpOcc
required:
- id
- operationState
- stateEnteredTime
- startTime
- lcmOperation
- _links
type: object
properties:
id:
type: string
description: "'Identifier of the subscription to application LCM operation occurrence notification'"
operationState:
$ref: '#/components/schemas/OperationState'
stateEnteredTime:
$ref: '#/components/schemas/TimeStamp'
startTime:
$ref: '#/components/schemas/TimeStamp'
lcmOperation:
$ref: '#/components/schemas/LcmOperation'
operationParams:
$ref: '#/components/schemas/OperationParams'
isCancelPending:
type: boolean
description: If the application LCM operation occurrence operationState is in "PROCESSING" state and the operation is being cancelled, this attribute shall be set to true. Otherwise, it shall be set to false.
cancelMode:
$ref: '#/components/schemas/CancelMode'
_links:
$ref: '#/components/schemas/AppInstanceLcmOpOcc.links'
description: "'This data type represents an application lifecycle management operation occurrence'"
AppInstanceSubscriptionLinkList:
required:
- _links
properties:
_links:
$ref: '#/components/schemas/AppInstanceSubscriptionLinkList._links'
AppInstanceSubscriptionLinkList._links:
required:
- self
type: object
properties:
self:
type: string
description: URI referring to a resource
subscriptions:
type: array
items:
$ref: '#/components/schemas/AppInstanceSubscriptionLinkList._links.subscriptions'
AppInstanceSubscriptionLinkList._links.subscriptions:
type: object
required:
- href
- subscriptionType
properties:
href:
subscriptionType:
$ref: '#/components/schemas/AppInstanceSubscriptionType'
AppInstanceSubscriptionType:
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
description: String representing the type of a subscription.
enum:
- AppInstanceStateChangeSubscription
- AppLcmOpOccStateChangeSubscription
- AppIdentifierCreationSubscription
- AppIdentifierDeletionSubscription
OperationParams:
oneOf:
- $ref: '#/components/schemas/InstantiateAppRequest'
- $ref: '#/components/schemas/OperateAppRequest'
- $ref: '#/components/schemas/TerminateAppRequest'
CancelMode:
description: Indicates the intervention action to be taken. GRACEFUL Indicates ongoing resource management operations in the underlying system are allowed to complete execution or time out. FORCED Indicates ongoing resource management operations in the underlying system are to be cancelled without allowing them to complete execution or time out.
type: string
enum:
- GRACEFUL
- FORCED
AppInstIdCreationSubscriptionRequest:
type: object
required:
- subscriptionType
- callbackUri
properties:
subscriptionType:
type: string
callbackUri:
appInstanceSubscriptionFilter:
$ref: '#/components/schemas/AppInstanceSubscriptionFilter'
AppInstIdDeletionSubscriptionRequest:
type: object
required:
- subscriptionType
- callbackUri
properties:
subscriptionType:
type: string
description: Shall be set to "AppIdentifierDeletionSubscription".
callbackUri:
appInstanceSubscriptionFilter:
$ref: '#/components/schemas/AppInstanceSubscriptionFilter'
AppInstIdCreationSubscriptionInfo:
type: object
required:
- id
- subscriptionType
- callbackUri
- _links
properties:
id:
type: string
subscriptionType:
type: string
callbackUri:
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
appInstanceSubscriptionFilter:
$ref: '#/components/schemas/AppInstanceSubscriptionFilter'
_links:
type: object
required:
- self
properties:
self:
$ref: '#/components/schemas/LinkType'
AppInstIdDeletionSubscriptionInfo:
type: object
required:
- id
- subscriptionType
- callbackUri
- _links
properties:
id:
type: string
subscriptionType:
type: string
description: Shall be set to "AppIdentifierDeletionSubscription".
callbackUri:
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
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
appInstanceSubscriptionFilter:
$ref: '#/components/schemas/AppInstanceSubscriptionFilter'
_links:
type: object
required:
- self
properties:
self:
$ref: '#/components/schemas/LinkType'
AppInstanceLcmOpOcc.links:
title: AppInstanceLcmOpOcc.links
required:
- self
- appInstance
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
appInstance:
$ref: '#/components/schemas/LinkType'
description: Links to resources related to this resource.
AppLcmOpOccSubscriptionInfo:
title: AppLcmOpOccSubscriptionInfo
required:
- id
- subscriptionType
- callbackUri
- _links
type: object
properties:
id:
type: string
description: Identifier of this subscription resource.
subscriptionType:
const: AppLcmOpOccStateChange
type: string
description: Shall be set to "AppLcmOpOccStateChangeSubscription".
examples:
- AppLcmOpOccStateChange
callbackUri:
type: string
description: The URI of the endpoint for the notification to be sent to.
appLcmOpOccSubscriptionFilter:
$ref: '#/components/schemas/AppLcmOpOccSubscriptionFilter'
description: Criteria used to select application LCM operation occurrences on which to send notifications related to this subscription.
_links:
$ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo.links'
description: "'This data type represents a subscription to notifications of application life cycle management operation occurrence'"
title: AppLcmOpOccSubscriptionInfo.links
properties:
self:
$ref: '#/components/schemas/LinkType'
description: Links to resources related to this resource.
- id
- subscriptionType
- callbackUri
- _links
type: object
type: string
description: "'Identifier of the subscription to application instance operational state change notification.'"
const: AppInstanceStateChange
type: string
description: Shall be set to "AppInstanceStateChangeSubscription".
- AppInstanceStateChangeSubscription
appInstanceState:
type: string
enum:
- NOT_INSTANTIATED
- STARTED
- STOPPED
appInstanceSubscriptionFilter:
$ref: '#/components/schemas/AppInstanceSubscriptionFilter'
description: The URI of the endpoint for the subscription related notification to be sent to.
_links:
$ref: '#/components/schemas/AppInstSubscriptionInfo.links'
description: "'The data type represents a subscription to notification of application instance operational state change.'"
title: AppInstSubscriptionInfo.links
required:
- self
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
description: Links to resources related to this resource.
AppLcmOpOccSubscriptionRequest:
title: AppLcmOpOccSubscriptionRequest
- callbackUri
- subscriptionType
type: object
properties:
appLcmOpOccSubscriptionFilter:
$ref: '#/components/schemas/AppLcmOpOccSubscriptionFilter'
callbackUri:
description: Shall be set to "AppLcmOpOccStateChangeSubscription".
title: AppLcmOpOccSubscriptionFilter
type: object
properties:
appInstanceSubscriptionFilter:
$ref: '#/components/schemas/AppInstanceSubscriptionFilter'
notificationTypes:
description: Match particular notification types. Permitted values AppLcmOpOccNotification.
$ref: '#/components/schemas/NotificationTypes'
operationStates:
$ref: '#/components/schemas/OperationStates'
operationTypes:
$ref: '#/components/schemas/OperationTypes'
NotificationTypes:
title: NotificationTypes
const: AppLcmOperationOccurrenceNotification
description: Match particular notification types.
examples:
- AppLcmOperationOccurrenceNotification
- STARTING
- PROCESSING
- COMPLETED
- FAILED
description: "'Type of the LCM operation state represented by this application instance LCM operation occurrence.'"
examples:
- STARTING
OperationTypes:
title: OperationTypes
- INSTANTIATE
- OPERATE
- TERMINATE
type: string
description: "'Type of the LCM operation represented by this application instance LCM operation occurrence.'"
examples:
- INSTANTIATE
MepInformation:
type: object
required:
- mepId
properties:
mepId:
type: string
description: Deployment-specific identifier of MEC platform.
mepName:
type: string
description: Human-readable name of MEC platform
title: CreateAppInstanceRequest
required:
- appDId
type: object
description: The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way.
description: Human-readable description of the application instance to be created.
description: Human-readable name of the application instance to be created.
appPlacementInfo:
description: Describes the information of selected MEC platform for the application instance to associate
$ref: '#/components/schemas/MepInformation'
- subscriptionType
- callbackUri
type: object
const: AppInstanceStateChange
type: string
description: Shall be set to "AppInstanceStateChangeSubscription".
examples:
- AppInstanceStateChange
type: string
description: The URI of the endpoint for the notification to be sent to.
appInstanceState:
$ref: '#/components/schemas/AppInstanceState'
appInstanceSubscriptionFilter:
$ref: '#/components/schemas/AppInstanceSubscriptionFilter'
AppInstanceSubscriptionFilter:
title: AppInstanceSubscriptionFilter
- appInstSelectorType
type: object
properties:
appInstSelectorType:
$ref: '#/components/schemas/AppInstSelectorType'
appInstances:
type: array
items:
type: array
items:
$ref: '#/components/schemas/AppsFromProviders'
description: ''
description: "'This data type represents subscription filter criteria to match application instances. '"
type: string
description: Provider of the application and of the AppD.
appProducts:
$ref: '#/components/schemas/AppProducts'
description: "'Present only if appInstIdSelector = APP_FROM_PROVIDER. Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers.'"
type: string
description: Name to identify the MEC application.
versions:
$ref: '#/components/schemas/AppProducts.Versions'
description: "'If present, match application instances that belong to application products with certain product names, from one particular provider.'"
type: string
description: Identifies the version of software of the MEC application.
type: string
description: ''
description: "'If present, match application instances that belong to application products with certain versions and a certain product name, from one particular provider.'"
- VOID
- APP_IDENTITY
- APP_NAME
- APP_D_ID
- APP_FROM_PROVIDER
description: 0 = void
examples:
- VOID
AppInstanceState:
title: AppInstanceState
- NOT_INSTANTIATED
- STARTED
- STOPPED
type: string
description: Only send notifications for application instances that are in one of the states listed in this attribute. If this attribute is absent, match all states.
examples:
- NOT_INSTANTIATED
title: AppInstNotification
required:
- _links
- appDId
- appInstanceId
- appPkgId
- id
- notificationType
- subscriptionId
- timeStamp
type: object
description: The application descriptor identifier identifies the application package and the application descriptor in a globally unique way.
description: Identifier of application instance.
description: Identifier of the onboarded application package.
description: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "notificationId" attribute of all these notifications shall have the same value.
type: string
description: Discriminator for the different notification types. Shall be set to "AppInstanceStateChangeSubscription" for this notification type.
description: Identifier of the subscription related to this notification.
timeStamp:
$ref: '#/components/schemas/TimeStamp'
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
appInstLocation:
$ref: '#/components/schemas/LocationInformation'
appInstanceState:
type: string
enum:
- NOT_INSTANTIATED
- STARTED
- STOPPED
LocationInformation:
type: object
required:
- countryCode
properties:
countryCode:
type: string
civicAddress:
$ref: '#/components/schemas/LocationInformation.civicAddress'
geographicalPosition:
type: string
LocationInformation.civicAddress:
type: object
required:
- civicAddressElement
properties:
civicAddressElement:
type: array
items:
$ref: '#/components/schemas/CivicAddressElement'
AppInstanceInfo:
title: AppInstanceInfo
- appProvider
- appName
- appSoftVersion
- appDVersion
- appPkgId
- instantiationState
type: string
description: Identifier of application instance.
type: string
description: Name of the application instance.
type: string
description: Human-readable description of the application instance to be created.
type: string
description: Identifier of this MEC application descriptor. This attribute shall be globally unique.
type: string
description: Provider of the application and of the AppD.
type: string
description: Name to identify the MEC application.
type: string
description: Identifies the version of software of the MEC application.
type: string
description: Identifies the version of the application descriptor.
type: string
description: Identifier of the onboarded application package.
$ref: '#/components/schemas/VimConnectionInfo'
description: ''
instantiationState:
$ref: '#/components/schemas/InstantiationState'
instantiatedAppState:
$ref: '#/components/schemas/InstantiatedAppState'
_links:
$ref: '#/components/schemas/AppInstanceInfo.links'
description: "'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'"
- STARTING
- PROCESSING
- COMPLETED
- FAILED
description: Operation state
examples:
- STARTING
- NOT_INSTANTIATED
- INSTANTIATED
type: string
description: Instantiation state of the application instance
examples:
- NOT_INSTANTIATED
- operationalState
type: object
properties:
operationalState:
$ref: '#/components/schemas/OperationalState'
description: "'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.'"
- STARTED
- STOPPED
type: string
description: Operational state is applicable in the instantiation state INSTANTIATED
examples:
- STARTED
properties:
self:
$ref: '#/components/schemas/LinkType'
instantiate:
$ref: '#/components/schemas/LinkType'
terminate:
$ref: '#/components/schemas/LinkType'
operate:
$ref: '#/components/schemas/LinkType'
description: Links to resources related to this resource.
- INSTATIATE
- OPERATE
- TERMINATE
type: string
description: Type of the actual LCM operation represented by this application instance LCM operation occurrence
examples:
- INSTATIATE
- operationType
- operationState
- subscriptionId
- timeStamp
- appLcmOpOccId
- appInstanceId
- _links
type: object
type: string
description: "''"
type: string
description: Discriminator for the different notification types. Shall be set to "AppLcmOpOccStateChangeSubscription" for this notification type.
operationType:
type: string
description: Type of the LCM operation represented by this application instance LCM operation occurrence.
enum:
- INSTANTIATE
- OPERATE
- TERMINATE
operationState:
type: string
enum:
- STARTING
- PROCESSING
- COMPLETED
- FAILED
- FAILED_TEMP
type: string
description: Identifier of the subscription related to this notification.
timeStamp:
$ref: '#/components/schemas/TimeStamp'
appLcmOpOccId:
type: string
description: Identifier of application lifecycle management operation occurrence.
type: string
description: Identifier of application instance.
_links:
$ref: '#/components/schemas/AppLcmOpOccNotification.links'
description: "'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers'"
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
AppInstanceIdentifierCreationNotification:
title: AppInstanceIdentifierCreationNotification
required:
- id
- notificationType
- subscriptionId
- timeStamp
- appInstanceId
- _links
type: object
properties:
id:
type: string
notificationType:
type: string
description: Discriminator for the different notification types. Shall be set to "AppIdentifierCreationSubscription" for this notification type.
subscriptionId:
type: string
timeStamp:
$ref: '#/components/schemas/TimeStamp'
appInstanceId:
type: string
_links:
$ref: '#/components/schemas/Notification._links'
Notification._links:
type: object
required:
- subscription
- appInstance
properties:
subscription:
$ref: '#/components/schemas/LinkType'
appInstance:
$ref: '#/components/schemas/LinkType'
AppInstanceIdentifierDeletionNotification:
title: AppInstanceIdentifierDeletionNotification
required:
- id
- notificationType
- subscriptionId
- timeStamp
- appInstanceId
- _links
type: object
properties:
id:
type: string
notificationType:
type: string
description: Discriminator for the different notification types. Shall be set to "AppIdentifierDeletionSubscription" for this notification type.
subscriptionId:
type: string
timeStamp:
$ref: '#/components/schemas/TimeStamp'
appInstanceId:
type: string
_links:
$ref: '#/components/schemas/Notification._links'
title: AppLcmOpOccNotification.links
- appInstance
- subscription
- appLcmOpOcc
type: object
properties:
appInstance:
$ref: '#/components/schemas/LinkType'
subscription:
$ref: '#/components/schemas/LinkType'
appLcmOpOcc:
$ref: '#/components/schemas/LinkType'
description: Links to resources related to this resource.
title: InstantiateAppRequest
required:
- selectedMECHostInfo
type: object
properties:
locationConstraints:
$ref: '#/components/schemas/LocationConstraints'
selectedMECHostInfo:
type: array
items:
$ref: '#/components/schemas/MECHostInformation'
description: Describes the information of selected host for the application instance. See note 2.
vimConnectionInfo:
items:
$ref: '#/components/schemas/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.
description: Describes CPU and memory requirements, as well as optional additional requirements, such as disk and acceleration related capabilities, of the virtualisation container used to realize the application instance to be created. This attribute may be provided in the InstantiateAppRequest structure to override the same attribute in the AppD.
items:
type: string
description: Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1.
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
appTermCandsForCoord:
$ref: '#/components/schemas/AppTermCandsForCoord'
AppTermCandsForCoord:
type: object
required:
- terminationOptions
properties:
terminationOptions:
type: array
items:
$ref: '#/components/schemas/AppTermCandsForCoord.terminationOptions'
AppTermCandsForCoord.terminationOptions:
type: object
required:
- appInstIdTerminationCands
properties:
appInstIdTerminationCands:
type: array
items:
type: string
type: object
properties:
href:
type: string
description: URI referring to a resource
title: LocationConstraints
type: object
type: string
description: The two-letter ISO 3166 country code in capital letters.
civicAddressElement:
type: array
items:
$ref: '#/components/schemas/CivicAddressElement'
area:
type: object
description: Geographic area. Shall be absent if the "civicAddressElement" attribute is present. The content of this attribute shall follow the provisions for the "Polygon" geometry object as defined in IETF RFC 7946 [8], for which
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'"
- caType
- caValue
type: object
type: integer
description: "'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.'"
contentEncoding: int32
type: string
description: "'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.'"
description: "'The civic address.'"
title: MECHostInformation
required:
- hostId
type: object
description: Deployment-specific information to identify a MEC host. This information can be structured to cater for host identification schemes that are more complex than a simple identifier, e.g. when referring to the structure of an NFVI.
description: Human-readable name of MEC host.
OperateAppRequest:
title: OperateAppRequest
type: object
properties:
changeStateTo:
$ref: '#/components/schemas/ChangeStateTo'
gracefulStopTimeout:
type: integer
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.
contentEncoding: int32
stopType:
$ref: '#/components/schemas/StopType'
StopType:
description: Signals forceful or graceful stop
examples:
- FORCEFUL
ChangeStateTo:
title: ChangeStateTo
- STARTED
- STOPPED
type: string
description: The desired operational state
examples:
- STARTED
title: ProblemDetails
type: object
description: A human-readable explanation specific to this occurrence of the problem
description: A URI reference that identifies the specific occurrence of the problem
description: The HTTP status code for this occurrence of the problem
contentEncoding: int32
description: A short, human-readable summary of the problem type
description: A URI reference according to IETF RFC 3986 that identifies the problem type
title: TerminateAppRequest
required:
- terminationType
type: object
properties:
gracefulTerminationTimeout:
type: integer
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."
contentEncoding: int32
terminationType:
$ref: '#/components/schemas/TerminationType'
type: object
properties:
nanoSeconds:
type: integer
description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
contentEncoding: int32
description: The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
contentEncoding: int32
- FORCEFUL
- GRACEFUL
type: string
description: "'Indicates whether forceful or graceful termination is requested.'"
examples:
- FORCEFUL
title: VimConnectionInfo
required:
- id
- vimType
type: object
type: object
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
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'"
description: The identifier of the VIM Connection. This identifier is managed by the MEO.
type: object
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'"
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.
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.
Links:
title: Links
properties:
subscription:
$ref: '#/components/schemas/LinkType'
description: Links to resources related to this notification.
piscione
committed