Versions Compared

Key

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

...

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

appDId

1StringApplication Description ID
appInstancename1StringApplication Instance Name

appInstanceDescriptor

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

Get Application Instance Information

2.API Name / CategoryApplication Instance Info Type : GETInterface : MM3
DescriptionThis 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/{appInstanceId}
Request Body Parameters - None

Response Codes201
Response Parameters
Parameter NameCardinalityTypeDescription / Example
AppInstanceInfo1ComplexApplication Instance Info

Delete Application Instance

...

4.API Name: Instantiate ApplicationType : POST 

Interface : MM3

DescriptionTo instantiate the application instance
Resource URI/ealtedge/mepm/app_lcm/v1/app_instances/{appInstanceId}/instantiate 
Request Body Parameters
Attribute NameCardinalityTypeDescription

InstantiateAppRequest28968670

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 (OSS→ MEO, MEO->MEPM)

DescriptionTo instantiate the application instance
Resource URI/ealtedge/mepm/app_lcm/v1/app_instances/{appInstanceId}/terminate
Request Body Parameters
NameCardinalityTypeDescription

TerminateAppRequest28968670                     

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




...

2.API Name
Type : GETInterface : MM1MP1
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 : MM1MP1
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 RegistrationType : GETInterface : MM1MP1
DescriptionThis 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
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.

...

5.API NameService Management SubscriptionType : GETInterface : MM1MP1
DescriptionThe 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/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.

...

6.API NameNew service SubscriptionType : POSTInterface : MM1MP1
DescriptionThe 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 NameCardinalityTypeDescription
SerAvailabilityNotificatio nSubscription1ComplexPayload body in the request contains a subscription to the MEC service availability notifications that is to be created.
Response Codes201 : Created
Response Parameters
Parameter NameCardinalityTypeDescription
SerAvailabilityNotificatio nSubscription1ComplexUpon success, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created subscription resource.

...

7.API Nameindividual mecSrvMgmtSubscriptionType : GETInterface : MM1MP1
DescriptionThe GET method requests information about a 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}/subscriptions/{subscriptionId}
Request Body Parameters - None
Response Codes201
Response Parameters
Parameter NameCardinalityTypeDescription
SerAvailabilityNotification Subscription1ComplexUpon success, a response body containing the requested subscription is returned.

...

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

...

9.API NameGet Service InformationType : GETInterface : MM1MP1
DescriptionThis 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 Codes200: OK
Response Parameters
Parameter NameCardinalityTypeDescription
ServiceInfo1ComplexIt is used to indicate nonspecific success. The response body contains a representation of the resource.

...

10.API NameUpdate Service InformationType : GETInterface : MM1MP1
DescriptionThis 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 NameCardinalityTypeDescription
ServiceInfo1ComplexIt is used to indicate nonspecific success. The response body contains a representation of the resource.
Response Body Parameters - None
Response Codes200: OK
Parameter NameCardinalityTypeDescription
ServiceInfo1ComplexUpon success, a response body containing data type describing the updated ServiceInfo is returned.

Service Deregistration Information

11.API NameService DeregistrationType : DELETEInterface :
MM1
MP1
DescriptionThis method deletes a mecService 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




Types

ApplnstanceInfo

Anchor
ApplnstanceInfo
ApplnstanceInfo

...

TransportInfo Parameters

Attribute NameCardinalityData TypeDescription
id1stringThe identifier of this transport.
name1stringThe name of this transport. .
description0..1stringHuman-readable description of this transport.
type1TransportType28968670Type of the transport
protocol1stringThe name of the protocol used. Shall be set to "HTTP" for a REST API
version1StringThe version of the protocol used.
endpoint1EndPointInfoInformation about the endpoint to access the transport.
security1SecurityInfoIndicate the supported serialization format of the service
implSpecificInfo0..1Not SpecifiedAdditional implementation specific details of the transport.

...