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
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
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
2134
2135
2136
2137
2138
2139
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:
type: uri
appInstanceSubscriptionFilter:
$ref: '#/components/schemas/AppInstanceSubscriptionFilter'
AppInstIdDeletionSubscriptionRequest:
type: object
required:
- subscriptionType
- callbackUri
properties:
subscriptionType:
type: string
description: Shall be set to "AppIdentifierDeletionSubscription".
callbackUri:
type: uri
appInstanceSubscriptionFilter:
$ref: '#/components/schemas/AppInstanceSubscriptionFilter'
AppInstIdCreationSubscriptionInfo:
type: object
required:
- id
- subscriptionType
- callbackUri
- _links
properties:
id:
type: string
subscriptionType:
type: string
callbackUri:
type: uri
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:
type: uri
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'
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
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'"
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
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.
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
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