Newer
Older
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_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
parameters:
- name: appLcmOpOccId
in: path
description: Identifies an individual application LCM operation occurrence
required: true
style: simple
schema:
type: string
description: Information about an application LCM operation occurrence was read successfully
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppInstanceLcmOpOcc'
'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
parameters: []
- id
- operationState
- stateEnteredTime
- startTime
- lcmOperation
- _links
type: object
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'
_links:
$ref: '#/components/schemas/AppInstanceLcmOpOcc.links'
description: "'This data type represents an application lifecycle management operation occurrence'"
- INSTANTIATE
- OPERATE
- TERMINATE
type: string
description: "'Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation.'"
examples:
- INSTANTIATE
- self
- appInstance
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
appInstance:
$ref: '#/components/schemas/LinkType'
description: Links to resources related to this resource.
properties:
_links:
$ref: '#/components/schemas/SubscriptionLinkList.links'
description: "'The data type represents a subscription link list of notification on application lifecycle management. '"
properties:
self:
$ref: '#/components/schemas/LinkType'
subscriptions:
type: array
items:
$ref: '#/components/schemas/SubscriptionLinkList.links.subscriptions'
description: ''
description: Links to resources related to this resource.
title: SubscriptionLinkList.links.subscriptions
- href
- subscriptionType
type: object
$ref: '#/components/schemas/SubscriptionType'
description: A link list to the subscriptions
- id
- subscriptionType
- callbackUri
- _links
type: object
type: string
description: "''"
const: AppLcmOpOccStateChange
type: string
description: Shall be set to AppLcmOpOccStateChange.
examples:
- AppLcmOpOccStateChange
type: string
description: The URI of the endpoint for the notification to be sent to.
_links:
$ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo.links'
description: "'This data type represents a subscription to notifications of application life cycle management operation occurrence'"
title: AppLcmOpOcc.SubscriptionType
const: AppLcmOpOccStateChange
description: Shall be set to AppLcmOpOccStateChange.
examples:
- AppLcmOpOccStateChange
title: AppLcmOpOccSubscriptionInfo.links
properties:
self:
$ref: '#/components/schemas/LinkType'
description: Links to resources related to this resource.
- id
- subscriptionType
- notificationType
- 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 AppInstanceStateChange.
examples:
- AppInstanceStateChange
notificationType:
$ref: '#/components/schemas/AppInst.NotificationType'
callbackUri:
type: string
description: The URI of the endpoint for the 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: AppInst.SubscriptionType
const: AppInstanceStateChange
description: Shall be set to AppInstanceStateChange.
examples:
- AppInstanceStateChange
- NOT_INSTANTIATED
- STARTED
- STOPPED
description: Subscribed notification
examples:
- NOT_INSTANTIATED
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 "AppLcmOpOccStateChange".
title: AppLcmOpOccSubscriptionFilter
type: object
properties:
appInstanceSubscriptionFilter:
$ref: '#/components/schemas/AppInstanceSubscriptionFilter'
notificationTypes:
$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
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.
- subscriptionType
- callbackUri
type: object
const: AppInstanceStateChange
type: string
description: Shall be set to AppInstanceStateChange.
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.
notificationType:
$ref: '#/components/schemas/AppInst.NotificationType'
subscriptionId:
type: string
description: Identifier of the subscription related to this notification.
timeStamp:
$ref: '#/components/schemas/TimeStamp'
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
- id
- notificationType
- subscriptionId
- timeStamp
- appLcmOpOccId
- appInstanceId
- _links
type: object
type: string
description: "''"
notificationType:
$ref: '#/components/schemas/AppLcmOpOcc.NotificationType'
subscriptionId:
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'"
title: AppLcmOpOcc.NotificationType
- STARTING
- PROCESSING
- COMPLETED
- FAILED
description: Discriminator for the different notification types
examples:
- STARTING
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:
minItems: 1
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.
type: string
description: Ref NFV
virtualStorageDescriptor:
minItems: 0
type: array
items:
type: string
description: Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1.
LinkType:
title: LinkType
type: object
properties:
href:
type: string
description: URI referring to a resource
type: string
description: The two-letter ISO 3166 country code in capital letters.
civicAddressElement:
type: array
items:
$ref: '#/components/schemas/CivicAddressElement'
description: ''
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
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: 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.
SubscriptionType:
title: SubscriptionType
enum:
- AppInstanceStateChange
- AppLcmOpOccStateChange