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 MP1 Interface.

The API 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 managementETSI GS MEC 010-2 V2.1.1 management. (https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf) and ) 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 :-

...

1.	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"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_lcm/v1/app_instances
Request Body Parameters
Parameter Name	Cardinality	Type	Description
appDId	1	String	Application Description ID
appInstancename	1	String	Application Instance Name
appInstanceDescriptor	1	String	Application Instance Descriptor
Response Codes	201
Response Parameters
Parameter Name	Cardinality	Type	Description
AppInstanceInfo	1	Complex	Application Instance Info

Get Application Instance

...

2. API 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
The GET method retrieves the information of an individual application instance via reading an individual application instance resource, which is used by the procedure of "query application instance information operation"

Resource URI /ealtedge/mepm/app_lcm/v1/app_instances/{appInstanceId}
Request Body Parameters - None

Response Codes 201
Response Parameters
Parameter Name Cardinality Type Description / Example
AppInstanceInfo 1 Complex Application Instance Info

Delete Application Instance

3.	API Name: Delete Application Instance		Type : DELETE	Interface : MM3
Description		The DELETE method deletes an individual application instance resource, which refers to the procedure of "

delete application

	Response Codes	204
delete application instance identifier operation"
Resource URI		/ealtedge/mepm/app_lcm/v1/app_instances/{appInstanceId}
Request Body Parameters - None
Response Parameters - No Content

Instantiate Application

4.	API Name: Instantiate Application		Type : POST	Interface

: MM3DescriptionTo instantiate the application instance

: MM3
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}/instantiate
Request Body Parameters
Attribute Name	Cardinality	Type	Description

InstantiateAppRequest

	Response Codes	202 - Accepted. The request was accepted for processing, but the processing has not yet been completed
#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 (OSS→ MEO, MEO->MEPM)
Description		To instantiate the 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 #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

...

1.	Get Service List	Type : GET	Interface : MM1MP1
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	Get Service ID Information	Type : GET	Interface : MM1MP1
Description	Get Service Information of a specific service. Service Id is passed in the request URI
Resource URI	/ealtedge/mep/mec_service_mgmt/v1/services/serviceId
Request Body Parameters - No Parameters
Response Codes	201
Response Parameters
Parameter Name	Cardinality	Type	Description

...

3.	Service Registration	Type : POST	Interface : MM1MP1
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
Resource URI	/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/services
Request Body Parameters
Parameter Name	Cardinality	Type	Description
ServiceInfo	1	Complex
Response Codes	201 : Created
Response Parameters
Parameter Name	Cardinality	Type	Description
ServiceInfo	1	Complex	Upon success, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource.

4.	Service RegistrationAvailability Information	Type : GET	Interface : MM1MP1
Description	This method retrieves information about a list of mecService 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}/services
Request Body Parameters – None
Response Codes	201 : Created
Response Parameters
Parameter Name	Cardinality	Type	Description
ServiceInfo	0..N	Complex	Upon success, a response body containing an array of the mecServices is returned.

Service Management Subscription

5.	Service Management Fetch all Subscription Information	Type : GET	Interface : MM1MP1
Description	The GET method may be used to request information about all subscriptions for this requestorrequester. Upon success, the response contains payload body with all the subscriptions for the requestorrequester
Resource URI	/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/subscriptions
Request Body Parameters - None
Response Codes	200 : OK
Response Parameters
Parameter Name	Cardinality	Type	Description
SubscriptionLinkList	1	Complex	Upon success, a response body containing the list of links to the requested subscriptions is returned.

...

6.	New service Subscription	Type : POST	Interface : MM1MP1
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}/subscriptions
Request Body Parameters
Parameter Name	Cardinality	Type	Description
SerAvailabilityNotificatio nSubscription	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
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.	mecSrvMgmtSubscriptionSingle Subscription Information	Type : GET	Interface : MM1MP1
Description	The GET method requests information about a subscription for this requestorRequestor. Upon success, the response contains payload body with the subscription for the requestorthe Requestor
Resource URI	/ealtedge/mec_service_mgmt/v1/applications/{appInstanceId}/subscriptions/{subscriptionId}
Request Body Parameters - None
Response Codes	201
Response Parameters
Parameter Name	Cardinality	Type	Description
SerAvailabilityNotification Subscription	1	Complex	Upon success, a response body containing the requested subscription is returned.

Individual Service Management Deletion

8.	API Name	Delete mecSrvMgmtSubscriptionIndividual Subscription	Type : DELETE	Interface : MM1MP1
Description		.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
Response Codes		204 : No content
Response Parameters - None

...

9.	Get Service Information	Type : GET	Interface : MM1MP1
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.

...

10.	Update Service Information	Type : GET	Interface : MM1MP1
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.	API Name	Service Deregistration	Type : DELETE	Interface :

MM1

MP1
Description		This method deletes a

mecService

Response Codes	204 : No Content
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 Parameters
Parameter Name	Cardinality	Type	Description

Types

ApplnstanceInfo

Anchor
ApplnstanceInfo
ApplnstanceInfo

...

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	TransportType #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.

...

Space shortcuts

Page tree

Versions Compared

Old Version 10

New Version Current

Key

Table of Contents
Introduction

Get Application Instance

Delete Application Instance

Instantiate Application

Terminate Application

Get Service

Service Management Subscription

Individual Service Management Subscription

Individual Service Management Deletion

Service Deregistration Information

Types

ApplnstanceInfo

Anchor
ApplnstanceInfo
ApplnstanceInfo

	201
The GET method retrieves the information of an individual application instance via reading an individual application instance resource, which is used by the procedure of "query application instance information operation"
Resource URI	/ealtedge/mepm/app_lcm/v1/app_instances/{appInstanceId}
Request Body Parameters - None
Response Parameters
Parameter Name	Cardinality	Type	Description / Example
AppInstanceInfo	1	Complex	Application Instance Info

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 10

New Version Current

Key

Table of ContentsIntroduction

Get Application Instance

Delete Application Instance

Instantiate Application

Terminate Application

Get Service

Service Management Subscription

Individual Service Management Subscription

Individual Service Management Deletion

Service Deregistration Information

Types

ApplnstanceInfo

AnchorApplnstanceInfoApplnstanceInfo

Table of Contents
Introduction

Anchor
ApplnstanceInfo
ApplnstanceInfo