openapi: 3.1.0 info: 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' contact: name: ETSI Forge url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api email: cti_support@etsi.org version: '3.1.1' externalDocs: description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v3.1.1' url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/03.01.01_60/gs_MEC01002v030101p.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 servers: - url: https://localhost/app_lcm/v1 variables: {} paths: /app_instances: post: tags: - 'app-lcm' summary: 'Create an application instance resource' description: Create an application instance resource operationId: appInstancePOST parameters: [] requestBody: description: The POST method is used to create an application instance resource. content: application/json: schema: $ref: '#/components/schemas/CreateAppInstanceRequest' required: true responses: '201': description: An application instance identifier and the related resource has been created successfully. headers: {} content: application/json: schema: $ref: '#/components/schemas/AppInstanceInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false get: tags: - '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 operationId: appInstanceGET 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 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 responses: '200': description: Array the representations of zero or more application instances headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/AppInstanceInfo' description: '' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false parameters: [] /app_instances/{appInstanceId}: get: tags: - '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. operationId: appInstanceIdGET parameters: - name: appInstanceId in: path description: Identifier of an individual application instance required: true style: simple schema: type: string responses: '200': description: Contains a representation of the read resource. headers: {} content: application/json: schema: $ref: '#/components/schemas/AppInstanceInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false delete: tags: - 'app-lcm' summary: 'Deletes an individual application instance resource.' description: Deletes an individual application instance resource. operationId: appInstanceIdDELETE parameters: - name: appInstanceId in: path description: Identifier of an individual application instance required: true style: simple schema: type: string responses: '204': description: No Content headers: {} content: {} '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false parameters: [] /subscriptions: post: tags: - 'app-lcm-notifications' summary: 'subscribe to the notification of application instance related change' description: subscribe to the notification of application instance related change operationId: appLcmSubscriptionsPOST requestBody: description: '' content: application/json: schema: oneOf: - $ref: '#/components/schemas/AppInstSubscriptionRequest' - $ref: '#/components/schemas/AppLcmOpOccSubscriptionRequest' - $ref: '#/components/schemas/AppInstIdCreationSubscriptionRequest' - $ref: '#/components/schemas/AppInstIdDeletionSubscriptionRequest' required: true responses: '201': description: a representation of the created SubscriptionInfo. headers: {} content: application/json: schema: oneOf: - $ref: '#/components/schemas/AppInstSubscriptionInfo' - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo' - $ref: '#/components/schemas/AppInstIdCreationSubscriptionInfo' - $ref: '#/components/schemas/AppInstIdDeletionSubscriptionInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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" '404': description: "Not found" deprecated: false get: tags: - '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. operationId: appLcmSubscriptionsGET parameters: - name: subscriptionType in: query description: Query parameter to filter on a specific subscription type. style: form explode: true schema: $ref: '#/components/schemas/AppInstanceSubscriptionType' responses: '200': description: List of all subscriptions is returned. headers: {} content: application/json: schema: $ref: '#/components/schemas/AppInstanceSubscriptionLinkList' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false parameters: [] /subscriptions/{subscriptionId}: get: tags: - '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 responses: '200': description: Representation of the resource. headers: {} content: application/json: schema: oneOf: - $ref: '#/components/schemas/AppInstSubscriptionInfo' - $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo' - $ref: '#/components/schemas/AppInstIdCreationSubscriptionInfo' - $ref: '#/components/schemas/AppInstIdDeletionSubscriptionInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false delete: tags: - '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. operationId: individualSubscriptionDELETE parameters: - name: subscriptionId in: path description: Represents an individual subscription to notification related to an application instance required: true style: simple schema: type: string responses: '204': description: No Content headers: {} content: {} '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false parameters: [] /user_defined_notification: post: tags: - '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. operationId: appInstNotificationPOST parameters: [] requestBody: description: '' content: application/json: schema: oneOf: - $ref: '#/components/schemas/AppInstNotification' - $ref: '#/components/schemas/AppLcmOpOccNotification' - $ref: '#/components/schemas/AppInstanceIdentifierCreationNotification' - $ref: '#/components/schemas/AppInstanceIdentifierDeletionNotification' required: true responses: '204': description: No Content headers: {} content: {} '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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. operationId: appLcmInstanciatePOST 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/InstantiateAppRequest' required: true responses: '202': description: accepted for processing, but the processing has not yet been completed. headers: {} content: {} '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false parameters: [] ## 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': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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: '' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' 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 message content in the request contains the information necessary to provide configuration information in AppD content: application/json: schema: $ref: './definitions/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': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' deprecated: false parameters: [] 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: type: object description: Operation state $ref: '#/components/schemas/OperationState' stateEnteredTime: type: object description: Date and time when the current state was entered. $ref: '#/components/schemas/TimeStamp' startTime: type: object description: Date and time of the start of the operation. $ref: '#/components/schemas/TimeStamp' lcmOperation: type: object description: Date and time of the start of the operation. $ref: '#/components/schemas/LcmOperation' operationParams: type: object description: Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation. See note 2. $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: type: object description: The mode of a cancellation. $ref: '#/components/schemas/CancelMode' _links: type: object description: Links to resources related to this resource. $ref: '#/components/schemas/AppInstanceLcmOpOcc.links' description: | This data type represents an application lifecycle management operation occurrence NOTE 1: Void. NOTE 2: This object contains structured data, and shall comply with the provisions of clause 4 of IETF RFC 8259 AppInstanceSubscriptionLinkList: required: - _links properties: _links: type: object description: List of hyperlinks related to the resource. $ref: '#/components/schemas/AppInstanceSubscriptionLinkList._links' AppInstanceSubscriptionLinkList._links: required: - self type: object properties: self: type: string description: URI referring to a resource subscriptions: type: array description: A link list to the subscriptions. items: $ref: '#/components/schemas/AppInstanceSubscriptionLinkList._links.subscriptions' AppInstanceSubscriptionLinkList._links.subscriptions: type: object required: - href - subscriptionType properties: href: type: string format: uri description: The URI referring to the subscription. subscriptionType: type: object description: Type of the subscription. $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 description: Shall be set to "AppIdentifierCreationSubscription". callbackUri: type: string description: The URI of the endpoint for the subscription related notification to be sent to. format: uri appInstanceSubscriptionFilter: type: object description: Criteria used to filter application instances for which to send notifications related to this subscription. See note. $ref: '#/components/schemas/AppInstanceSubscriptionFilter' description: | NOTE: If present, the value of attribute "appInstSelectorType" in appInstanceSubscriptionFilter can only be set as "APP_D_ID" or "APP_FROM_PROVIDER". AppInstIdDeletionSubscriptionRequest: type: object required: - subscriptionType - callbackUri properties: subscriptionType: type: string description: Shall be set to "AppIdentifierDeletionSubscription". callbackUri: type: string format: uri description: The URI of the endpoint for the subscription related notification to be sent to. appInstanceSubscriptionFilter: type: object description: Criteria used to filter application instances for which to send notifications related to this subscription. $ref: '#/components/schemas/AppInstanceSubscriptionFilter' AppInstIdCreationSubscriptionInfo: type: object required: - id - subscriptionType - callbackUri - _links properties: id: type: string description: Identifier of the subscription to application instance operational state change notification. subscriptionType: type: string description: Shall be set to "AppIdentifierCreationSubscription". callbackUri: type: string format: uri description: The URI of the endpoint for the subscription related notification to be sent to. appInstanceSubscriptionFilter: type: object description: Criteria used to select application instances on which to send notifications related to this subscription. $ref: '#/components/schemas/AppInstanceSubscriptionFilter' _links: type: object description: Links to resources related to this resource. required: - self properties: self: type: object description: URI of this resource. $ref: '#/components/schemas/LinkType' AppInstIdDeletionSubscriptionInfo: type: object required: - id - subscriptionType - callbackUri - _links properties: id: type: string description: Identifier of the subscription to application instance operational state change notification. subscriptionType: type: string description: Shall be set to "AppIdentifierDeletionSubscription". callbackUri: type: string format: uri description: The URI of the endpoint for the subscription related notification to be sent to. appInstanceSubscriptionFilter: $ref: '#/components/schemas/AppInstanceSubscriptionFilter' _links: type: object description: Links to resources related to this resource. required: - self properties: self: type: object description: URI of this resource. $ref: '#/components/schemas/LinkType' AppInstanceLcmOpOcc.links: title: AppInstanceLcmOpOcc.links required: - self - appInstance type: object properties: self: type: object description: URI of this resource. $ref: '#/components/schemas/LinkType' appInstance: type: object description: Link to the application instance that the operation applies to. $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: type: object $ref: '#/components/schemas/AppLcmOpOccSubscriptionFilter' description: Criteria used to select application LCM operation occurrences on which to send notifications related to this subscription. _links: type: object $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 type: object properties: self: type: object description: URI of this resource. $ref: '#/components/schemas/LinkType' description: Links to resources related to this resource. AppInstSubscriptionInfo: title: AppInstSubscriptionInfo required: - id - subscriptionType - callbackUri - _links type: object 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". examples: - AppInstanceStateChangeSubscription appInstanceState: type: string description: Application instance state subscribed to. enum: - NOT_INSTANTIATED - STARTED - STOPPED appInstanceSubscriptionFilter: type: object description: Criteria used to select application instances on which to send notifications related to this subscription. $ref: '#/components/schemas/AppInstanceSubscriptionFilter' callbackUri: type: string description: The URI of the endpoint for the subscription related notification to be sent to. _links: type: object $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: type: object description: URI of this resource. $ref: '#/components/schemas/LinkType' description: Links to resources related to this resource. AppLcmOpOccSubscriptionRequest: title: AppLcmOpOccSubscriptionRequest required: - callbackUri - subscriptionType type: object properties: appLcmOpOccSubscriptionFilter: type: object description: Subscription filter criteria to match specific application LCM operation occurrences. $ref: '#/components/schemas/AppLcmOpOccSubscriptionFilter' callbackUri: type: string description: The URI of the endpoint for the subscription related notification to be sent to. subscriptionType: type: string description: Shall be set to "AppLcmOpOccStateChangeSubscription". AppLcmOpOccSubscriptionFilter: title: AppLcmOpOccSubscriptionFilter type: object properties: appInstanceSubscriptionFilter: type: object description: If present, this attribute contains filter criteria that selects one or more application instances on which to receive "LCM operation occurrence" notifications. $ref: '#/components/schemas/AppInstanceSubscriptionFilter' notificationTypes: type: string description: Match particular notification types. Permitted values AppLcmOpOccNotification. $ref: '#/components/schemas/NotificationTypes' operationStates: type: array description: Type of the LCM operation state represented by this application instance LCM operation occurrence. items: $ref: '#/components/schemas/OperationState' operationTypes: type: array description: Type of the LCM operation represented by this application instance LCM operation occurrence. items: $ref: '#/components/schemas/OperationTypes' NotificationTypes: title: NotificationTypes const: AppLcmOperationOccurrenceNotification type: string description: Match particular notification types. examples: - AppLcmOperationOccurrenceNotification OperationTypes: title: 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: type: object description: Describes the information of selected MEC platform for the application instance to associate. See note. $ref: '#/components/schemas/MepInformation' description: | NOTE: This field applies to Mm3* reference point only. AppInstSubscriptionRequest: title: AppInstSubscriptionRequest required: - subscriptionType - callbackUri type: object 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: type: object $ref: '#/components/schemas/AppInstanceState' appInstanceSubscriptionFilter: type: object description: Criteria used to filter application instances for which to send notifications related to this subscription. $ref: '#/components/schemas/AppInstanceSubscriptionFilter' AppInstanceSubscriptionFilter: title: AppInstanceSubscriptionFilter required: - appInstSelectorType type: object properties: appInstSelectorType: type: object $ref: '#/components/schemas/AppInstSelectorType' appInstances: type: array items: type: string description: | If appInstIdSelector = APP_IDENTITY match existing application instances with an "application instance identifier" listed in this attribute. If appInstIdSelector = APP_NAME match existing application instances with an "application instance name" listed in this attribute. If appInstIdSelector = APP_D_ID match existing application instances, or those created in the future whilst the subscription is active, based on the application descriptors identified by one of the "application descriptor identities" listed in this attribute. If appInstIdSelector = APP_FROM_PROVIDER this attribute shall not be included. appsFromProviders: type: array items: $ref: '#/components/schemas/AppsFromProviders' description: "'This data type represents subscription filter criteria to match application instances. '" AppsFromProviders: title: AppsFromProviders required: - appProvider type: object properties: appProvider: type: string description: Provider of the application and of the AppD. appProducts: type: array description: If present, match application instances that belong to application products with certain product names, from one particular provider. items: $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: title: AppProducts required: - appName type: object properties: appName: type: string description: Name to identify the MEC application. versions: type: array items: $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: title: AppProducts.Versions required: - appSoftVersion type: object 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: title: AppInstSelectorType enum: - VOID - APP_IDENTITY - APP_NAME - APP_D_ID - APP_FROM_PROVIDER type: string description: 0 = void examples: - VOID AppInstanceState: title: 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 - appInstanceState - appPkgId - id - notificationType - subscriptionId - timeStamp type: object properties: _links: type: object $ref: '#/components/schemas/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: type: object description: Date and time of the notification generation. $ref: '#/components/schemas/TimeStamp' appInstLocation: type: string description: Location of the MEC application instance. Shall be present if the application instance is instantiated and shall be absent otherwise. $ref: '#/components/schemas/LocationInformation' appInstanceState: type: string description: Application instance state enum: - NOT_INSTANTIATED - STARTED - STOPPED LocationInformation: type: object required: - countryCode properties: countryCode: type: string description: The two-letter ISO 3166 country code in capital letters where an instance is deployed. civicAddress: type: object description: Provides the civic address of the site hosting the MEC application instance. $ref: '#/components/schemas/LocationInformation.civicAddress' geographicalPosition: type: string description: Geographical position (i.e. latitude and longitude) where an instance is deployed. The content of this attribute shall follow the provisions for the "Point" geometry object as defined in IETF RFC 7946 description: | NOTE: At least one of civicAddress or geographicalPosition shall be present. If both are present they shall specify the same location, bound by the precision of the provided coordinates. McioInfo: type: object required: - mcioId - mcioName - mcioNamespace - vduId - cismId - mcioType - desiredInstances - availableInstances properties: mcioId: type: string description: Identifier of this MCIO, created by the CISM. mcioName: type: string description: Human readable name of this MCIO. mcioNamespace: type: string description: Namespace of this MCIO vduId: type: string description: Reference to the applicable Vdu information element in the VNFD. cismId: type: string description: Identifier of the CISM managing this MCIO. mcioType: type: string description: The type of MCIO. See note 1. desiredInstances: type: integer description: Number of desired MCIO instances. availableInstances: type: integer description: Number of available MCIO instances additionalInfo: type: string description: Additional information which is specific to the MCIO, its type, and which is available from the CISM. See note 2 description: | NOTE 1: The type of MCIO as specified in the declarative descriptor of the MCIO, and that can be read from the CISM. EXAMPLE: In case of MCIOs managed by Kubernetes®, the type of MCIO corresponds to the "kind" property of the declarative descriptor. NOTE 2: If the attribute additionalInfo is present, it may contain runtime information on the actual and desired state of the MCIO(s) LocationInformation.civicAddress: type: object required: - civicAddressElement properties: civicAddressElement: type: array description: Provides elements comprising a single civic address as described in section 3.4, with accompanying example in section 5 of IETF RFC 4776. items: $ref: '#/components/schemas/CivicAddressElement' AppInstanceInfo: title: AppInstanceInfo required: - id - appDId - appProvider - appName - appSoftVersion - appDVersion - appPkgId - instantiationState - _links type: object 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. nsInstanceId: type: string description: | Identifier of the NS instance created by NFVO in which the MEC application has been instantiated as a VNF instance. See note 2 vnfInstanceId: type: string description: | Identifier of the VNF instance created by VNFM that the MEC application has been instantiated as. See note 2. communicationInterface: type: string description: Interface for communication with other application instances. See clause 7.5.2 of ETSI GS MEC 021 [13] for the data type definition. items: $ref: '#/components/schemas/CommunicationInterface' 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' description: Information about VIM connections to be used for managing the resources for the application instance. The keys of the map, each of which identifies information about a particular VIM connection, are managed by the MEO and referenced from other data structures via the "vimConnectionId" attribute. See notes 1 and 3. 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. NOTE 1: This field does not apply if the data structure is used by MEAO. NOTE 2: This field applies if the data structure is used by MEAO. NOTE 3: This field does not apply if the data structure is used on Mm3*. NOTE 4: This field applies if the data structure is used on Mm3*. NOTE 5: This field applies if the data structure is used on Mm1 or Mm3*. NOTE 6: It is not specified in the present document how location information is obtained in the case of MEC in NFV. NOTE 7: This attribute reflects the ETSI NFV interpretation of the cloud native workloads. OperationState: title: OperationState enum: - STARTING - PROCESSING - COMPLETED - FAILED - FAILED_TEMP type: string description: Operation state examples: - STARTING InstantiationState: title: InstantiationState enum: - NOT_INSTANTIATED - INSTANTIATED type: string description: Instantiation state of the application instance examples: - NOT_INSTANTIATED InstantiatedAppState: title: InstantiatedAppState required: - operationalState type: object properties: operationalState: $ref: '#/components/schemas/OperationalState' appInstLocation: type: object description: Location of the MEC application instance. See note 5 and note 6. $ref: '#/components/schemas/LocationInformation' mcioInfo: type: array description: Information on the MCIO(s) representing application instance realized by one or a set of OS containers. See note 7. items: $ref: '#/components/schemas/McioInfo' description: "'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.'" OperationalState: title: OperationalState enum: - STARTED - STOPPED type: string description: Operational state is applicable in the instantiation state INSTANTIATED examples: - STARTED AppInstanceInfo.links: title: AppInstanceInfo.links required: - self type: object properties: self: type: object description: Self referring URI. $ref: '#/components/schemas/LinkType' instantiate: type: object description: Link to the "instantiate" task resource, if the related operation is possible based on the current status of this application instance resource (i.e. application instance in NOT_INSTANTIATED state). See note 3. $ref: '#/components/schemas/LinkType' terminate: type: object description: Link to the "terminate" task resource, if the related operation is possible based on the current status of this application instance resource (i.e. application instance is in INSTANTIATED state). $ref: '#/components/schemas/LinkType' operate: type: object description: Link to the "operate" task resource, if the related operation is supported for this application instance, and is possible based on the current status of this application instance resource (i.e. application instance is in INSTANTIATED state). $ref: '#/components/schemas/LinkType' configure_platform_for_app: type: object description: Link to the "configure_platform_for_app" task resource, if the related operation is supported for this application instance, and is possible based on the current status of this application instance resource (i.e. application instance is in INSTANTIATED state). See note 4 $ref: '#/components/schemas/LinkType' description: Links to resources related to this resource. LcmOperation: title: 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: title: AppLcmOpOccNotification required: - id - notificationType - operationType - operationState - subscriptionId - timeStamp - appLcmOpOccId - appInstanceId - _links type: object properties: 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 "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 description: Operation state. enum: - STARTING - PROCESSING - COMPLETED - FAILED - FAILED_TEMP subscriptionId: type: string description: Identifier of the subscription related to this notification. timeStamp: type: object description: Date and time of the notification generation. $ref: '#/components/schemas/TimeStamp' appLcmOpOccId: type: string description: Identifier of application lifecycle management operation occurrence. appInstanceId: type: string description: Identifier of application instance. _links: type: object $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'" AppInstanceIdentifierCreationNotification: title: AppInstanceIdentifierCreationNotification required: - id - notificationType - subscriptionId - timeStamp - appInstanceId - _links type: object properties: 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 "AppIdentifierCreationSubscription" for this notification type. subscriptionId: type: string description: Identifier of the subscription related to this notification. timeStamp: type: object description: Date and time of the notification generation. $ref: '#/components/schemas/TimeStamp' appInstanceId: type: string description: The created application instance Identifier. _links: type: object description: Links to resources related to this notification. $ref: '#/components/schemas/Notification._links' Notification._links: type: object required: - subscription - appInstance properties: subscription: type: object description: A link to the related subscription. $ref: '#/components/schemas/LinkType' appInstance: type: object description: Link to the resource representing the created application instance. $ref: '#/components/schemas/LinkType' AppInstanceIdentifierDeletionNotification: title: AppInstanceIdentifierDeletionNotification required: - id - notificationType - subscriptionId - timeStamp - appInstanceId - _links type: object properties: 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 "AppIdentifierDeletionSubscription" for this notification type. subscriptionId: type: string description: Identifier of the subscription related to this notification. timeStamp: type: object description: Date and time of the notification generation. $ref: '#/components/schemas/TimeStamp' appInstanceId: type: string description: The deleted application instance Identifier. _links: type: object description: Links to resources related to this notification. $ref: '#/components/schemas/Notification._links' AppLcmOpOccNotification.links: title: AppLcmOpOccNotification.links required: - appInstance - subscription - appLcmOpOcc type: object properties: appInstance: type: object $ref: '#/components/schemas/LinkType' subscription: type: object $ref: '#/components/schemas/LinkType' appLcmOpOcc: type: object $ref: '#/components/schemas/LinkType' description: Links to resources related to this resource. InstantiateAppRequest: title: InstantiateAppRequest required: - selectedMECHostInfo type: object properties: locationConstraints: type: object description: Defines the location constraints for the application instance to be created. See note 3. $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: type: array 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. virtualComputeDescriptor: type: object items: $ref: '#/components/schemas/VirtualComputeDescriptor' description: | Describes CPU and memory requirements, as well as optional additional requirements, such as disk and acceleration related capabilities, of the single VM to realize the application instance to be created. See note 1 and note 4. osContainerDescriptor: type: array items: $ref: '#/components/schemas/OsContainerDescriptor' description: | Describes CPU, memory requirements and limits, and software images of the OS Containers realizing this MEC application corresponding to OS Containers sharing the same host and same network namespace. See note 1, note 4 and note 5. virtualStorageDescriptor: type: array items: $ref: '#/components/schemas/VirtualStorageDescriptor' description: | Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1. appTermCandsForCoord: type: object items: $ref: '#/components/schemas/AppTermCandsForCoord' description: Provides sets of applications as termination candidate alternatives that the MEO/MEAO shall select from when utilizing the coordinate LCM operation exchange in pre-emption situations (see step 3 in clause 5.3.1). If this attribute is omitted, the MEO/MEAO shall make its own selection for the coordinate LCM operation exchange. See note 3. description: | NOTE 1: This attribute may be provided in the InstantiateAppRequest structure to override the same attribute in the AppD. NOTE 2: This field applies to Mm3 reference point only. NOTE 3: This field applies to Mm1 reference point only. NOTE 4: Only one of virtualComputeDescriptor or osContainerDescriptor shall be present. NOTE 5: This attribute reflects the ETSI NFV interpretation of the cloud native workloads. AppTermCandsForCoord: type: object required: - terminationOptions properties: terminationOptions: type: array description: Sets of application options for the MEO/MEAO to select from as candidates for termination. The MEO/MEAO shall select one or more of these alternate options to pass to the OSS when utilizing the LCM coordination exchange in pre-emption situations. For each option, the MEO/MEAO may select all, or a subset, of the candidate set's members. items: $ref: '#/components/schemas/AppTermCandsForCoord.terminationOptions' VirtualStorageDescriptor: type: object required: - id - typeOfStorage properties: id: type: string description: Unique identifier of this VirtualStorageDesc in the VNFD. typeOfStorage: type: string description: Type of virtualised storage resource. enum: - BLOCK - OBJECT - FILE blockStorageData: type: object $ref: '#/components/schemas/BlockStorageData' description: Details of block storage. objectStorageData: type: object $ref: '#/components/schemas/ObjectStorageData' description: Details of object storage. fileStorageData: type: object $ref: '#/components/schemas/FileStorageData' description: Details of file storage. nfviMaintenanceInfo: type: object $ref: '#/components/schemas/NfviMaintenanceInfo' description: Information on the rules to be observed during NFVI operation and maintenance. perVnfcInstance: type: boolean description: Indicates whether the virtual storage resource shall be instantiated per VNFC instance. NfviMaintenanceInfo: type: object required: - impactNotificationLeadTime properties: impactNotificationLeadTime: type: number description: The minimum notification lead time requested for upcoming impact of the virtualised resource or their group. isImpactMitigationRequested: type: boolean description: When set to True, it is requested that at the time of the notification of an upcoming change that is expected to have an impact on the VNF, virtualised resource(s) of the same characteristics as the impacted ones is/are provided to compensate for the impact. supportedMigrationType: type: array description: Applicable to VirtualComputeDesc and VirtualStorageDesc. When present, specifies the allowed migration types in the order of preference in case of an impact starting with the most preferred type. For LIVE_MIGRATION, see note 1. items: type: string enum: - NO_MIGRATION - OFFLINE_MIGRATION - LIVE_MIGRATION maxUndetectableInterruptionTime: type: number description: Applicable to VirtualComputeDesc and VirtualStorageDesc. When present, it specifies the maximum interruption time that can go undetected at the VNF level and therefore which will not trigger VNF-internal recovery during live migration. (see note 1) minRecoveryTimeBetweenImpacts: type: number description: When present, it specifies the time required by the group to recover from an impact, thus, the minimum time requested between consecutive impacts of the group. (see note 2.) maxNumberOfImpactedInstances: type: object $ref: '#/components/schemas/MaxNumberOfImpactedInstances' description: When present, specifies for different group sizes the maximum number of instances that can be impacted simultaneously within the group of virtualised resources without losing functionality. Zero cardinality indicates no constraint (see note 2). MaxNumberOfImpactedInstances is defined in clause 7.1.8.18. See note 3. minNumberOfPreservedInstances: type: object $ref: '#/components/schemas/MinNumberOfPreservedInstances' description: When present, specifies for different group sizes the minimum number of instances which need to be preserved simultaneously within the group of virtualised resources. Zero cardinality indicates no constraint (see note 2). MinNumberOfPreservedInstances is defined in clause 7.1.8.22.See note 3. description: | NOTE 1: When the maximum undetectable interruption time is specified it constrains the live migration. If it cannot be guaranteed on an NFVI that the interruption caused by the live migration will be less than the indicated maximum undetectable interruption time, then life migration should be downgraded according to the order of preference. NOTE 2: Impacts to instances of the group happening within the minimum recovery time are considered simultaneous impacts. NOTE 3: Either "maxNumberOfImpactedInstances" or "minNumberOfPreservedInstances" may be provided, but not both MaxNumberOfImpactedInstances: type: object required: - maxNumberOfImpactedInstances properties: groupSize: type: integer description: Determines the size of the group for which the maxNumberOfImpactedInstances is specified. maxNumberOfImpactedInstances: type: integer description: The maximum number of instances that can be impacted simultaneously within the group of the specified size. description: | NOTE 1: Each groupSize value specified for a group of virtual resources shall be unique, and it shall be possible to form an ascending ordered list of groupSizes. NOTE 2: The number of instances in the group for which the maxNumberOfImpactedInstances is specified may be equal to groupSize or less. When the number of instances is less than the groupSize, it shall be at least 1 if this is the first groupSize in the ordered list of groupSizes, or it shall be greater by at least 1 than the previous groupSize in the ordered list of groupSizes. CommunicationInterface: type: object properties: ipAddresses: type: array description: Entry point information of the service as one or more pairs of IP address and port. items: $ref: '#/components/schemas/ipAddresses' ipAddresses: type: object required: - host - port properties: host: type: string description: Host portion of the address. port: type: integer description: Port portion of the address. MinNumberOfPreservedInstances: type: object required: - minNumberOfPreservedInstances properties: groupSize: type: integer description: When present, determines the size of the group for which the minNumberOfPreservedInstances is specified. Otherwise, the size is not limited. minNumberOfPreservedInstances: type: integer description: The minimum number of instances which need to be preserved simultaneously within the group of the specified size. description: | NOTE 1: Each groupSize value specified for a group of virtual resources shall be unique, and it shall be possible to form an ascending ordered list of groupSizes. NOTE 2: The number of instances in the group for which the minNumberOfPreservedInstances is specified may be equal to groupSize or less. FileStorageData: type: object required: - sizeOfStorage - fileSystemProtocol - intVirtualLinkDesc properties: sizeOfStorage: type: number description: Size of virtualised storage resource in GB. fileSystemProtocol: type: string description: The shared file system protocol (e.g. NFS, CIFS). intVirtualLinkDesc: type: object $ref: '#/components/schemas/VnfVirtualLinkDesc' description: Reference of the internal VLD which this file storage connects to. VnfVirtualLinkDesc: type: object required: - virtualLinkDescId - virtualLinkDescFlavour - connectivityType properties: virtualLinkDescId: type: string description: Unique identifier of this internal VLD in VNFD. virtualLinkDescFlavour: type: array description: Describes a specific flavour of the VL with specific bitrate requirements. items: $ref: '#/components/schemas/VirtualLinkDescFlavour' connectivityType: type: object description: See clause 7.1.7.3. $ref: '#/components/schemas/ConnectivityType' testAccess: type: array description: Specifies test access facilities expected on the VL. items: type: string example: passive monitoring description: type: string description: Provides human-readable information on the purpose of the VL. example: control plane traffic monitoringParameter: type: array description: Specifies the virtualised resource related performance metrics on VLD level to be tracked by the VNFM. items: $ref: '#/components/schemas/MonitoringParameter' nfviMaintenanceInfo: type: object description: When present, provides information on the rules to be observed when an instance based on this VnfVirtualLinkDesc is impacted during NFVI operation and maintenance (e.g. NFVI resource upgrades). NfviMaintenanceInfo is defined in clause 7.1.8.17. $ref: '#/components/schemas/NfviMaintenanceInfo' externallyManaged: type: string description: Specifies the intent of the VNF designer with respect to the internal VL instances created from this descriptor being externally managed. enum: - REQUIRED - ALLOWED default: ALLOWED ConnectivityType: type: object required: - layerProtocol properties: layerProtocol: type: array description: | Specifies the protocols that the VL uses See note 1 and note 2. items: type: string enum: - Ethernet - MPLS - ODU2 - IPV4 - IPV6 - Pseudo-Wire - Etc minItems: 1 flowPattern: type: string description: Specifies the flow pattern of the connectivity (Line, Tree, Mesh, etc.). description: | NOTE 1 The top layer protocol of the VL protocol stack shall always be provided. The lower layer protocols may be included when there are specific requirements on these layers. NOTE 2 If more than 1 values are present, the first value represents the highest layer protocol data, and the last value represents the lowest layer protocol data. VirtualLinkDescFlavour: type: object required: - flavourId properties: flavourId: type: string description: Identifies a flavour within a VnfVirtualLinkDesc. qos: type: object $ref: '#/components/schemas/QoS' description: QoS of the VL. QoS: type: object required: - latency - packetDelayVariation properties: latency: type: number description: Latency of the VL in milliseconds. packetDelayVariation: type: number description: Packet delay variation of the VL in milliseconds. packetLossRatio: type: number description: Packet loss ratio of the VL in percentage. ObjectStorageData: type: object properties: maxSizeOfStorage: type: number description: Max size of virtualised storage resource in GB. AppTermCandsForCoord.terminationOptions: type: object required: - appInstIdTerminationCands properties: appInstIdTerminationCands: type: array description: List of application instance identifiers, constituting a candidate set for termination. items: type: string LinkType: title: LinkType required: - href type: object properties: href: type: string description: URI referring to a resource OsContainerDescriptor: title: OsContainerDescriptor type: object required: - osContainerDescId - name - description - swImageDesc properties: osContainerDescId: type: string description: Unique identifier of this OsContainerDesc in the VNFD. name: type: string description: Human readable name of this OS container. description: type: string description: Human readable description of this OS container. requestedCpuResources: type: integer description: Number of CPU resources requested for the container (e.g. in milli-CPU-s). requestedMemoryResources: type: number description: Amount of memory resources requested for the container (e.g. in MB). requestedEphemeralStorageResources: type: number description: Size of ephemeral storage resources requested for the container (e.g. in GB). extendedResourceRequests: type: array items: $ref: '#/components/schemas/KeyValuePairs' description: An array of key-value pairs of extended resources required by the container see note. cpuResourceLimit: type: integer description: Number of CPU resources the container can maximally use (e.g. in milli-CPU). memoryResourceLimit: type: number description: Amount of memory resources the container can maximally use (e.g. in MB). ephemeralStorageResourceLimit: type: number description: Size of ephemeral storage resources the container can maximally use (e.g. in GB). hugePageResources: type: object description: Specifies HugePages resources requested for the container, which the container can maximally use. additionalProperties: type: string cpuPinningRequirements: type: object $ref: '#/components/schemas/VirtualCpuPinningData' description: Requirements for CPU pinning configuration for this OS container. swImageDesc: type: object $ref: '#/components/schemas/SwImageDesc' description: Describes the software image realizing this OS container. bootData: type: string description: Contains a string or a URL to a file contained in the VNF package used to customize a container resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent. monitoringParameters: type: array items: $ref: '#/components/schemas/MonitoringParameter' description: Specifies the virtualized resource related performance metrics on the OsContainerDesc level to be tracked by the VNFM. MonitoringParameter: type: object required: - monitoringParameterId - performanceMetric properties: monitoringParameterId: type: string description: Unique identifier of the monitoring parameter. name: type: string description: Human readable name of the monitoring parameter. performanceMetric: type: string description: Specifies the virtualised resource performance metric. collectionPeriod: type: string description: An attribute that describes the periodicity at which to collect the performance information. VirtualComputeDescriptor: title: VirtualComputeDescriptor type: object required: - virtualComputeDescId - virtualMemory - virtualCpu properties: virtualComputeDescId: type: string description: Unique identifier of this VirtualComputeDesc in the VNFD. logicalNode: type: array description: The logical node requirements. items: $ref: '#/components/schemas/LogicalNodeRequirements' requestAdditionalCapabilities: type: array description: Specifies requirements for additional capabilities. These may be for a range of purposes. One example is acceleration related capabilities. See clause 7.1.9.5. items: $ref: '#/components/schemas/RequestedAdditionalCapabilityData' computeRequirements: description: Specifies compute requirements. type: array items: type: string format: not-specified virtualMemory: type: object description: The virtual memory of the virtualised compute. See clause 7.1.9.3.2. $ref: '#/components/schemas/VirtualMemoryData' virtualCpu: type: object description: The virtual CPU(s) of the virtualised compute. See clause 7.1.9.2.3. $ref: '#/components/schemas/VirtualCpuData' virtualDisk: type: array description: The local or ephemeral disk(s) of the virtualised compute. See clause 7.1.9.4.3. items: $ref: '#/components/schemas/BlockStorageData' BlockStorageData: type: object required: - sizeOfStorage properties: sizeOfStorage: type: number description: Size of virtualised storage resource in GB. vduStorageRequirements: type: array items: $ref: '#/components/schemas/KeyValuePairs' description: An array of key-value pairs that articulate the storage deployment requirements. rdmaEnabled: type: boolean description: Indicate if the storage support RDMA. swImageDesc: type: object $ref: '#/components/schemas/SwImageDesc' description: | References the software image to be loaded on the VirtualStorage resource created based on this VirtualStorageDesc. Shall be absent when used for virtual disks. See note. SwImageDesc: type: object required: - id - name - version - containerFormat - swImage properties: id: type: string description: The identifier of this software image. name: type: string description: The name of this software image. version: type: string description: The version of this software image. checksum: $ref: '#/components/schemas/ChecksumData' description: The checksum of the software image file. See note 3. containerFormat: type: string description: The container format describes the container file format in which software image is provided. diskFormat: type: string description: The disk format of a software image is the format of the underlying disk image. See note 1. minDisk: type: number description: The minimal disk size requirement for this software image. The value of the "size of storage" attribute of the VirtualStorageDesc referencing this SwImageDesc shall not be smaller than the value of minDisk. See note 1. minRam: type: number description: The minimal RAM requirement for this software image. The value of the "size" attribute of VirtualMemoryData of the Vdu referencing this SwImageDesc shall not be smaller than the value of minRam. See note 2. size: type: number description: The size of this software image file. See note 3. swImage: type: object $ref: '#/components/schemas/SwImageDesc' description: This is a reference to the actual software image. The reference can be relative to the root of the VNF Package or can be a URL. operatingSystem: type: string description: Specifies the operating system used in the software image. This attribute may also identify if a 32 bit or 64 bit software image is used. supportedVirtualisationEnvironment: type: array items: type: string description: Specifies the virtualisation environments (e.g. hypervisor) compatible with this software image. description: | NOTE 1: The attribute shall be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and shall be absent otherwise. NOTE 2: The attribute may be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and shall be absent otherwise. NOTE 3: The attribute shall be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and may be present otherwise. ChecksumData: type: object required: - algorithm - hash properties: algorithm: type: string description: Specifies the algorithm used to obtain the checksum value. See note. hash: type: string description: | Contains the result of applying the algorithm indicated by the algorithm attribute to the data to which this ChecksumData refers. description: | NOTE: The algorithm attribute value shall be one of the Hash Function Textual Names present in [2]. LogicalNodeRequirements: type: object required: - id - logicalNodeRequirementDetail properties: id: type: string format: uuid description: Identifies this set of logical node requirements logicalNodeRequirementDetail: description: > The logical node-level compute, memory and I/O requirements. An array of key-value pairs that articulate the deployment requirements. This could include the number of CPU cores on this logical node, a memory configuration specific to a logical node (e.g. such as available in the Linux kernel via the libnuma library) or a requirement related to the association of an I/O device with the logical node. type: array items: type: string format: not-specified RequestedAdditionalCapabilityData: type: object required: - requestedAdditionalCapabilityName - supportMandatory - targetPerformanceParameters properties: requestedAdditionalCapabilityName: type: string description: Specifies a requested additional capability for the VDU supportMandatory: type: boolean description: Indicates whether the requested additional capability is mandatory for successful operation minRequestedAdditionalCapabilityVersion: type: string description: Specifies the minimum version of the requested additional capability preferredRequestedAdditionalCapabilityVersion: type: string description: Specifies the preferred version of the requested additional capability targetPerformanceParameters: type: array description: Specifies specific attributes, dependent on the requested additional capability type. items: $ref: '#/components/schemas/KeyValuePairs' KeyValuePairs: description: | This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. type: object properties: key: type: string value: type: string VirtualMemoryData: type: object required: - virtualMemSize properties: virtualMemSize: type: number description: Amount of virtual memory in MB. virtualMemOversubscriptionPolicy: type: string description: | The memory core oversubscription policy in terms of virtual memory to physical memory on the platform. The cardinality can be 0 during the allocation request, if no particular value is requested. vduMemRequirements: type: array items: $ref: '#/components/schemas/KeyValuePairs' description: Array of key-value pair requirements on the memory for the VDU. numaEnabled: type: boolean description: Specifies the memory allocation to be cognisant of the relevant process/core allocation. hugePagesRequirements: type: string description: Specifies requirements on the huge pages resources for the virtual memory. VirtualCpuData: type: object required: - numVirtualCpu properties: cpuArchitecture: type: string description: CPU architecture type. Examples are x86, ARM. numVirtualCpu: type: integer description: Number of virtual CPUs. virtualCpuClock: type: number description: Minimum virtual CPU clock rate (e.g. in MHz). virtualCpuOversubscriptionPolicy: type: string description: The CPU core oversubscription policy, e.g. the relation of virtual CPU cores to physical CPU cores/threads. vduCpuRequirements: type: array items: $ref: '#/components/schemas/KeyValuePairs' description: Array of key-value pair requirements on the Compute (CPU) for the VDU. virtualCpuPinning: $ref: '#/components/schemas/VirtualCpuPinningData' VirtualCpuPinningData: type: object properties: virtualCpuPinningPolicy: type: string description: Indicates the policy for CPU pinning. enum: - STATIC - DYNAMIC virtualCpuPinningRule: type: array items: type: string description: List of rules that should be considered during the allocation of the virtual CPUs to logical CPUs in case of "STATIC" virtualCpuPinningPolicy. LocationConstraints: title: LocationConstraints type: object properties: countryCode: type: string description: The two-letter ISO 3166 country code in capital letters. See note. civicAddressElement: type: array items: $ref: '#/components/schemas/CivicAddressElement' area: type: string 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 the "type" member shall be set to the value "Polygon". See note. 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'" NOTE: If both "countryCode" and "area" are present, no conflicts should exist between the values of these two attributes. In case of conflicts, the API producer (e.g. MEO, MEAO) shall disregard parts of the geographic area signalled by "area" that are outside the boundaries of the country signalled by "countryCode". If "countryCode" is absent, it is solely the "area" attribute that defines the location constraint. CivicAddressElement: title: CivicAddressElement required: - caType - caValue type: object properties: caType: type: integer description: "'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.'" format: int32 caValue: 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.'" MECHostInformation: title: MECHostInformation required: - hostId type: object properties: hostId: $ref: '#/components/schemas/KeyValuePairs' description: Deployment-specific information to identify a MEC host. See note. hostName: type: string description: Human-readable name of MEC host. description: | NOTE: 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. OperateAppRequest: title: OperateAppRequest required: - changeStateTo 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. format: int32 stopType: description: The stop type. See notes 1 and 3. $ref: '#/components/schemas/StopType' description: | NOTE 1: The "stopType" and "gracefulStopTimeout" attributes shall be absent, when the "changeStateTo" attribute is equal to "STARTED". NOTE 2: The "gracefulStopTimeout" attribute shall be present, when the "changeStateTo" is equal to "STOPPED" and the "stopType" attribute is equal to "GRACEFUL". The "gracefulStopTimeout" attribute shall be absent, when the "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute is equal to "FORCEFUL". NOTE 3: The request shall be treated as if the "stopType" attribute was set to "FORCEFUL", when the "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute is absent StopType: title: StopType enum: - FORCEFUL - GRACEFUL type: string examples: - FORCEFUL ChangeStateTo: title: ChangeStateTo enum: - STARTED - STOPPED type: string description: The desired operational state examples: - STARTED ProblemDetails: title: ProblemDetails type: object properties: detail: type: string description: A human-readable explanation specific to this occurrence of the problem instance: type: string description: A URI reference that identifies the specific occurrence of the problem status: type: integer description: The HTTP status code for this occurrence of the problem format: int32 title: type: string description: A short, human-readable summary of the problem type type: type: string description: A URI reference according to IETF RFC 3986 that identifies the problem type TerminateAppRequest: 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." format: int32 terminationType: $ref: '#/components/schemas/TerminationType' description: | NOTE: If the application instance is still in service, requesting forceful termination can adversely impact service. TimeStamp: title: TimeStamp required: - nanoSeconds - seconds 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. format: int32 seconds: type: integer description: The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. format: int32 TerminationType: title: TerminationType enum: - FORCEFUL - GRACEFUL type: string description: "'Indicates whether forceful or graceful termination is requested.'" examples: - FORCEFUL VimConnectionInfo: title: VimConnectionInfo required: - id - vimType type: object properties: accessInfo: $ref: '#/components/schemas/KeyValuePairs' description: | This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. extra: $ref: '#/components/schemas/KeyValuePairs' description: | This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. id: type: string description: The identifier of the VIM Connection. This identifier is managed by the MEO. interfaceInfo: $ref: '#/components/schemas/KeyValuePairs' description: | This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. vimId: type: string 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. vimType: type: string 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 required: - subscription type: object properties: subscription: $ref: '#/components/schemas/LinkType' description: Links to resources related to this notification. responses: '400': description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: 'Unauthorized : used when the client did not submit credentials.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '403': description: 'Forbidden : operation is not allowed given the current status of the resource.' content: application/problem+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/problem+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/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '429': description: 'Too Many Requests: used when a rate limiter has triggered.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' security: - {}