5 Services offered by Edge Enabler Server
24.5583GPPEnabling Edge ApplicationsProtocol specificationRelease 17TS
5.1 Introduction
The table 5.1-1 lists the Edge Enabler Server APIs below the service name. A service description clause for each API gives a general description of the related API.
Table 5.1-1: List of EES Service APIs
|
Service Name |
Service Operations |
Operation Semantics |
Consumer(s) |
|
Eees_EECRegistration |
Request |
Request/Response |
EEC |
|
Update |
Request/Response |
EEC |
|
|
Deregister |
Request/Response |
EEC |
|
|
Eees_EASDiscovery |
EasDiscRequest |
Request/Response |
EEC |
|
Subscribe |
Subscribe/Notify |
EEC |
|
|
Notify |
EEC |
||
|
UpdateSubscription |
Subscribe/Notify |
EEC |
|
|
Unsubscribe |
Subscribe/Notify |
EEC |
|
|
Eees_ACREvents |
Notify |
Subscribe/Notify |
EEC |
|
UpdateSubscription |
Subscribe/Notify |
EEC |
|
|
Unsubscribe |
Subscribe/Notify |
EEC |
|
|
Eees_AppContextRelocation |
Determine |
Request/Response |
EEC, EAS |
|
Initiate |
Request/Response |
EEC |
Table 5.1-2 summarizes the corresponding Edge Enabler Server APIs defined in this specification.
Table 5.1-2: API Descriptions
|
Service Name |
Clause |
Description |
OpenAPI Specification File |
apiName |
Annex |
|
Eees_EECRegistration |
6.2 |
Eees EEC Registration |
TS24558_Eees_EECRegistration.yaml |
eees-eecregistration |
A.2 |
|
Eees_EASDiscovery |
6.3 |
Eees EAS Discovery |
TS24558_ Eees_EASDiscovery.yaml |
eees-easdiscovery |
A.3 |
|
Eees_AppContextRelocation |
6.5 |
Eees Application Context Relocation |
TS24558_Eees_AppContextRelocation.yaml |
Eees-appctxtreloc |
A.5 |
5.2 Eees_EECRegistration Service
5.2.1 Service Description
The Eees_EECRegistration API, as defined in 3GPP TS 23.558 [2], allows an EEC via Eees interface to register, update its registration and deregister at a given EES.
5.2.2 Service Operations
5.2.2.1 Introduction
The service operation defined for Eees_EECRegistration API is shown in the table 5.2.2.1-1.
Table 5.2.2.1-1: Operations of the Eees_EECRegistration API
|
Service operation name |
Description |
Initiated by |
|
Eees_EECRegistration_Request |
This service operation is used by the EEC to register itself to a given EES. |
EEC |
|
Eees_EECRegistration_Update |
This service operation is used by the EEC to update its registration information at EES. |
EEC |
|
Eees_EECRegistration_Deregister |
This service operation is used by the EEC to deregister itself from a given EES. |
EEC |
5.2.2.2 Eees_EECRegistration_Request
5.2.2.2.1 General
This service operation is used by EEC to register itself with a given EES.
5.2.2.2.2 EEC registering to EES using Eees_EECRegistration_Request operation
For an EEC to register at the EES, the EEC shall send an HTTP POST message to the EES on the "EEC Registrations" collection resource to create the resource associated to or representing the EEC. The body of the HTTP POST message shall include the EEC ID, may include UE identifier, AC Profile(s), proposed expiration time for the registration, EEC context ID obtained from a previous registration, the ACR scenario(s) supported by the EEC for service continuity, as specified in clause 6.2.2.2.3.1. If EEC context ID is included in the body of the HTTP POST message, it shall also include Source EES ID and Source EES Endpoint of the EES that provided EEC context ID.
Upon receiving the HTTP POST message from the EEC, the EES shall:
a) Process the EEC registration request information;
b) verify if the EEC is authorized to register itself at EES; and
c) if the EEC is authorized to register with EES, then;
1) if the AC Profile(s) is included in the HTTP POST message, the EES further determines whether the registered EAS(s) fulfils the requirements that were indicated in the AC Profile(s):
i) if acSvcContSupp information is included in the AC Profile, the EEC, EES, and the matching EAS have to support ACRScenario indicated in the acSvcContSupp information; and
ii) For each AC Profile, if eass information is included in the AC Profile, the EES identifies the matching EAS such that the matching EAS shall:
A) be identified by the easId information; and
B) suffice all information included in the minimumReqSvcKPIs information.
NOTE 1: With respect to expectedSvcKPIs information, it is up to the EES implementation on how to identifies the matching EAS.
When a matching EAS is identified, the EES determines that the corresponding requirements are fulfilled and are supported for the new resource.
When a matching EAS is not identified for even one AC profile, the EES shall reject the request message by sending an HTTP response to the EEC with a status code set to 404 Not Found and indicate the "RESOURCE_NOT_FOUND" error in the "cause" attribute of the "ProblemDetails" structure.
2) if the received EEC registration request contains an EEC context ID, a source EES endpoint, the EES retrieves the EEC’s context from the source EES according to the procedures specified in clause 5.10 of 3GPP TS 29.558 [4];
3) the EES creates a new resource with the EEC registration information as specified in clause 6.2.2.1, and assigns and stores new EEC context ID;
i) if the EES cannot reserve the necessary resources while meeting the capability requirements of the existing registered EECs, the EES shall determine the EEC Context information stale and send a failure response with a corresponding cause as specified in clause 6.2.2.2.3.1; and
ii) Otherwise the EES shall return the EEC registration information in the response message. The response message may include expiration time to indicate when the EEC registration will automatically expire. The response message may include a newly assigned EEC context ID. The URI of the created resource shall be returned in the "Location" HTTP header. If the EEC registration request contains AC Profile(s), and the EES determines that the requirements indicated in the AC profile(s) cannot be fulfilled for some of the AC profile(s), the EES shall include "unfulfilledAcProfs" attribute containing the list of ACIDs of such AC Profile(s) and appropriate reasons as specified in clause 6.2.5.2.2.
The EEC stores the new EEC context ID and uses it when it registers with another EES.
If the expiration time is provided, then to maintain the registration, the EEC shall send a registration update request (as described in clause 5.2.2.3) prior to the expiration time. If a succesful registration update request is not received prior to the expiration time, then the EES shall treat the EEC as implicitly deregistered and remove the corresponding EEC registration resource.
5.2.2.3 Eees_EECRegistration_Update
5.2.2.3.1 General
This service operation is used by the EEC to update its registration information at the EES.
5.2.2.3.2 EEC updating registration information using Eees_EECRegistration_Update operation
To update the EEC registration information at the EES, the EEC shall send an HTTP PATCH request (for partial update) or HTTP PUT message (for fully replacement) to the EES on resource URI identifying the Individual EEC registration resource representation as specified in clause 6.2.2.3.3.3 for an HTTP PATCH message or in clause 6.2.2.3.3.1 for an HTTP PUT message.
The PATCH message includes the parameters (AC profiles or proposed expiry time) that need to be replaced in the existing registration information.
The PUT message shall replace all properties of the existing resource with the EEC registration information in the request. The value of the eecId provided during the EEC registration shall not be changed.
Upon receiving the HTTP PATCH or PUT message from the EEC, if the resource URI does not exist, the EES shall respond 404 Not Found error to the EEC. Otherwise, the EES shall:
a) check the registration update message from the EEC to see if the EEC is authorized to modify the requested registration resource; and
b) if the EEC is authorized to update the registration information and the eecId information in the request and the resource match, then the EES shall;
1) if the AC Profile(s) is included in the HTTP PATCH or PUT message, the EES further determines whether the registered EAS(s) fulfils the requirements that were indicated in the AC Profile(s):
i) if acSvcContSupp information is included in the AC Profile, the EEC, EES and the matching EAS have to support ACRScenario indicated in the acSvcContSupp information; and
ii) For each AC Profile, if EAS(s) information is included in the AC Profile, the EES identifies the matching EAS such that the matching EAS shall:
A) be identified by the easId information; and
B) suffice all information included in the minimumReqSvcKPIs information.
NOTE 1: With respect to expectedSvcKPIs information, it is up to the EES implementation on how to identifies the matching EAS.
When a matching EAS is identified for atleast one AC profile, the EES determines that the corresponding requirements are fulfilled and are supported and shall update the resource identified by Resource URI of the EEC registration information with the updated EEC registration information received in the HTTP PATCH or PUT request message.
2) return the updated EEC registration information in the response. In the response message, the EES may send "200 OK" response code to provide an updated expiration time to indicate to the EEC when the updated registration will automatically expire. Otherwise, the EES sends "204 No Content" response code. If the EEC registration request contains AC Profile(s), and the EES determines that the requirements indicated in the AC profile(s) cannot be fulfilled for some of the AC profile(s), the EES shall include "unfulfilledAcProfs" attribute containing the list of ACIDs of such AC Profile(s) and appropriate reasons as specified in clause 6.2.5.2.2.
If the expiration time is provided, the EEC shall send a registration update request prior to the expiration time if the EEC wants to maintain the registration. If a successful registration update request is not received prior to the expiration time, the EES shall treat the EEC as implicitly de-registered and remove the corresponding EEC registration resource.
5.2.2.4 Eees_EECRegistration_Deregister
5.2.2.4.1 General
This service operation is used by EEC to deregister itself from a given EES.
5.2.2.4.2 EEC deregistering from EES using Eees_EECRegistration_Deregister operation
To deregister itself from the EES, the EEC shall send HTTP DELETE message to the EES, on the resource URI identifying the Individual EEC registration resource representation as specified in clause 6.2.2.3.3.3. Upon receiving the HTTP DELETE request, the EES shall:
a) verify the identity of the EEC and check if the EEC is authorized to deregister the EEC registration information;
b) if the EEC is authorized to deregister the EEC registration information, then the EES shall
1) if the resource identified by registrationId is not found, return "404 Not Found" error message to the EEC;
2) otherwise, deregister the EEC profile from the EES and delete the resource representing EEC registration information; and
3) return the "204 No Content" message to the EEC, indicating the successful deregistration of the EEC information.
5.3 Eees_EASDiscovery service
5.3.1 Service Description
The Eees_EASDiscovery service enables a service consumer (e.g. EEC) to:
– request EAS discovery;
– request to subscribe to EAS discovery information reporting at the EES;
– request to update/modify/delete an existing subscription to EAS discovery information reporting; and
– receive notifications from the EES on EAS discovery information.
5.3.2 Service Operations
5.3.2.1 Introduction
The service operations defined for Eees_EASDiscovery API are shown in the table 5.3.2.1-1.
Table 5.3.2.1-1: Operations of the Eees_EASDiscovery API
|
Service operation name |
Description |
Initiated by |
|
Eees_EASDiscovery_EasDiscRequest |
This service operation is used by the EEC to request for one-time EAS discovery information. |
EEC |
|
Eees_EASDiscovery_Subscribe |
This service operation is used by the EEC to request to subscribe to EAS discovery information reporting. |
EEC |
|
Eees_EASDiscovery_Notify |
This service operation is used by the EES to notify a previously subscribed EEC on EAS discovery information. |
EES |
|
Eees_EASDiscovery_UpdateSubscription |
This service operation is used by the EEC to update an existing subscription to EAS discovery information reporting. |
EEC |
|
Eees_EASDiscovery_Unsubscribe |
This service operation is used by the EEC to delete an existing subscription to EAS discovery information reporting. |
EEC |
5.3.2.2 Eees_EASDiscovery_EasDiscRequest
5.3.2.2.1 General
This service operation is used by the EEC to request for one-time EAS discovery information.
5.3.2.2.2 EEC requesting EAS discovery information using Eees_EASDiscovery_EasDiscRequest operation
To request for one-time EAS discovery, the EEC shall send an HTTP POST request to the EES as specified in clause 6.3.2.4.4. The body of the POST message shall include the EasDiscoveryReq data structure as specified in clause 6.3.5.2.2.
Upon reception of the HTTP POST message from the EEC, the EES shall:
a) process the EAS discovery request information;
b) the EES verifies and checks if the EEC is authorized to discover the requested EAS(s) from EES;
c) if EEC is authorized to discover the requested EAS(s) from EES, the EEC is not registered with the EES, and the ECSP policy requires the EEC to perform EEC registration prior to EAS discovery, the EES shall reject the request by sending an HTTP "403 Forbidden" status code to the EEC including the ProblemDetails data structure with the "cause" attribute containing the "REGISTRATION_REQUIRED" application error;
d) if the EEC is authorized to discover the requested EAS(s) from EES and the EEC is registered as required by the ECSP policy, then the EES;
1) may obtain the UE’s location as specified in clause 5.3 of 3GPP TS 29.122 [3];
2) if EAS discovery filters are provided by the EEC, the EES identifies the EAS(s) based on the provided EAS discovery filters and the UE location;
3) if the EEC indicates that service continuity support is required, the EES shall take the indication which ACR scenarios are supported by the AC and the EEC and which of these are preferred by the AC into consideration. The EES identifies the EAS(s) who supports at least one of the ACR scenarios as indicated by EEC.
4) if EAS discovery filters are not provided:
i. if available, the EES identifies the EAS(s) based on the UE-specific service information at the EES and the UE location; and
ii. EES identifies the EAS(s) by applying the ECSP policy (e.g. based only on the UE location);
5) the EES may trigger the EAS management system to instantiate the EAS that matches with EAS discovery filter IEs; and
e) if the processing of the request was successful, the EES sends an EAS discovery response to the EEC as specified in clause 6.3.2.4.3.1, which includes information about the discovered EASs. The response shall include endpoint information for discovered EASs. Depending on the EAS discovery filters received in the EAS discovery request, the response may include additional information regarding matched capabilities, e.g. service permissions levels, KPIs, AC locations(s) that the EASs can support, ACR scenarios supported by the EAS, etc. The EAS discovery response may contain a list of EASs. This list may be based on EAS discovery filters containing a Geographical or Topological Service Area, e.g. a route, included in the EAS discovery request by the EEC.
If the successful processing of the request does not result in finding a matching EAS (i.e. there is no client side error), the EES responds with "204 No Content" HTTP status code. Otherwise, the EES shall reject the EAS discovery request and respond with an appropriate failure HTTP status code.
The EEC may cache the EAS information (e.g. EAS endpoint) for subsequent use and avoid the need to repeat this procedure. If the "lifeTime" attribute is included in the response, the EEC may cache the EAS information only for the duration specified by the Lifetime IE.
If the failure response is received for the EAS discovery request, the EEC may resend the EAS discovery request, taking into account the received failure cause. If the failure cause indicated "REGISTRATION_REQUIRED" error in the "cause" attribute of the "ProblemDetails" structure, the EEC shall perform an EEC registration as specified in clause 5.2.2.2.2 before resending the EAS discovery request.
5.3.2.3 Eees_EASDiscovery_Subscribe
5.3.2.3.1 General
This service operation is used by the EEC to subscribe to EES for reporting of EAS discovery information.
5.3.2.3.2 EEC subscribing to EAS discovery information from EES using Eees_EASDiscovery_Subscribe operation
To subscribe to changes of EAS discovery information at the EES, the EEC shall send an HTTP POST message to the EES on the "EAS Discovery Subscriptions" resource. The body of the POST message shall include the EASDiscoverySubscription data structure as specified in clause 6.3.2.2.3.1.
Upon receiving the HTTP POST message from the EEC, the EES:
a) shall process the EAS discovery subscription request;
b) if the EEC is not registered with the EES, and if ECSP policy requires the EEC to perform EEC registration prior to EAS discovery, the EES shall reject the request message by sending an HTTP response to the EEC with a status code set to 403 Forbidden and may indicate the "REGISTRATION_REQUIRED" error in the "cause" attribute of the "ProblemDetails" structure;
b) if the EEC is registered, the EES shall verify and check if the EEC is authorized to subscribe for information of the requested EAS(s) from EES;
c) if the EEC is authorized to discover the requested EAS(s) from EES, then the EES;
1) may obtain the UE’s location as specified in clause 5.3 of 3GPP TS 29.122 [3];
2) shall create a new Individual EAS Discovery Subscription resource as specified in clause 6.3.2.2.3.1; and
d) if the processing of the request was successful, the EES shall send an EAS discovery subscription response to the EEC as specified in clause 6.3.2.2.3.1, which includes the subscription identifier and shall include the expiration time, indicating when the subscription will automatically expire.
If the EES is unable to process the request (e.g. was not able to determine the EAS using the input information in the request or using the locally available information), the EES shall reject the request with a with appropriate response code as specified in Table 5.2.6-1 of TS 29.122 [3].
If the expiration time is provided, the EEC shall send an EAS discovery subscription update request prior to the expiration time if the EEC wants to maintain the subscription. If an EAS discovery subscription update request is not received prior to the expiration time, the EES shall treat the EEC as implicitly unsubscribed.
If the failure response is received for the EAS discovery request, the EEC may resend the EAS discovery subscription request, taking into account the received failure cause. If the failure cause indicated "REGISTRATION_REQUIRED" error in the "cause" attribute of the "ProblemDetails" structure, the EEC shall perform an EEC registration as specified in clause 5.2.2.2.2 before resending the EAS discovery request.
5.3.2.4 Eees_EASDiscovery_Notify
5.3.2.4.1 General
This service operation is used by the EES to notify the EEC about the EAS discovery information.
5.3.2.4.2 EES notifying the EAS discovery information to EEC using Eees_EASDiscovery_Notify operation
The EES determines to notify the EEC with the EAS discovery information, when an event occurs at the EES that satisfies trigger conditions for updating EAS discovery information of a subscribed EEC. The EES may obtain the UE’s location as specified in clause 5.3 of 3GPP TS 29.122 [3].
If EAS discovery filters are provided by the EEC, the EES identifies the EAS(s) based on the provided EAS discovery filters and the UE location.
If EAS discovery filters are not provided, the EES identifies the EAS(s), if available, based on the UE-specific service information at the EES and the UE location; and by applying the ECSP policy (e.g. based only on the UE location).
If valid UE location information is not available in local cache, then the EES shall obtain the UE location information by consuming the 3GPP core network capabilities. If obtaining UE location information from the 3GPP core network capabilities fails, then the EES may retry to obtain UE location information. If EES is unable to obtain UE location, then the EES fails to discover the EAS and the notification will not be sent.
If UE location is available and EES determines that the UE location is outside the Geographical or Topological Service Area of an EAS, then the EES shall not include this EAS in the EAS discovery notification.
If the EES identifies the EAS(s) then to notify the EAS discovery information events, the EES shall either send an HTTP POST message using the Notification Destination URI received in the subscription request, as specified in clause 6.3.4.2.
The EEC may cache the EAS information (e.g. EAS endpoint) for subsequent use. If the "lifeTime" attribute is included in the notification, the EEC may cache the EAS information only for the duration specified by the Lifetime IE.
5.3.2.5 Eees_EASDiscovery_UpdateSubscription
5.3.2.5.1 General
This service operation is used by the EEC to update its subscription at the EES for reporting of EAS discovery information.
5.3.2.5.2 EEC updating EAS discovery information subscription at EES using Eees_EASDiscovery_UpdateSubscription operation
To request modification of an existing Individual EAS Discovery Subscription, the EEC shall send an HTTP PATCH request (for partial modification) or PUT request (for fully replacement) message to the EES using the resource URI identifying the concerned "Individual EAS Discovery Subscription" resource as specified in clause 6.3.2.3.3.3 for an HTTP PATCH message and in clause 6.3.2.3.3.1 for an HTTP PUT message.
The PATCH message includes the parameters (EAS discovery filters, EAS dynamic information filters, Service continuity support, or proposed expiry time) that need to be replaced in the existing subscription resource.
The PUT message shall replace all properties of the existing resource with the EAS Discovery subscription information in the request. The values of the easId and ueId provided during the subscription creation shall not be changed.
Upon receiving the HTTP PATCH or PUT message from the EEC, the EES:
a) shall check the update subscription message from the EEC to see if the EEC is authorized to update the requested subscription resource;
b) if the EEC is authorized to update the EAS discovery subscription and if the eecId and the ueId of the request match the eecId and the ueId in the resource, then the EES;
1) shall update the resource identified by Resource URI of the EAS discovery subscription with the updated information received in the HTTP PATCH or PUT request message;
2) on success, shall either return an HTTP "200 OK" response with the payload body of the HTTP PATCH or PUT response containing the representation of the replaced resource or an HTTP "204 No Content" response.
c) if the EAS discovery subscription update operation is unsuccessful, shall return an appropriate error response as specified in Table 5.2.6-1 of 3GPP TS 29.122 [3];
d) may include an expiration time.
If the expiration time is provided, the EEC shall send the EAS discovery subscription update request prior to the expiration time if the EEC wants to maintain the subscription. If the EAS discovery subscription update request is not received prior to the expiration time, the EES shall treat the EEC as implicitly unsubscribed and remove the corresponding EAS discovery subscription resource.
5.3.2.6 Eees_EASDiscovery_Unsubscribe
5.3.2.6.1 General
This service operation is used by the EEC to unsubscribe from EAS discovery notification at the EES.
5.3.2.6.2 EEC unsubscribing to EAS discovery subscription from EES using Eees_EASDiscovery_Unsubscribe operation
To unsubscribe from EAS discovery notification at the EES, the EEC shall send an HTTP DELETE request to the EES using the resource URI identifying the concerned Individual EAS Discovery Subscription resource as specified in clause 6.3.2.3.3.2. Upon receiving the HTTP DELETE request, the EES:
a) shall verify and check if the EEC is authorized to delete the Individual EAS Discovery Subscription resource;
b) if the EEC is authorized to perform the operation, then the EES shall delete the individual EAS Discovery subscription resource identified by the "subscriptionId" provided within the request URI;
c) on success, shall return a "204 No Content" message to the EEC, indicating the successful removal of the subscription resource.
d) if the operation fails, shall return an appropriate HTTP error response as specified in Table 5.2.6-1 of 3GPP TS 29.122 [3].
5.4 Eees_ACREvents Service
5.4.1 Service Description
The Eees_ACREvents API, as defined in 3GPP TS 23.558 [2], allows the EES to notify the EEC of the target information during the ACR procedures or the ACR complete events.
5.4.2 Service Operations
5.4.2.1 Introduction
The service operations defined for Eees_ACREvents API are shown in the table 5.4.2.1-1.
Table 5.4.2.1-1: Operations of the Eees_ACREvents API
|
Service operation name |
Description |
Initiated by |
|
Eees_ACREvents_Subscribe |
This service operation is used by the EEC to subscribe to EES for ACR related events. |
EEC |
|
Eees_ACREvents_Notify |
This service operation is used by the EES to notify the EEC about ACR related events. |
EES |
|
Eees_ACREvents_UpdateSubscription |
This service operation is used by the EEC to update existing subscription for ACR related events. |
EEC |
|
Eees_ACREvents_Unsubscribe |
This service operation is used by the EEC to unsubscribe for the previously subscribed ACR related events. |
EEC |
5.4.2.2 Eees_ACREvents_Subscribe
5.4.2.2.1 General
This service operation is used by the EEC to subscribe to EES, for reporting following ACR information:
– target information, i.e. the details of the selected T-EAS and, if required, the selected T-EES, during the ACR procedures;
– ACR complete events.
5.4.2.2.2 EEC subscribing to ACR information from EES using Eees_ACREvents_Subscribe operation
To subscribe to ACR information reporting at the EES, the EEC shall send an HTTP POST message to the EES on the "ACR events subscriptions" resource. The body of the POST message shall include "ACREventsSubscription" as specified in clause 6.4.5.2.2.
Upon receiving the HTTP POST message from the EEC, the EES shall:
a) process the EEC ACR information subscription request;
b) verify and check if the EEC is authorized to subscribe ACR information about the requested EAS(s); and
c) if the EEC is authorized to subscribe for the ACR information notification, then the EES;
1) shall create a new resource with the Individual ACR events subscription resource as specified in clause 6.4.2.3;
2) if a list of identifier of ACs is provided by the EEC, the EES shall use it during ACR information notification as specified in clause 5.4.2.3; and
3) shall send an ACR information subscription response to the EEC. The URI of the created resource (including the subscription identifier) shall be returned in the "Location" HTTP header. The response may include the expiration time, indicating when the subscription will automatically expire.
If the expiration time is provided, then to maintain the subscription information, the EEC shall send an ACR information subscription update request (as described in clause 5.3.2.4) prior to the expiration time. If the ACR information subscription update request is not sent prior to the expiration time, the EES shall treat the EEC as implicitly unsubscribed and remove the corresponding Individual ACR information subscription resource.
5.4.2.3 Eees_ACREvents_Notify
5.4.2.3.1 General
This service operation is used by the EES to notify the EEC about the ACR information notification.
5.4.2.3.2 EES notifying the ACR information to EEC using Eees_ACREvents_Notify operation
The EES determines to notify the EEC with the ACR information on following events:
– For EEC executed ACR via S-EES scenario, when S-EAS sends the ACR Complete message to the S-EES to confirm that the ACR has completed;
– For S-EAS decided ACR scenario, when T-EAS selection information received from the S-EAS or when S-EAS informs the S-EES of the complete of ACT;
– For S-EES executed ACR scenario, when S-EES determines T-EES and T-EAS via the Discover T-EAS procedure or when S-EAS informs the S-EES of the complete of ACT; and
– For EEC executed ACR via T-EES scenario, when T-EAS sends the ACR Complete message to the T-EES to confirm that the ACR has completed.
To notify the ACR information events, the EES shall:
a) identify ACs that satisfies trigger conditions for providing ACR information notification if a list of identifier of ACs was provided by the EEC when subscribing to ACR information; and
b) send an HTTP POST message using the Notification Destination URI received in the subscription request, as specified in clause 6.4.4. The EES shall include "eecCtxtReloc" attribute containing the registration ID and registration expiration time as specified in clause 6.4.5.2.3.
Upon receiving the HTTP POST message, the EEC shall process the ACR information Notification.
5.4.2.4 Eees_ACREvents_UpdateSubscription
5.4.2.4.1 General
This service operation is used by the EEC to update its subscription at EES, for reporting of ACR information notification.
5.4.2.4.3 EEC updating ACR information subscription at EES using Eees_ACREvents_UpdateSubscription operation
To update ACR information subscription at the EES, the EEC shall send an HTTP PATCH message (for partial modification) or HTTP PUT message (for fully replacement) to the EES on resource URI identifying the Individual ACR events subscription resource representation, as specified in clause 6.4.2.3.3.3 for an HTTP PATCH message and in clause 6.4.2.3.3.1 for an HTTP PUT message.
The PATCH message includes the parameters (EASID, Event ID, Notification Destination and proposed expiry time) that need to be replaced in the existing subscription resource.
The PUT message shall replace all properties of the existing resource with the ACR information in the request. The values of the eecId and ueId provided during the subscription creation shall not be changed.
Upon receiving the HTTP PATCH or PUT message from the EEC, the EES:
a) shall check the update subscription message from the EEC to see if the EEC is authorized to modify the requested subscription resource;
b) if the EEC is authorized to update the ACR information subscription and the eecId of the requesting EEC and the eecId in the resource match, then the EES;
1) shall update the resource identified by Resource URI of the ACR information subscription with the updated information received in the HTTP PATCH or PUT request message;
3) shall return the ACR information subscription response. The EES may send "200 OK" response code which includes the subscription identifier and the expiration time, indicating when the subscription will automatically expire. Otherwise, the EES sends "204 No Content" response code.
If the expiration time is provided, the EEC shall send an ACR information subscription update request prior to the expiration time if the EEC wants to maintain the subscription. If the ACR information subscription update request is not received prior to the expiration time, the EES shall treat the EEC as implicitly unsubscribed and remove the corresponding ACR information subscription resource.
5.4.2.5 Eees_ACREvents_Unsubscribe
5.4.2.5.1 General
This service operation is used by the EEC to remove its subscription from the EES for reporting of ACR information.
5.4.2.5.2 EEC unsubscribing to service provisioning subscription from EES using Eees_ACREvents_Unsubscribe operation
To unsubscribe ACR information subscription from the EES, the EEC shall send an HTTP DELETE message to the EES, on the resource URI identifying the Individual ACR events subscription resource representation as specified in clause 6.4.2.3.3.2. Upon receiving the HTTP DELETE request, the EES:
a) shall verify and check if the EEC is authorized to unsubscribe the Individual ACR events subscription resource;
b) if the EEC is authorized to delete the Individual ACR events subscription resource, then the EES shall unsubscribe the EEC for the ACR information subscription identified by the subscriptionId;
c) shall return the "204 Not Content" message to the EEC, indicating the successful removal of the subscription information.
5.5 Eees_AppContextRelocation Service
5.5.1 Service Description
The Eees_AppContextRelocation API, as defined in 3GPP TS 23.558 [2], allows an EEC to request to launch Application Context Relocation towards a given EES via the Eees interface.
5.5.2 Service Operations
5.5.2.1 Introduction
The service operation defined for Eees_AppContextRelocation API is shown in the table 5.5.2.1-1.
Table 5.5.2.1-1: Operations of the Eees_AppContextRelocation API
|
Service operation name |
Description |
Initiated by |
|
Eees_AppContextRelocation_Determine |
This service operation enables to request ACR determination. |
EEC |
|
Eees_AppContextRelocation_Initiate |
This service operation enables to request ACR initiation. |
EEC |
5.5.2.2 Eees_AppContextRelocation_Determine
5.5.2.2.1 General
This service operation is used by an EEC to request ACR determination to the EES.
The following procedures are supported by the "Eees_AppContextRelocation_Determine" service operation:
– ACR Determination.
5.5.2.2.2 ACR Determination
In order to request ACR determination, the EEC shall send an HTTP POST request to the EES, with the request URI set to "{apiRoot}/eees-appctxtreloc/<apiVersion>/determine" and the request body including the ACRDetermReq data structure that shall contain the necessary information to enable the EES to carry out ACR determination as described in clause 6.5.5.2.2.
Upon receiving the HTTP POST message from the EEC, the EES shall:
a) process the ACR determination request;
b) verify if the EEC is authorized to request ACR determination at the EES;
c) if the EEC is authorized to request ACR determination with the EES, then:
1) the S-EES determines the T-EES via the Discover T-EAS procedure and may notify the EEC with target information and/or ACR result notification;
Upon success, the EES responds with an HTTP "204 No Content" status code.
On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body.
5.5.2.3 Eees_AppContextRelocation_Initiate
5.5.2.3.1 General
This service operation is used by an EEC to request ACR initiation to the EES.
The following procedures are supported by the "Eees_AppContextRelocation_Initiate" service operation:
– ACR Initiation.
5.5.2.3.2 ACR Initiation
In order to request ACR initiation, the EEC shall send an HTTP POST request to the EES, with the request URI set to "{apiRoot}/eees-appctxtreloc/<apiVersion>/initiate" and the request body including the ACRInitReq data structure that shall contain the necessary information to enable the EES to carry out ACR initiation as described in clause 6.5.5.2.3.
Upon receiving the HTTP POST message from the EEC, the EES shall:
a) process the ACR initiation request information;
b) verify if the EEC is authorized to request ACR initiation at the EES and;
c) if the EEC is authorized to request ACR initiation with the EES, then;
1) if T-EAS routing information (i.e. N6 routing information) as specified in table 6.5.5.2.3-1 is included in HTTP POST message:
i) the EES may apply AF traffic influence with the N6 routing information in the 3GPP Core Network as specified in clause 4.4.7 of 3GPP TS 29.522 [8];
2) if EAS notification indication as specified in table 6.5.5.2.3-1 is included in the HTTP POST message, the EES shall notify the EAS to start the ACR towards the T-EAS;
3) if EEC context relocation details as specified in table 6.5.5.2.3-1 is included in HTTP POST message, then
i) if the T-EES is different than the current EES, then the EES shall initiate EEC Context Push towards the T-EES as specified in clause 5.11 of 3GPP TS 29.558 [4]; or
ii) if the EEC context ID and the S-EES Endpoint are included, then EES shall initiate EEC Context Pull (using EEC Context ID) towards the S-EES as specified in clause 5.10 of 3GPP TS 29.558 [4];
iii) if Previous T-EAS Endpoint is included in HTTP POST message, then:
A) if the previous EAS notification indication is included in the HTTP POST message, the EES shall notify the cancellation of the ACR to the EAS;
4) the EES shall return the response message.
Upon success, the EES responds with an HTTP "204 No Content" status code.
On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body.