Newer
Older
"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"
},
},
"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",
"paths": {
"/app_instances": {
"post": {
"summary": "Create an application instance resource",
"description": "Create an application instance resource",
"operationId": "appInstancePOST",
"requestBody": {
"description": "The POST method is used to create an application instance resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAppInstanceRequest"
"responses": {
"201": {
"description": "An application instance identifier and the related resource has been created successfully.",
"schema": {
"$ref": "#/components/schemas/AppInstanceInfo"
"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",
"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",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppInstanceInfo"
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
},
"/app_instances/{appInstanceId}": {
"get": {
"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.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppInstanceInfo"
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"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": {
"headers": {},
"content": {}
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
},
"/subscriptions": {
"post": {
"summary": "subscribe to the notification of application instance related change",
"description": "subscribe to the notification of application instance related change",
"operationId": "appLcmSubscriptionsPOST",
"requestBody": {
"content": {
"application/json": {
"oneOf": [
{
"$ref": "#/components/schemas/AppInstSubscriptionRequest"
},
{
"$ref": "#/components/schemas/AppLcmOpOccSubscriptionRequest"
},
{
"$ref": "#/components/schemas/AppInstIdCreationSubscriptionRequest"
},
{
"$ref": "#/components/schemas/AppInstIdDeletionSubscriptionRequest"
"responses": {
"201": {
"description": "a representation of the created SubscriptionInfo.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/AppInstSubscriptionInfo"
"$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo"
},
{
"$ref": "#/components/schemas/AppInstIdCreationSubscriptionInfo"
},
{
"$ref": "#/components/schemas/AppInstIdDeletionSubscriptionInfo"
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
}
},
"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
},
"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",
"name": "subscriptionType",
"description": "Query parameter to filter on a specific subscription type.",
"$ref": "#/components/schemas/AppInstanceSubscriptionType"
"responses": {
"200": {
"description": "List of all subscriptions is returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppInstanceSubscriptionLinkList"
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
},
"/subscriptions/{subscriptionId}": {
"get": {
"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",
"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.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/AppInstSubscriptionInfo"
},
{
"$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo"
},
{
"$ref": "#/components/schemas/AppInstIdCreationSubscriptionInfo"
},
{
"$ref": "#/components/schemas/AppInstIdDeletionSubscriptionInfo"
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"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": {
"headers": {},
"content": {}
"400": {
"$ref": "#/components/responses/400"
},
},
"403": {
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
},
"/user_defined_notification": {
"post": {
"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",
"requestBody": {
"content": {
"application/json": {
"oneOf": [
{
"$ref": "#/components/schemas/AppInstNotification"
},
{
"$ref": "#/components/schemas/AppLcmOpOccNotification"
},
{
"$ref": "#/components/schemas/AppInstanceIdentifierCreationNotification"
},
{
"$ref": "#/components/schemas/AppInstanceIdentifierDeletionNotification"
},
"responses": {
"204": {
"headers": {},
"content": {}
"400": {
"$ref": "#/components/responses/400"
},
},
"403": {
},
"404": {
},
"406": {
},
"429": {
},
"/app_instances/{appInstanceId}/instantiate": {
"post": {
"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": {
"content": {
"application/json": {
"$ref": "#/components/schemas/InstantiateAppRequest"
}
}
},
"responses": {
"202": {
"description": "accepted for processing, but the processing has not yet been completed.",
"headers": {},
"content": {}
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
},
"/app_instances/{appInstanceId}/terminate": {
"post": {
"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": {
"content": {
"application/json": {
"$ref": "#/components/schemas/TerminateAppRequest"
}
},
"responses": {
"202": {
"description": "accepted for processing, but the processing has not yet been completed.",
"headers": {},
"content": {}
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
},
"/app_instances/{appInstanceId}/operate": {
"post": {
"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": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperateAppRequest"
},
"responses": {
"202": {
"description": "accepted for processing, but the processing has not yet been completed.",
"headers": {},
"content": {}
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
},
"/app_lcm_op_occs": {
"get": {
"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",
"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",
"description": "Complex attributes of AppLcmOpOcc to be excluded from the response.",
"schema": {
"type": "string"
},
{
"name": "exclude_fields",
"description": "Complex attributes of AppLcmOpOcc to be excluded from the response.",
"schema": {
"type": "string"
},
{
"name": "exclude_default",
"description": "Indicates to exclude the following complex attributes of AppLcmOpOcc from the response.",
"schema": {
"type": "string"
"responses": {
"200": {
"description": "Status information for zero or more application instance lifecycle management operation occurrences was queried successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppLcmOpOcc"
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"/app_lcm_op_occs/{appLcmOpOccId}": {
"get": {
"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",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppLcmOpOcc"
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
},
"/app_lcm_op_occs/{appLcmOpOccId}/cancel": {
"post": {
"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": {}
},
"/app_lcm_op_occs/{appLcmOpOccId}/fail": {
"post": {
"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",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppLcmOpOcc"
}
}
}
}
},
"deprecated": false
},
},
"/app_lcm_op_occs/{appLcmOpOccId}/retry": {
"post": {
"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": {}
}
},
"deprecated": false
},
},
"/app_instances/{appInstanceId}/configure_platform_for_app": {
"post": {
"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": {}
}
},
"deprecated": false
},
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
}
},
"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\nNOTE 1: Void.\nNOTE 2: This object contains structured data, and shall comply with the provisions of clause 4 of IETF RFC 8259 \n"
},
"AppInstanceSubscriptionLinkList": {
"type": "object",
"description": "List of hyperlinks related to the resource.",
"$ref": "#/components/schemas/AppInstanceSubscriptionLinkList._links"
}
}
},
"AppInstanceSubscriptionLinkList._links": {
"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"],
"format": "uri",
"description": "The URI referring to the subscription."
"type": "object",
"description": "Type of the subscription.",
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
"$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",
},
"AppInstIdCreationSubscriptionRequest": {
"type": "object",
"required": ["subscriptionType", "callbackUri"],
"properties": {
"subscriptionType": {
"type": "string",
"description": "Shall be set to \"AppIdentifierCreationSubscription\"."
"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. 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\".\n"
},
"AppInstIdDeletionSubscriptionRequest": {
"type": "object",
"required": ["subscriptionType", "callbackUri"],
"properties": {
"subscriptionType": {
"type": "string",
"description": "Shall be set to \"AppIdentifierDeletionSubscription\"."
},
"callbackUri": {
"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"],
"type": "string",
"description": "Identifier of the subscription to application instance operational state change notification."
"type": "string",
"description": "Shall be set to \"AppIdentifierCreationSubscription\"."
"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"],
"type": "object",
"description": "URI of this resource.",
"$ref": "#/components/schemas/LinkType"
}
}
}
}
},
"AppInstIdDeletionSubscriptionInfo": {
"type": "object",
"required": ["id", "subscriptionType", "callbackUri", "_links"],
"type": "string",
"description": "Identifier of the subscription to application instance operational state change notification."
},
"subscriptionType": {
"type": "string",
"description": "Shall be set to \"AppIdentifierDeletionSubscription\"."
},
"callbackUri": {
"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"],
"type": "object",
"description": "URI of this resource.",
"$ref": "#/components/schemas/LinkType"
}
}
}
}
},
"AppInstanceLcmOpOcc.links": {
"title": "AppInstanceLcmOpOcc.links",
"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": {
"required": ["id", "subscriptionType", "callbackUri", "_links"],
"properties": {
"id": {
"description": "Identifier of this subscription resource."
},
"subscriptionType": {
"const": "AppLcmOpOccStateChange",
"type": "string",
"description": "Shall be set to \"AppLcmOpOccStateChangeSubscription\".",
},
"callbackUri": {
"type": "string",
"description": "The URI of the endpoint for the notification to be sent to."
"appLcmOpOccSubscriptionFilter": {
"$ref": "#/components/schemas/AppLcmOpOccSubscriptionFilter",
"description": "Criteria used to select application LCM operation occurrences on which to send notifications related to this subscription."
},
"$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",
"properties": {
"self": {
"type": "object",
"description": "URI of this resource.",
"$ref": "#/components/schemas/LinkType"
}
},
"description": "Links to resources related to this resource."
},
"AppInstSubscriptionInfo": {
"required": ["id", "subscriptionType", "callbackUri", "_links"],
"properties": {
"id": {
"type": "string",
"description": "'Identifier of the subscription to application instance operational state change notification.'"
},
"subscriptionType": {
"const": "AppInstanceStateChange",
"type": "string",
"description": "Shall be set to \"AppInstanceStateChangeSubscription\".",
"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": {
"description": "The URI of the endpoint for the subscription related notification to be sent to."
},
"_links": {
"$ref": "#/components/schemas/AppInstSubscriptionInfo.links"
}
},
"description": "'The data type represents a subscription to notification of application instance operational state change.'"
},
"AppInstSubscriptionInfo.links": {
"properties": {
"self": {
"type": "object",
"description": "URI of this resource.",
"$ref": "#/components/schemas/LinkType"
"description": "Links to resources related to this resource."
},
"AppLcmOpOccSubscriptionRequest": {
"required": ["callbackUri", "subscriptionType"],
"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": {
"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": {
"enum": ["INSTANTIATE", "OPERATE", "TERMINATE"],
"type": "string",
"description": "'Type of the LCM operation represented by this application instance LCM operation occurrence.'",
"MepInformation": {
"type": "object",
"properties": {
"mepId": {
"type": "string",
"description": "Deployment-specific identifier of MEC platform."
},
"mepName": {
"type": "string",
"description": "Human-readable name of MEC platform"
}
}
},
"CreateAppInstanceRequest": {
"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."
"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.\n"
},
"AppInstSubscriptionRequest": {
"required": ["subscriptionType", "callbackUri"],
"properties": {
"subscriptionType": {
"const": "AppInstanceStateChange",
"type": "string",
"description": "Shall be set to \"AppInstanceStateChangeSubscription\".",
},
"callbackUri": {
"type": "string",
"description": "The URI of the endpoint for the notification to be sent to."
},
"appInstanceState": {
"$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": {
"properties": {
"appInstSelectorType": {
"$ref": "#/components/schemas/AppInstSelectorType"
},
"appInstances": {
"type": "array",
"items": {
"description": "If appInstIdSelector = APP_IDENTITY match existing application instances with an \"application instance identifier\" listed in this attribute.\nIf appInstIdSelector = APP_NAME match existing application instances with an \"application instance name\" listed in this attribute.\nIf 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.\nIf appInstIdSelector = APP_FROM_PROVIDER this attribute shall not be included.\n"
"appsFromProviders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppsFromProviders"
},
"description": "'This data type represents subscription filter criteria to match application instances. '"
},
"AppsFromProviders": {
"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": {
"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": {
"properties": {
"appSoftVersion": {
"type": "string",
"description": "Identifies the version of software of the MEC application."
},
"appDVersion": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"description": "'If present, match application instances that belong to application products with certain versions and a certain product name, from one particular provider.'"
},
"AppInstSelectorType": {
"enum": [
"VOID",
"APP_IDENTITY",
"APP_NAME",
"APP_D_ID",
"APP_FROM_PROVIDER"
],
"type": "string",
"description": "0 = void",
},
"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.",
},
"AppInstNotification": {
"title": "AppInstNotification",
"required": [
"_links",
"appDId",
"appInstanceId",
"appPkgId",
"id",
"notificationType",
"subscriptionId",
"timeStamp"
],
"type": "object",
"properties": {
"_links": {
},
"appDId": {
"type": "string",
"description": "The application descriptor identifier identifies the application package and the application descriptor in a globally unique way."
},
"appInstanceId": {
"type": "string",
"description": "Identifier of application instance."
},
"appPkgId": {
"type": "string",
"description": "Identifier of the onboarded application package."
},
"id": {
"type": "string",
"description": "Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the \"notificationId\" attribute of all these notifications shall have the same value."
},
"notificationType": {
"type": "string",
"description": "Discriminator for the different notification types. Shall be set to \"AppInstanceStateChangeSubscription\" for this notification type."
},
"subscriptionId": {
"type": "string",
"description": "Identifier of the subscription related to this notification."
},
"timeStamp": {
"type": "object",
"description": "Date and time of the notification generation.",
"$ref": "#/components/schemas/TimeStamp"
"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",
"properties": {
"countryCode": {
"type": "string",
"description": "The two-letter ISO 3166 country code in capital letters where an instance is deployed."
"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.\n"
"type": "object",
"required": [
"mcioId",
"mcioName",
"mcioNamespace",
"vduId",
"cismId",
"mcioType",
"desiredInstances",
"availableInstances"
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
"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.\nEXAMPLE: In case of MCIOs managed by Kubernetes®, the type of MCIO corresponds to the \"kind\" property of the declarative descriptor.\nNOTE 2: If the attribute additionalInfo is present, it may contain runtime information on the actual and desired state of the MCIO(s)\n"
},
"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": {
"required": [
"id",
"appDId",
"appProvider",
"appName",
"appSoftVersion",
"appDVersion",
"appPkgId",
"instantiationState",
"_links"
],
"properties": {
"id": {
"type": "string",
"description": "Identifier of application instance."
},
"appInstanceName": {
"type": "string",
"description": "Name of the application instance."
},
"appInstanceDescription": {
"type": "string",
"description": "Human-readable description of the application instance to be created."
},
"appDId": {
"type": "string",
"description": "Identifier of this MEC application descriptor. This attribute shall be globally unique."
},
"appProvider": {
"type": "string",
"description": "Provider of the application and of the AppD."
"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\n"
},
"vnfInstanceId": {
"type": "string",
"description": "Identifier of the VNF instance created by VNFM that the MEC application has been instantiated as. See note 2.\n"
},
"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"
}
},
"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.\nNOTE 1: This field does not apply if the data structure is used by MEAO.\nNOTE 2: This field applies if the data structure is used by MEAO.\nNOTE 3: This field does not apply if the data structure is used on Mm3*.\nNOTE 4: This field applies if the data structure is used on Mm3*.\nNOTE 5: This field applies if the data structure is used on Mm1 or Mm3*.\nNOTE 6: It is not specified in the present document how location information is obtained in the case of MEC in NFV.\nNOTE 7: This attribute reflects the ETSI NFV interpretation of the cloud native workloads.\n"
},
"OperationState": {
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
],
"type": "string",
"description": "Operation state",
},
"InstantiationState": {
"enum": ["NOT_INSTANTIATED", "INSTANTIATED"],
"type": "string",
"description": "Instantiation state of the application instance",
},
"InstantiatedAppState": {
"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": {
"type": "string",
"description": "Operational state is applicable in the instantiation state INSTANTIATED",
},
"AppInstanceInfo.links": {
"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": {
"enum": ["INSTATIATE", "OPERATE", "TERMINATE"],
"type": "string",
"description": "Type of the actual LCM operation represented by this application instance LCM operation occurrence",
},
"AppLcmOpOccNotification": {
"required": [
"id",
"notificationType",
"operationType",
"operationState",
"subscriptionId",
"timeStamp",
"appLcmOpOccId",
"appInstanceId",
"_links"
],
"properties": {
"id": {
"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",
"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": {
"$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."
"type": "object",
"description": "Date and time of the notification generation.",
"$ref": "#/components/schemas/TimeStamp"
},
"appInstanceId": {
"type": "string",
"description": "The created application instance Identifier."
"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."
"type": "object",
"description": "Date and time of the notification generation.",
"$ref": "#/components/schemas/TimeStamp"
},
"appInstanceId": {
"type": "string",
"description": "The deleted application instance Identifier."
"type": "object",
"description": "Links to resources related to this notification.",
"$ref": "#/components/schemas/Notification._links"
}
}
},
"AppLcmOpOccNotification.links": {
"required": ["appInstance", "subscription", "appLcmOpOcc"],
"properties": {
"appInstance": {
"$ref": "#/components/schemas/LinkType"
},
"subscription": {
"$ref": "#/components/schemas/LinkType"
},
"appLcmOpOcc": {
"$ref": "#/components/schemas/LinkType"
},
"description": "Links to resources related to this resource."
},
"InstantiateAppRequest": {
"properties": {
"locationConstraints": {
"type": "object",
"description": "Defines the location constraints for the application instance to be created. See note 3.",
"$ref": "#/components/schemas/LocationConstraints"
},
"selectedMECHostInfo": {
"items": {
"$ref": "#/components/schemas/MECHostInformation"
},
"description": "Describes the information of selected host for the application instance. See note 2.\n"
},
"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."
},
"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\ninstance to be created. See note 1 and note 4.\n"
},
"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 \nsame host and same network namespace. See note 1, note 4 and note 5.\n"
},
"virtualStorageDescriptor": {
"type": "array",
"$ref": "#/components/schemas/VirtualStorageDescriptor"
"description": "Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1.\n"
},
"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.\nNOTE 2: This field applies to Mm3 reference point only.\nNOTE 3: This field applies to Mm1 reference point only.\nNOTE 4: Only one of virtualComputeDescriptor or osContainerDescriptor shall be present.\nNOTE 5: This attribute reflects the ETSI NFV interpretation of the cloud native workloads.\n"
},
"AppTermCandsForCoord": {
"type": "object",
"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"
}
}
}
},
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
"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\nguaranteed on an NFVI that the interruption caused by the live migration will be less than the indicated\nmaximum undetectable interruption time, then life migration should be downgraded according to the order of preference.\nNOTE 2: Impacts to instances of the group happening within the minimum recovery time are considered simultaneous\nimpacts.\nNOTE 3: Either \"maxNumberOfImpactedInstances\" or \"minNumberOfPreservedInstances\" may be provided, but not both\n"
},
"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. \nNOTE 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 \n 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.\n"
},
"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 \n an ascending ordered list of groupSizes. \nNOTE 2: The number of instances in the group for which the minNumberOfPreservedInstances is specified may be equal \n to groupSize or less.\n"
},
"FileStorageData": {
"type": "object",
"required": [
"sizeOfStorage",
"fileSystemProtocol",
"intVirtualLinkDesc"
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
"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.\n",
"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. \nNOTE 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. \n"
},
"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",
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "URI referring to a resource"
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
"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."
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
},
"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\nbased on this VirtualStorageDesc. Shall be absent when used for virtual disks. See note.\n"
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
}
}
},
"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.\nNOTE 2: The attribute may be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and shall be absent otherwise.\nNOTE 3: The attribute shall be present for VM-based software images referenced from a Vdu or from a VirtualStorageDesc, and may be present otherwise. \n"
},
"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.\n"
}
},
"description": "NOTE: The algorithm attribute value shall be one of the Hash Function Textual Names present in [2].\n"
},
"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.\n",
"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\nsignificant. In JSON, a set of key-value pairs is represented as an object. It shall comply with\nthe provisions defined in clause 4 of IETF RFC 8259.\n",
"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\non the platform. The cardinality can be 0 during the allocation request, if no particular\nvalue is requested.\n"
},
"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": {
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
"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."
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
},
"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": {
"description": "The two-letter ISO 3166 country code in capital letters. See note."
"civicAddressElement": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CivicAddressElement"
"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'\"\nNOTE: If both \"countryCode\" and \"area\" are present, no conflicts should exist between the values of these two \nattributes. In case of conflicts, the API producer (e.g. MEO, MEAO) shall disregard parts of the geographic \narea signalled by \"area\" that are outside the boundaries of the country signalled by \"countryCode\". If \n\"countryCode\" is absent, it is solely the \"area\" attribute that defines the location constraint.\n"
},
"CivicAddressElement": {
"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.'",
},
"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": {
"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 \ncomplex than a simple identifier, e.g. when referring to the structure of an NFVI.\n"
},
"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.",
},
"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 \nequal to \"STARTED\".\nNOTE 2: The \"gracefulStopTimeout\" attribute shall be present, when the \"changeStateTo\" is equal to \"STOPPED\" and \nthe \"stopType\" attribute is equal to \"GRACEFUL\". The \"gracefulStopTimeout\" attribute shall be absent, when \nthe \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"FORCEFUL\".\nNOTE 3: The request shall be treated as if the \"stopType\" attribute was set to \"FORCEFUL\", when the \n\"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is absent\n"
},
"StopType": {
},
"ChangeStateTo": {
"type": "string",
"description": "The desired operational state",
},
"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",
},
"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": {
"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.\n"
},
"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.",
"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": {
"type": "string",
"description": "'Indicates whether forceful or graceful termination is requested.'",
},
"VimConnectionInfo": {
"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\nnot significant. In JSON, a set of key-value pairs is represented as an object. It shall comply\nwith the provisions defined in clause 4 of IETF RFC 8259.\n"
"$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\nsignificant. In JSON, a set of key-value pairs is represented as an object. It shall comply\nwith the provisions defined in clause 4 of IETF RFC 8259.\n"
"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\nnot significant. In JSON, a set of key-value pairs is represented as an object. It shall\ncomply with the provisions defined in clause 4 of IETF RFC 8259.\n"
"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\ndetermines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type\nof the VIM.The set of permitted values is expected to change over time as new types or versions\nof VIMs become available.\n"
}
},
"Links": {
"title": "Links",
"type": "object",
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
},
"description": "Links to resources related to this notification."
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
},
"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"
}
}
}
}