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

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

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 :- 

  1. Application Life Cycle Management

  2. MEC Service Management.

API Definitions

Application Life Cycle Management

Create Application Instance

1.

API Name

Create Application Instance

Type : POST 

Interface : MM3

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

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

2.

API Name / Category

Application Instance Info 

Type : GET

Interface : MM3

Description

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

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 instance identifier operation"

Resource URI

/ealtedge/mepm/app_lcm/v1/app_instances/{appInstanceId}

Request Body Parameters - None

 

Response Codes

204

Response Parameters - No Content

Instantiate Application

4.

API Name: Instantiate Application

Type : POST 

Interface : MM3

4.

API Name: Instantiate Application

Type : POST 

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

1

Complex

Request parameters of the "Instantiate Application" operation

 

Response Codes

202 -  Accepted. The request was accepted for processing, but the processing has not yet been completed

Response Parameters - Response Body is Empty

Terminate Application