Table of Contents
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 MM1 Interface.

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) . and 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 Package ManagementApplication Life Cycle Management
MEC Service Management.

API Definitions

Application

...

Life Cycle Management

...

Create Application Instance

1.	API Name

Onboard

Create Application Instance	Type : POST	Interface : MM3
Description		This API is for MEO to onboard package, currently we just upload package directly to MEPM-APPLCM in the rest request, appPkgPath is of no use
Resource URI		/ealtedge/mepm/app_

pkgm

lcm/v1/app_

packages/

instances
Request Body Parameters
Parameter Name	Cardinality	Type	Description
appDId	1	String	Application Description

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

ID
appInstancename	1	String	Application Instance Name
appInstanceDescriptor	1	String	Application Instance Descriptor

Complex

Response Codes		201

: Created


Response Parameters
Parameter Name		Cardinality	Type	Description

R3 - API Documentation Enterprise Application on Lightweight 5G Telco Edge (EALTEdge) [WIP]0..NComplexIndicates a successful request. The response body shall contain a representation of the application package resource.

...

AppInstanceInfo

1

Complex

Application Instance Info

Get Application Instance Information

2.	API

Name Get Package

Name / Category	Application Instance Info	Type : GET	Interface : MM3
Description		This API is for MEO to onboard package, currently we just upload package directly to MEPM-APPLCM in the rest request, appPkgPath is of no use
Resource URI		/ealtedge/mepm/app_

pkgm

lcm/v1/app_

packages

instances/{

{ID

appInstanceId}

}

Request

Request Body Parameters -

Not Applicable

	201
None
Response Parameters
Parameter Name	Cardinality	Type	Description

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

/ Example
AppInstanceInfo		1	Complex	Application Instance Info

Delete Application

...

Instance

3.	API

Name Delete Package

Name: Delete Application Instance		Type : DELETE	Interface : MM3
Description		The DELETE method

realizes

deletes an individual application instance resource, which refers to the procedure of "

delete operation" of application package resource in MEO

delete application instance identifier operation"
Resource URI

Resource URI

/ealtedge/mepm/app_

pkgm

lcm/v1/app_

packages

instances/{

{ID}

appInstanceId}
Request Body Parameters -

Not Applicable

	Response Codes	204
None

. No Response body will be returned.

Application Life Cycle Management

Create Application Instance


Response Parameters - No Content

Instantiate Application

4

1

.	API Name

Create

: Instantiate Application

InstanceResource URI

		Type : POST	Interface : MM3
Description

This API is for MEO to onboard package, currently we just upload package directly to MEPM-APPLCM in the rest request, appPkgPath is of no use

		To instantiate the application instance
Resource URI

/ealtedge/mepm/app_lcm/v1/app_instances/{appInstanceId}/instantiate
Request Body Parameters

Parameter

Attribute Name

Cardinality

Type

Description

appDId

InstantiateAppRequest

1

StringApplication Description IDappInstancename1StringApplication Instance Name

appInstanceDescriptor

1StringApplication Instance DescriptorResponse Codes201Response ParametersParameter NameCardinalityTypeDescriptionR3 - API Documentation Enterprise Application on Lightweight 5G Telco Edge (EALTEdge) [WIP]1ComplexApplication Instance Info

Get Application Instance Information

...

	Response Codes	202 - Accepted. The request was accepted for processing, but the processing has not yet been completed
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 (OSS→ MEO, MEO->MEPM)
Description		To instantiate the 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 : MM1
Description	To get the List of all the Services Registered in MEP services
	/ealtedge/mep/mec_service_mgmt/v1/services
Request Body Parameters - No Parameters
Response Codes	201
Response Parameters
Parameter Name	Cardinality	Type	Description

Get Service

2.	API Name		Type : GET	Interface : MM1
Description		Get Service Information of a specific service. Service Id is passed in the request URI

...

Delete Application Instance

3.API Name: Delete Application InstanceType : DELETEInterface : MM3DescriptionThe DELETE method deletes an individual application instance resource, which refers to the procedure of "delete application instance identifier operation"


Resource URI		/ealtedge/

mepm

mep/

app

mec_service_

lcm

mgmt/v1/

app_instances/{appInstanceId}

services/serviceId
Request Body Parameters -

None

Response Codes
No Parameters

204

201
Response Parameters

- No Content

Instantiate Application


Parameter Name	Cardinality	Type	Description

Service Registration

3

4

.	API Name

: Instantiate Application

	Service Registration	Type :

POST

POST	Interface :

MM3

OSS→ MEO, MEO->MEPM

MM1
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

DescriptionTo instantiate the application instance


Resource URI		/ealtedge/

mepm/app_lcm

mec_service_mgmt/v1/

app_instances

applications/{appInstanceId}/

instantiate

services
Request Body Parameters

Attribute

Parameter Name

Cardinality

Type

Description

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

Response Codes	201 : Created

ServiceInfo	1	Complex
Response Parameters
Parameter Name	Cardinality	Type	Description
ServiceInfo	1	Complex

Request 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

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

4.	API Name	Service Registration	Type : GET	Interface : MM1
Description		This method retrieves information about a list of mecService resources that is associated with an application instance. This method is typically used in "service availability query" procedure

5.API Name: Terminate ApplicationType : POST

Interface : MM3 (OSS→ MEO, MEO->MEPM)

DescriptionTo instantiate the application instance


Resource URI		/ealtedge/

mepm/app_lcm

mec_service_mgmt/v1/

app_instances

applications/{appInstanceId}/

terminate

Response Codes	201 : Created
services
Request Body Parameters – None
Response Parameters
Parameter Name	Cardinality	Type	Description

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


ServiceInfo		0..N	Complex	Upon success, a response body containing an array of the mecServices is returned.

Service Management Subscription

5.	API Name	Service Management Subscription

1.API NameGet Service List

	Type : GET	Interface : MM1
Description

To get the List of all the Services Registered in MEP services

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
Resource URI		/ealtedge

/ealtedge/mep

/mec_service_mgmt/v1

/services

/applications/{appInstanceId}/subscriptions
Request Body Parameters -

No Parameters

Response Codes
None

201

200 : OK
Response Parameters
Parameter Name		Cardinality	Type	Description

...

SubscriptionLinkList

2.

1

API NameType : GETInterface : MM1DescriptionGet Service Information of a specific service. Service Id is passed in the request URIResource URI/ealtedge/mep/mec_service_mgmt/v1/services/serviceIdRequest Body Parameters - No ParametersResponse Codes201Response ParametersParameter NameCardinalityTypeDescription

Service Registration

Complex

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

Service Subscription

6.	API Name	New service Subscription	Type : POST	Interface

3.API NameService RegistrationType : POSTInterface

: MM1
Description

This

The POST method

is

may be used to create a

mecService resource that is associated with the application instance. This method is

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 describing the created subscription. This method is typically used in "Subscribing to service availability

update and new service registration

event notifications" procedure
Resource URI		/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/

services

subscriptions
Request Body Parameters
Parameter Name	Cardinality	Type	Description

ServiceInfo

Response Codes	201 : Created
SerAvailabilityNotificatio nSubscription	1	Complex	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

ServiceInfo

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

4

7.	API Name

Service Registration

individual mecSrvMgmtSubscription	Type : GET	Interface : MM1
Description

This

The GET method

retrieves

requests information about a

list of mecService resources that is associated with an application instance. This method is typically used in "service availability query" procedure

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/{subscriptionId}
Request Body

Parameters –

Response Codes		201
Parameters - None

: Created


Response Parameters
Parameter Name		Cardinality	Type	Description

ServiceInfo0..N

SerAvailabilityNotification Subscription

1

Complex

Upon success, a response body containing

an array of

the

mecServices

requested subscription is returned.

Individual Service Management

...

Deletion

5

8.	API Name

Service Management Subscription

Delete mecSrvMgmtSubscription	Type :

GET

DELETE	Interface : MM1
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

Response Codes
.This method is typically used in "Unsubscribing from event notifications" procedure
Resource URI		/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/subscriptions/{subscriptionId}
Request Body Parameters - None

200

204 :

OK

No content
Response Parameters

Parameter NameCardinalityTypeDescriptionSubscriptionLinkList1ComplexUpon success, a response body containing the list of links to the requested subscriptions is returned.

Service Subscription

- None

Get Service Information

9.	Get Service Information	Type : GET	Interface : MM1
Description	This method retrieves information about a mecService resource that is associated with an application instance. This method is typically used in "service availability query"
Resource URI	/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/services/{serviceId}
Request Body Parameters - None
Response Codes	200: OK
Response Parameters
Parameter 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

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

10.	API Name	Update Service Information	Type : GET	Interface : MM1
Description		This method updates the information about a mecService resource that is associated with the application instance
6.	API Name	New service Subscription	Type : POST	Interface : MM1
Description		The POST 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 describing the created subscription. This method is typically used in "Subscribing to service availability event notifications" procedure
Resource URI		/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/services/subscriptions{serviceId}
Request Body Parameters - None
Parameter Name		Cardinality	Type	Description
SerAvailabilityNotificatio nSubscriptionServiceInfo		1	Complex	Payload body in the request contains a subscription to the MEC service availability notifications that is to be created.
Response Codes		201 : Created
Response Parameters
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
SerAvailabilityNotificatio nSubscriptionServiceInfo		1	Complex	Upon success,

Individual Service Management Subscription

a response body containing data type describing the updated ServiceInfo is returned.

Service Deregistration Information

11

7

.	API Name

individual mecSrvMgmtSubscription

Service Deregistration	Type :

GET

DELETE	Interface : MM1
Description

The GET method requests information about a subscription for this requestor. Upon success, the response contains payload body with the subscription for the requestor

This method deletes a mecService resource. This method is typically used in the service deregistration procedure
Resource URI		/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/

subscriptions

services/{

subscriptionId

serviceId}
Request Body Parameters - None

Response Codes201Response ParametersParameter NameCardinalityTypeDescriptionSerAvailabilityNotification Subscription1ComplexUpon success, a response body containing the requested subscription is returned.

Individual Service Management Deletion

...

Response Codes	204 : No Content

Response Parameters
Parameter Name	Cardinality	Type	Description

Types

Get Service Information

...

Update Service Information

...

Service Deregistration Information

...

Types

...

AppPkgInfo Parameters

...

Application Provider.

Ex : Huawei

...

CreateAppPkg Parameters

...

appProvider

...

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].

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 9

New Version 10

Key

Table of ContentsIntroduction

API Definitions

Application

Life Cycle Management

Create Application Instance

Get Application Instance Information

Delete Application

Instance

Application Life Cycle Management

Create Application Instance

Instantiate Application

Get Application Instance Information

Terminate Application

MEC Service Management

Get Service List

Get Service

Delete Application Instance

Instantiate Application

Service Registration

Terminate Application

MEC Service Management

Get Service List

Service Management Subscription

Service Registration

Service Subscription

Individual Service Management Subscription

Individual Service Management

Deletion

Service Subscription

Get Service Information

Update Service Information

Individual Service Management Subscription

Service Deregistration Information

Individual Service Management Deletion

Types

Get Service Information

Update Service Information

Service Deregistration Information

Types

ApplnstanceInfo

AnchorApplnstanceInfoApplnstanceInfo

InstantiateAppRequest AnchorInstantiateAppRequestInstantiateAppRequest

TerminateAppRequest AnchorTerminateAppRequestTerminateAppRequest

ServiceInfo AnchorServiceInfoServiceInfo

TransportInfo AnchorTransportInfoTransportInfo

Enumeration

TransportType AnchorTransportTypeTransportType

Table of Contents
Introduction

Anchor
ApplnstanceInfo
ApplnstanceInfo

InstantiateAppRequest
Anchor
InstantiateAppRequest
InstantiateAppRequest

TerminateAppRequest
Anchor
TerminateAppRequest
TerminateAppRequest

ServiceInfo
Anchor
ServiceInfo
ServiceInfo

TransportInfo
Anchor
TransportInfo
TransportInfo

TransportType
Anchor
TransportType
TransportType