Newer
Older
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
"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": "./MEC010p2_definitions.yaml#/definitions/ConfigPlatformForAppRequest"
}
}
}
},
"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.",
"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"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated": false
},
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
}
},
"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": {
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
},
"subscriptionType": {
"$ref": "#/components/schemas/AppInstanceSubscriptionType"
}
}
},
"AppInstanceSubscriptionType": {
"type": "string",
"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": {
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
},
"appInstanceSubscriptionFilter": {
"$ref": "#/components/schemas/AppInstanceSubscriptionFilter"
}
}
},
"AppInstIdCreationSubscriptionInfo": {
"type": "object",
"required": [
"id",
"subscriptionType",
"callbackUri",
"_links"
],
"properties": {
"id": {
"type": "string"
},
"subscriptionType": {
"type": "string"
},
"callbackUri": {
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
},
"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": {
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
},
"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": {
"required": [
"id",
"subscriptionType",
"callbackUri",
"_links"
],
"properties": {
"id": {
"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'"
},
"AppLcmOpOccSubscriptionInfo.links": {
"title": "AppLcmOpOccSubscriptionInfo.links",
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
"description": "Links to resources related to this resource."
},
"AppInstSubscriptionInfo": {
"required": [
"id",
"subscriptionType",
"callbackUri",
"_links"
],
"properties": {
"id": {
"type": "string",
"description": "'Identifier of the subscription to application instance operational state change notification.'"
},
"subscriptionType": {
"const": "AppInstanceStateChange",
"type": "string",
"description": "Shall be set to \"AppInstanceStateChangeSubscription\".",
"AppInstanceStateChangeSubscription"
"appInstanceState": {
"type": "string",
"enum": [
"NOT_INSTANTIATED",
"STARTED",
"STOPPED"
]
},
"appInstanceSubscriptionFilter": {
"$ref": "#/components/schemas/AppInstanceSubscriptionFilter"
},
"callbackUri": {
"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.'"
},
"AppInstSubscriptionInfo.links": {
"title": "AppInstSubscriptionInfo.links",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
"description": "Links to resources related to this resource."
},
"AppLcmOpOccSubscriptionRequest": {
"title": "AppLcmOpOccSubscriptionRequest",
"required": [
"callbackUri",
"subscriptionType"
],
"type": "object",
"properties": {
"appLcmOpOccSubscriptionFilter": {
"$ref": "#/components/schemas/AppLcmOpOccSubscriptionFilter"
},
"callbackUri": {
},
"subscriptionType": {
"type": "string",
"description": "Shall be set to \"AppLcmOpOccStateChangeSubscription\"."
},
"AppLcmOpOccSubscriptionFilter": {
"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",
"type": "string",
"description": "Match particular notification types.",
"examples": [
"AppLcmOperationOccurrenceNotification"
]
},
"OperationStates": {
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
],
"type": "string",
"description": "'Type of the LCM operation state represented by this application instance LCM operation occurrence.'",
"examples": [
"STARTING"
]
},
"OperationTypes": {
"enum": [
"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"
}
}
},
"CreateAppInstanceRequest": {
"title": "CreateAppInstanceRequest",
"required": [
"appDId"
],
"type": "object",
"properties": {
"appDId": {
"type": "string",
"description": "The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way."
},
"appInstanceDescription": {
"type": "string",
"description": "Human-readable description of the application instance to be created."
},
"appInstanceName": {
"type": "string",
"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"
},
"AppInstSubscriptionRequest": {
"required": [
"subscriptionType",
"callbackUri"
],
"properties": {
"subscriptionType": {
"const": "AppInstanceStateChange",
"type": "string",
"description": "Shall be set to \"AppInstanceStateChangeSubscription\".",
"examples": [
"AppInstanceStateChange"
]
},
"callbackUri": {
"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": {
"required": [
"appInstSelectorType"
],
"properties": {
"appInstSelectorType": {
"$ref": "#/components/schemas/AppInstSelectorType"
},
"appInstances": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
"appsFromProviders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppsFromProviders"
},
"description": "'This data type represents subscription filter criteria to match application instances. '"
},
"AppsFromProviders": {
"required": [
"appProvider"
],
"properties": {
"appProvider": {
"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.'"
},
"AppProducts": {
"required": [
"appName"
],
"properties": {
"appName": {
"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.'"
},
"AppProducts.Versions": {
"required": [
"appSoftVersion"
],
"properties": {
"appSoftVersion": {
"type": "string",
"description": "Identifies the version of software of the MEC application."
},
"appDVersion": {
"type": "array",
"items": {
"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.'"
},
"AppInstSelectorType": {
"enum": [
"VOID",
"APP_IDENTITY",
"APP_NAME",
"APP_D_ID",
"APP_FROM_PROVIDER"
],
"type": "string",
"description": "0 = void",
"examples": [
"VOID"
]
},
"AppInstanceState": {
"enum": [
"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"
]
},
"AppInstNotification": {
"title": "AppInstNotification",
"required": [
"_links",
"appDId",
"appInstanceId",
"appPkgId",
"id",
"notificationType",
"subscriptionId",
"timeStamp"
],
"type": "object",
"properties": {
"_links": {
},
"appDId": {
"type": "string",
"description": "The application descriptor identifier identifies the application package and the application descriptor in a globally unique way."
},
"appInstanceId": {
"type": "string",
"description": "Identifier of application instance."
},
"appPkgId": {
"type": "string",
"description": "Identifier of the onboarded application package."
},
"id": {
"type": "string",
"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."
},
"notificationType": {
"type": "string",
"description": "Discriminator for the different notification types. Shall be set to \"AppInstanceStateChangeSubscription\" for this notification type."
},
"subscriptionId": {
"type": "string",
"description": "Identifier of the subscription related to this notification."
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
},
"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": {
"required": [
"id",
"appDId",
"appProvider",
"appName",
"appSoftVersion",
"appDVersion",
"appPkgId",
"instantiationState",
"_links"
],
"properties": {
"id": {
"type": "string",
"description": "Identifier of application instance."
},
"appInstanceName": {
"type": "string",
"description": "Name of the application instance."
},
"appInstanceDescription": {
"type": "string",
"description": "Human-readable description of the application instance to be created."
},
"appDId": {
"type": "string",
"description": "Identifier of this MEC application descriptor. This attribute shall be globally unique."
},
"appProvider": {
"type": "string",
"description": "Provider of the application and of the AppD."
},
"appName": {
"type": "string",
"description": "Name to identify the MEC application."
},
"appSoftVersion": {
"type": "string",
"description": "Identifies the version of software of the MEC application."
},
"appDVersion": {
"type": "string",
"description": "Identifies the version of the application descriptor."
},
"appPkgId": {
"type": "string",
"description": "Identifier of the onboarded application package."
},
"vimConnectionInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VimConnectionInfo"
},
"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.'"
},
"OperationState": {
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
],
"type": "string",
"description": "Operation state",
"examples": [
"STARTING"
]
},
"InstantiationState": {
"enum": [
"NOT_INSTANTIATED",
"INSTANTIATED"
],
"type": "string",
"description": "Instantiation state of the application instance",
"examples": [
"NOT_INSTANTIATED"
]
},
"InstantiatedAppState": {
"required": [
"operationalState"
],
"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.'"
},
"OperationalState": {
"enum": [
"STARTED",
"STOPPED"
],
"type": "string",
"description": "Operational state is applicable in the instantiation state INSTANTIATED",
"examples": [
"STARTED"
]
},
"AppInstanceInfo.links": {
"required": [
"self"
],
"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."
},
"LcmOperation": {
"enum": [
"INSTATIATE",
"OPERATE",
"TERMINATE"
],
"type": "string",
"description": "Type of the actual LCM operation represented by this application instance LCM operation occurrence",
"examples": [
"INSTATIATE"
]
},
"AppLcmOpOccNotification": {
"required": [
"id",
"notificationType",
"operationType",
"operationState",
"subscriptionId",
"timeStamp",
"appLcmOpOccId",
"appInstanceId",
"_links"
],
"properties": {
"id": {
},
"notificationType": {
"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",