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'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 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 |
...
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 | |
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 |
...
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 | |
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. | API Name | 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 | ||||
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 : MP1 |
---|---|---|---|---|
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. | API Name | Service Registration | Type : POST | Interface : 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 | |||
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. | API Name | Service RegistrationAvailability Information | Type : GET | Interface : MP1 |
---|---|---|---|---|
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. | API Name | Service Management Fetch all Subscription Information | Type : GET | Interface : MP1 |
---|---|---|---|---|
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. |
...
Individual Service Management Subscription
7. | API Nameindividual | mecSrvMgmtSubscriptionSingle Subscription Information | Type : GET | Interface : MP1 |
---|---|---|---|---|
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 : 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 Codes | 204 : No content | |||
Response Parameters - None |
...
11. | API Name | Service Deregistration | Type : DELETE | Interface : MP1 |
---|---|---|---|---|
Description | This 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 Codes | 204 : No Content | |||
Response Parameters | ||||
Parameter Name | Cardinality | Type | Description | |
...