...

Table of Contents

...

As part of this release EALTEdge Blueprint are releasing few API's which can be used by other Akraino Blueprints or Non Akraino Blueprints / Projects. The API are in compliance with the API Standards defined in Multi-access Edge Computing (MEC); MEC Management; Part 2: Application lifecycle, rules and requirements managementETSI GS MEC 010-2 V2.1.1 (https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf) .

In this release EALTEdge are exposing API's related to :-

Application Package Management
Application Life Cycle Management
MEC Service Management.

API Definitions

Application Package Management

Onboard Application

...

Get Package Info

...

Delete Application Package

...

204. No Response body will be returned.

Application Life Cycle Management

Create Application Instance

...

appDId

...

appInstanceDescriptor

...

Get Application Instance Information

...

Introduction

As part of this release EALTEdge Blueprint are releasing few API's which can be used by other Akraino Blueprints or Non Akraino Blueprints / Projects. The API's given are for the MM3 and MP1 Interface.

These APIs are in compliance with the API Standards defined by ETSI in Multi-access Edge Computing (MEC); MEC Management; Part 2: Application lifecycle, rules and requirements management. (https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf) and Multi-access Edge Computing (MEC); Edge Platform Application Enablement (https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf)

In this release EALTEdge are exposing API's related to :-

Application Life Cycle Management
MEC Service Management.

API Definitions

Application Life Cycle Management

Create Application Instance

1.	API Name	Create Application Instance	Type : POST	Interface : MM3
Description		The POST method is used to create an application instance resource, which refers to the procedure of "creating application instance resource operation"
Resource URI		/ealtedge/mepm/app_lcm/v1/app_instances

/{appInstanceId}


Request Body Parameters

- None

Response Codes	201

Parameter Name	Cardinality	Type	Description
appDId	1	String	Application Description ID
appInstancename	1	String	Application Instance Name
appInstanceDescriptor	1	String	Application Instance Descriptor
Response Parameters
Parameter Name	Cardinality	Type	Description

/ Example


AppInstanceInfo		1	Complex	Application Instance Info

...

Get Application Instance

3

2.	API Name

: Delete

/ Category	Application Instance Info	Type :

DELETE

GET	Interface : MM3
Description		The

DELETE method deletes

GET method retrieves the information of an individual application instance via reading an individual application instance resource, which

refers to

is used by the procedure of "

delete application

query application instance

identifier

	Response Codes
information operation"
Resource URI		/ealtedge/mepm/app_lcm/v1/app_instances/{appInstanceId}
Request Body Parameters - None

204

201
Response Parameters

- No Content

Instantiate Application

4


Parameter Name	Cardinality	Type	Description / Example
AppInstanceInfo	1	Complex	Application Instance Info

Delete Application Instance

3.	API Name:

Instantiate

Delete Application Instance		Type :

POST

DELETE	Interface :

MM3OSS→ MEO, MEO->MEPM

MM3
Description

To instantiate the application instance

The DELETE method deletes an individual application instance resource, which refers to the procedure of "delete application instance identifier operation"
Resource URI		/ealtedge/mepm/app_lcm/v1/app_instances/{appInstanceId}

/instantiate Request Body ParametersAttribute NameCardinalityTypeDescription

R3 - API Documentation Enterprise Application on Lightweight 5G Telco Edge (EALTEdge) [WIP]

1ComplexRequest parameters of the "Instantiate Application" operationResponse Codes202 - Accepted. The request was accepted for processing, but the processing has not yet been completedResponse Parameters - Response Body is Empty

Terminate Application

5

	Response Codes	204

Request Body Parameters - None
Response Parameters - No Content

Instantiate Application

4.	API Name:

Terminate

Instantiate Application		Type : POST	Interface : MM3

(OSS→ MEO, MEO->MEPM)DescriptionTo instantiate the application instance


Description		This resource represents the task of instantiating an application instance. The client can use this resource to instantiate an application instance.
Resource URI		/ealtedge/mepm/app_lcm/v1/app_instances

/{appInstanceId}/terminateRequest Body ParametersNameCardinalityTypeDescription

R3 - API Documentation Enterprise Application on Lightweight 5G Telco Edge (EALTEdge) [WIP]

1ComplexResponse Codes202 - Accepted. The request was accepted for processing, but the processing has not yet been completedResponse Parameters - Response Body is Empty

MEC Service Management

Get Service List

...

Get Service

2.API NameType : GETInterface : MM1DescriptionGet Service Information of a specific service. Service Id is passed in the request URIResource URI

	202 - Accepted. The request was accepted for processing, but the processing has not yet been completed
/{appInstanceId}/instantiate
Request Body Parameters
Attribute Name	Cardinality	Type	Description
#InstantiateAppRequest	1	Complex	Request parameters of the "Instantiate Application" operation
Response Parameters - Response Body is Empty

Terminate Application

5.	API Name: Terminate Application		Type : POST	Interface : MM3
Description		This resource represents the task of terminating an application instance. The client can use this resource to terminate an application instance
Resource URI		/ealtedge/mepm/app_lcm/v1/app_instances/{appInstanceId}/terminate
Request Body Parameters
Name		Cardinality	Type	Description
#TerminateAppRequest		1	Complex
	Response Codes	202 - Accepted. The request was accepted for processing, but the processing has not yet been completed
Response Parameters - Response Body is Empty

MEC Service Management

Get Service List

1.	Get Service List	Type : GET	Interface : MP1
Description	To get the List of all the Services Registered in MEP services
	/ealtedge/mep/mec_service_mgmt/v1/services/serviceId
Request Body Parameters - No Parameters
Response Codes	201
Response Parameters
Parameter Name	Cardinality	Type	Description

Get Service

...

3
2. API Name Get Service
Registration
ID Information Type :
POST
GET Interface :
MM1
MP1
Description
This method is used to create a mecService resource that is associated with the application instance. This method is typically used in "service availability update and new service registration" procedure
Get Service Information of a specific service. Service Id is passed in the request URI
Resource URI /ealtedge/mep/mec_service_mgmt/v1/
applications/{appInstanceId}/services
services/serviceId
Request Body
ParametersParameter NameCardinalityTypeDescriptionServiceInfo1Complex
Parameters - No Parameters
Response Codes 201
: Created
Response Parameters
Parameter Name Cardinality Type Description
ServiceInfo1ComplexUpon success, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource.4

Service Registration

3.	API Name	Service Registration	Type :

GET

POST	Interface :

MM1

MP1
Description		This method

retrieves information about a list of mecService resources

is used to create a mecService resource that is associated with

an

the application instance. This method is typically used in "service availability

query

update and new service registration" procedure
Resource URI		/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/services
Request Body

Parameters – None

Response Codes	201 : Created
Parameters
Parameter Name	Cardinality	Type	Description
ServiceInfo	1	Complex
Response Parameters
Parameter Name	Cardinality	Type	Description
ServiceInfo

0..N

1

Complex

Upon success,

a response body containing an array of the mecServices is returned.

Service Management Subscription

5

the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource.

4.	API Name	Service

Management Subscription

Availability Information	Type : GET	Interface :

MM1

MP1
Description

The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains payload body with all the subscriptions for the requestor

This method retrieves information about a list of MEC Service resources that is associated with an application instance. This method is typically used in "service availability query" procedure
Resource URI		/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/

subscriptions

services
Request Body

Parameters -

Response Codes
Parameters – None

200

201 :

OK

Created
Response Parameters
Parameter Name		Cardinality	Type	Description

SubscriptionLinkList1

ServiceInfo

0..N

Complex

Upon success, a response body containing

the list

an array of

links to

the

requested subscriptions

mecServices is returned.

Service Management Subscription

6

5.	API Name

New service

Fetch all Subscription Information	Type :

POST

GET	Interface :

MM1

MP1
Description		The

POST

GET method may be used

to create a new subscription. One example use case is to create a new subscription to the MEC service availability notifications

to request information about all subscriptions for this requester. Upon success, the response contains payload body

describing the created subscription. This method is typically used in "Subscribing to service availability event notifications" procedure

with all the subscriptions for the requester
Resource URI		/ealtedge/mec_service_mgmt/v1

/applications/{appInstanceId}/subscriptionsRequest Body ParametersParameter NameCardinalityTypeDescriptionSerAvailabilityNotificatio nSubscription1ComplexPayload body in the request contains a subscription to the MEC service availability notifications that is to be created.

Response Codes
/applications/{appInstanceId}/subscriptions
Request Body Parameters - None

201

200 :

Created

OK
Response Parameters
Parameter Name		Cardinality	Type	Description

SerAvailabilityNotificatio nSubscription

SubscriptionLinkList

1

Complex

Upon success,

the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created subscription resource.

Individual Service Management Subscription

7

a response body containing the list of links to the requested subscriptions is returned.

Service Subscription

Get Service Information

9.API NameGet Service Response Codes

6.	mecSrvMgmtSubscriptionNew service Subscription	Type : GETPOST	Interface : MM1MP1
Description	The GET method requests information about a subscription for this requestorPOST method may be used to create a new subscription. One example use case is to create a new subscription to the MEC service availability notifications. Upon success, the response contains payload body with describing the subscription for the requestorcreated subscription. This method is typically used in "Subscribing to service availability event notifications" procedure
Resource URI	/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/subscriptions/{subscriptionId}
Request Body Parameters - None				201
Response Parameters
Parameter Name	Cardinality	Type	Description
SerAvailabilityNotification SubscriptionSerAvailabilityNotificatio nSubscription	1	Complex	Upon success, a response body containing the requested subscription is returned.

Individual Service Management Deletion

...

Response Codes	201 : Created
Payload body in the request contains a subscription to the MEC service availability notifications that is to be created.
Response Parameters
Parameter Name	Cardinality	Type	Description
SerAvailabilityNotificatio nSubscription	1	Complex	Upon success, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created subscription resource.

Individual Service Management Subscription

7.	API Name	Single Subscription Information	Type : GET	Interface :

MM1

MP1
Description

This

The GET method

retrieves

requests information about a

mecService resource that is associated with an application instance. This method is typically used in "service availability query"

subscription for this Requestor. Upon success, the response contains payload body with the subscription for the Requestor
Resource URI		/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/

services

subscriptions/{

serviceId

Response Codes
subscriptionId}
Request Body Parameters - None

200: OK

201
Response Parameters
Parameter Name		Cardinality	Type	Description

ServiceInfo10

SerAvailabilityNotification Subscription

1

Complex

It is used to indicate nonspecific success. The response body contains a representation of the resource.

Update Service Information

Upon success, a response body containing the requested subscription is returned.

Individual Service Management Deletion

8.	API Name

Update Service Information

Delete Individual Subscription	Type :

GET

DELETE	Interface :

MM1

MP1
Description

This method updates the information about a mecService resource that is associated with the application instance

		This method is typically used in "Unsubscribing from event notifications" procedure
Resource URI		/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/

services/{serviceId}Request Body Parameters - NoneParameter NameCardinalityTypeDescriptionServiceInfo1ComplexIt is used to indicate nonspecific success. The response body contains a representation of the resource.Response

Response Codes
subscriptions/{subscriptionId}
Request Body Parameters - None

200

204 :

OKParameter NameCardinalityTypeDescriptionServiceInfo1ComplexUpon success, a response body containing data type describing the updated ServiceInfo is returned.

Service Deregistration Information

11

No content
Response Parameters - None

Get Service Information

9.	API Name	Get Service

Deregistration

Information	Type :

DELETE

GET	Interface :

MM1

MP1
Description		This method

deletes

retrieves information about a mecService

resource

resource that is associated with an application instance. This method is typically used in

the service deregistration procedure

Response Codes
"service availability query"
Resource URI		/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/services/{serviceId}
Request Body Parameters - None

204

200:

No Content

OK
Response Parameters
Parameter

NameCardinalityTypeDescription

Types

...

AppPkgInfo Parameters

...

Application Provider.

Ex : Huawei

...

CreateAppPkg Parameters

Attribute NameCardinalityData TypeDescriptionappPkgName1StringApplication Package Name to be onboardedappPkgVersion1StringApplication Package Version to be onboarded

appProvider

0..1StringThe provider's name of the application package to be onboarded.checksumchecksumchecksumChecksum of the onboarded application packageuserDefinedData0..1KeyValuePairUser defined data for the application package.appPkgPath1StringAddress information of the application package Currently not in use

Name		Cardinality	Type	Description
ServiceInfo		1	Complex	It is used to indicate nonspecific success. The response body contains a representation of the resource.

Update Service Information

10.	Update Service Information	Type : GET	Interface : MP1
Description	This method updates the information about a mecService resource that is associated with the application instance
Resource URI	/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/services/{serviceId}
Request Body Parameters - None
Parameter Name	Cardinality	Type	Description
ServiceInfo	1	Complex	It is used to indicate nonspecific success. The response body contains a representation of the resource.
Response Body Parameters - None
Response Codes	200: OK
Parameter Name	Cardinality	Type	Description
ServiceInfo	1	Complex	Upon success, a response body containing data type describing the updated ServiceInfo is returned.

Service Deregistration Information

11.	Service Deregistration	Type : DELETE	Interface : MP1
Description	This method deletes a MEC Service resource. This method is typically used in the service deregistration procedure
Resource URI	/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/services/{serviceId}
Request Body Parameters - None
Response Codes	204 : No Content
Response Parameters
Parameter Name	Cardinality	Type	Description

Types

ApplnstanceInfo

Anchor
ApplnstanceInfo
ApplnstanceInfo

ApplnstanceInfo Parameters
Attribute Name	Cardinality	Data Type	Description
ID	1	String	Application Instance Description Ex : ID1
AppInstanceName	0..1	String	Application Descriptor ID
AppInstanceDescription	0..1	String	Application Provider Ex: Huawei
AppDID	1	String	Application Name Ex : Face_Recognition.
AppProvider	1	String
AppName	1	String	Deploy Type ; Ex : Helm
AppSoftVersion	1	String	Application Package ID Ex: b1bb0ce7-ebca-4fa7-95ed-4840d70a1177
AppDVersion	1	String	Instantiation State. Ex : NOT_INSTANTIATED

InstantiateAppRequest
Anchor
InstantiateAppRequest
InstantiateAppRequest

InstantiateAppRequest Parameters
Attribute Name	Cardinality	Data Type	Description
selectedMECHostInfo	1..N	MECHostInformation	Describes the information of selected host for the application instance

TerminateAppRequest
Anchor
TerminateAppRequest
TerminateAppRequest

TerminateAppRequest Parameters
Attribute Name	Cardinality	Data Type	Description
terminationType	1	Enum	Indicates whether forceful or graceful termination is requested. See note. • FORCEFUL: it will shut down the application instance and release the resources immediately after accepting the request. See note. • GRACEFUL: it will first arrange to take the application instance out of service after accepting the request. Once the operation of taking the application instance out of service finishes or once the timer value specified in the "gracefulTerminationTimeout" attribute expires, it will shut down the application instance and release the resources.
gracefulTerminationTimeout	0..1	Integer	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. The unit is seconds. If 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.

ServiceInfo
Anchor
ServiceInfo
ServiceInfo

ServiceInfo Parameters
Attribute Name	Cardinality	Data Type	Description
serInstanceId	0..1	SerInstanceId	Identifier of the service instance assigned by the MEPM/MEC platform. For the uniqueness of the identifier across the MEC system, UUID format [i.7] is recommended. Shall be absent in POST requests, and present otherwise.
serName	1	serName	The name of the service. This is how the service producing MEC application identifies the service instance it produces.
serCategory	0..1	CategoryRef	A Category reference. (The category resource is used to group product offerings, service and resource candidates in logical containers. Categories may contain other categories and/or product offerings, resource or service candidates.) (see note 1) For the serCategory, the example values include: 1. "RNI" 2. "Location" 3. "Bandwidth Management".
version	1	String	Version of the Service
state	1	ServiceState	Contains the service state.
transportId	0..1	String	Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the "Transport information query" procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.
transportInfo	0..1	TransportInfo	Information regarding the transport used by the service. May be present in POST requests to signal the use of an application-provided transport for the service, and shall be present otherwise.
serializer	1	Serializer Type	Indicate the supported serialization format of the service
scopeOfLocality	0..1	LocalityType	The scope of locality as expressed by "consumedLocalOnly" and "isLocal". If absent, defaults to MEC_HOST
consumedLocalOnly	0..1	Boolean	Indicate whether the service can only be consumed by the MEC applications located in the same locality (as defined by scopeOfLocality) as this service instance (TRUE) or not (FALSE). Default to TRUE if absent.
isLocal	0..1	Boolean	Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application (TRUE) or not (FALSE). Default to TRUE if absent.

TransportInfo
Anchor
TransportInfo
TransportInfo

TransportInfo Parameters
Attribute Name	Cardinality	Data Type	Description
id	1	string	The identifier of this transport.
name	1	string	The name of this transport. .
description	0..1	string	Human-readable description of this transport.
type	1

R3 - API Documentation Enterprise Application on Lightweight 5G Telco Edge (EALTEdge) [WIP]

#TransportType	Type of the transport
protocol		1	string	The name of the protocol used. Shall be set to "HTTP" for a REST API
version		1	String	The version of the protocol used.
endpoint		1	EndPointInfo	Information about the endpoint to access the transport.
security		1	SecurityInfo	Indicate the supported serialization format of the service
implSpecificInfo		0..1	Not Specified	Additional implementation specific details of the transport.

Enumeration

TransportType
Anchor
TransportType
TransportType

TransportType Parameters
Enumeration Value		Description
REST_HTTP		RESTful API using HTTP (as defined in IETF RFC 7230 [11] and related specifications).
MB_TOPIC_BASED		Topic-based message bus which routes messages to receivers based on subscriptions, if a pattern passed on subscription matches the topic of the message. EXAMPLE: MQTT (see [i.4])
MB_ROUTING		Routing-based message bus which routes messages to receivers based on subscriptions, if a key passed on subscription is equal to the key of the message.
MB_PUBSUB		Publish-subscribe based message bus which distributes messages to all subscribers.
RPC		Remote procedure call. EXAMPLE: GRPC
RPC_STREAMING		Remote procedure call supporting streams of requests and responses. EXAMPLE: GRPC
WEBSOCKET		Websockets as defined in IETF RFC 6455 [12].

Version	Old Version 9	New Version Current
Changes made by	Abhijit Dasgupta	vidyashree.rama
Saved on	May 11, 2020	Aug 15, 2020

Get Service Information of a specific service. Service Id is passed in the request URI
Resource URI		/ealtedge/mep/mec_service_mgmt/v1/

Page Comparison

Versions Compared

Key

<span class="diff-html-changed" data-a11y-before="Start of changed content" data-a11y-after="End of changed content" id="changed-diff-0">[data-colorid=</span>

<span class="diff-html-added" data-a11y-before="Start of added content" data-a11y-after="End of added content" id="added-diff-4">dhdru4r4cy</span><span class="diff-html-changed" data-a11y-before="Start of changed content" data-a11y-after="End of changed content" id="changed-diff-5">]{color:</span>

<span class="diff-html-added" data-a11y-before="Start of added content" data-a11y-after="End of added content" id="added-diff-6">dhdru4r4cy</span><span class="diff-html-changed" data-a11y-before="Start of changed content" data-a11y-after="End of changed content" id="changed-diff-7">]{color:</span>

API Definitions

Application Package Management

Onboard Application

Get Package Info

Delete Application Package

Application Life Cycle Management

Create Application Instance

Get Application Instance Information

Introduction

API Definitions

Application Life Cycle Management

Create Application Instance

Get Application Instance

Instantiate Application

Delete Application Instance

Terminate Application

Instantiate Application

MEC Service Management

Get Service List

Get Service

Terminate Application

MEC Service Management

Get Service List

Get Service

Service Registration

Service Management Subscription

Service Management Subscription

Individual Service Management Subscription

Service Subscription

Get Service Information

Individual Service Management Deletion

Individual Service Management Subscription

Update Service Information

Individual Service Management Deletion

Service Deregistration Information

Get Service Information

Types

Update Service Information

Service Deregistration Information

Types

ApplnstanceInfo

AnchorApplnstanceInfoApplnstanceInfo

InstantiateAppRequest AnchorInstantiateAppRequestInstantiateAppRequest

TerminateAppRequest AnchorTerminateAppRequestTerminateAppRequest

ServiceInfo AnchorServiceInfoServiceInfo

TransportInfo AnchorTransportInfoTransportInfo

Enumeration

TransportType AnchorTransportTypeTransportType

Anchor
ApplnstanceInfo
ApplnstanceInfo

InstantiateAppRequest
Anchor
InstantiateAppRequest
InstantiateAppRequest

TerminateAppRequest
Anchor
TerminateAppRequest
TerminateAppRequest

ServiceInfo
Anchor
ServiceInfo
ServiceInfo

TransportInfo
Anchor
TransportInfo
TransportInfo

TransportType
Anchor
TransportType
TransportType