Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

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.API NameCreate Application InstanceType : POST Interface : MM3
DescriptionThe 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 NameCardinalityTypeDescription

appDId

1StringApplication Description ID
appInstancename1StringApplication Instance Name

appInstanceDescriptor

1StringApplication Instance Descriptor
Response Codes201
Response Parameters
Parameter NameCardinalityTypeDescription
AppInstanceInfo1ComplexApplication Instance Info

...

4.API Name: Instantiate ApplicationType : POST 

Interface : MM3

DescriptionThis 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 NameCardinalityTypeDescription

#InstantiateAppRequest

1ComplexRequest parameters of the "Instantiate Application" operation

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

...

5.API Name: Terminate ApplicationType : POST 

Interface : MM3

DescriptionThis 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
NameCardinalityTypeDescription

#TerminateAppRequest                     

1Complex

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

...

1.API NameGet Service ListType : GETInterface : MP1
DescriptionTo get the List of all the Services Registered in MEP services

/ealtedge/mep/mec_service_mgmt/v1/services
Request Body Parameters - No Parameters
Response Codes201
Response Parameters
Parameter NameCardinalityTypeDescription




Get Service

2.API NameGet Service ID InformationType : GETInterface : MP1
DescriptionGet 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 Codes201
Response Parameters
Parameter NameCardinalityTypeDescription




...

3.API NameService RegistrationType : POSTInterface : MP1
DescriptionThis 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 NameCardinalityTypeDescription
ServiceInfo1Complex
Response Codes201 : Created
Response Parameters
Parameter NameCardinalityTypeDescription
ServiceInfo1ComplexUpon success, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource.



4.API NameService RegistrationAvailability InformationType : GETInterface : MP1
DescriptionThis 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 Codes201 : Created
Response Parameters
Parameter NameCardinalityTypeDescription
ServiceInfo0..NComplexUpon success, a response body containing an array of the mecServices is returned.

Service Management Subscription

5.API NameService Management Fetch all Subscription InformationType : GETInterface : MP1
DescriptionThe 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 Codes200 : OK
Response Parameters
Parameter NameCardinalityTypeDescription
SubscriptionLinkList1ComplexUpon success, a response body containing the list of links to the requested subscriptions is returned.

...

Individual Service Management Subscription

7.API Nameindividual mecSrvMgmtSubscriptionSingle Subscription InformationType : GETInterface : MP1
DescriptionThe 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 Codes201
Response Parameters
Parameter NameCardinalityTypeDescription
SerAvailabilityNotification Subscription1ComplexUpon success, a response body containing the requested subscription is returned.

Individual Service Management Deletion

8.API NameDelete mecSrvMgmtSubscriptionIndividual SubscriptionType : DELETEInterface : MP1
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 Codes204 : No content
Response Parameters - None

...

11.API NameService DeregistrationType : DELETEInterface : MP1
DescriptionThis method deletes a mecService 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 Codes204 : No Content
Response Parameters
Parameter NameCardinalityTypeDescription




...