Content for TS 23.558 Word version: 18.1.0
8.14 EDGE-5 APIs
8.14.1 General
8.14.2 Procedures
8.14.2.1 General
8.14.2.2 Registration
8.14.2.3 EAS discovery
8.14.2.4 ACR request
8.14.2.5 EEC services subscription
8.14.3 Information flows
8.14.3.1 General
8.14.3.2 AC registration request
8.14.3.3 AC registration response
8.14.3.4 AC registration update request
8.14.3.5 AC registration update response
8.14.3.6 AC deregistration request
8.14.3.7 AC deregistration response
8.14.3.8 EAS discovery request
8.14.3.9 EAS discovery response
8.14.3.10 EEC services subscription request
8.14.3.11 EEC services subscription response
8.14.3.12 EEC services notification
8.14.3.13 EEC services subscription update request
8.14.3.14 EEC services subscription update response
8.14.3.15 EEC services unsubscribe request
8.14.3.16 EEC services unsubscribe response
8.14.4 APIs
...
...
8.14 EDGE-5 APIs |R18| p. 165
8.14.1 General p. 165
EEC exposes EDGE-5 APIs corresponding to EEC's capabilities, for the AC to request EEC's services for edge enablement. Using these APIs, ACs request the EEC for EEL services. EDGE-5 APIs include one-time request/response operations for EAS discovery and ACR operations. Additionally, the AC can request for an AC subscription. The EEC creates the subscription and when required, performs necessary operations such as EAS discovery, ACR etc., delivering notifications to the AC as required.
8.14.2 Procedures p. 165
8.14.2.1 General p. 155
Following procedures are specified for EDGE-5:
- Registration;
- EAS discovery;
- ACR request; and
- EEC services subscription.
8.14.2.2 Registration p. 165
8.14.2.2.1 General p. 165
Following are supported for AC registration:
- AC registration procedure;
- AC registration update procedure; and
- AC de-registration procedure.
8.14.2.2.2 AC registration p. 165
Figure 8.14.2.2.2-1 illustrates AC registration procedure.
Pre-conditions:
- AC can communicate with the EEC.
Step 1.
The AC sends an AC registration request to the EEC. The request includes the AC profile, AC's security credentials and optionally the EAS characteristics. The request may also include a list of EEC's services that AC requires the EEC to handle. The request additionally includes ECS configuration information if the AC is edge-aware and configured with the ECS configuration information.
Step 2.
The EEC checks AC's security credentials and validates the request.
Step 3.
If the request is successfully validated, the EEC registers the information provided in the request and responds back to the AC with AC registration response. The AC registration response includes the list of EEC's services that AC is authorized for.
8.14.2.2.3 AC registration update p. 166
Figure 8.14.2.2.3-1 illustrates AC registration update procedure.
Pre-conditions:
- AC is registered with the EEC.
Step 1.
The AC sends an AC registration update request to the EEC. The request includes the registration ID, AC's security credentials, and may include the updated AC profile, EAS discovery filters, list of requested EEC services and list of ECS information.
Step 2.
The EEC checks AC's security credentials and validates the request.
Step 3.
If the request is successfully validated, the EEC sends a successful registration update response, which includes an updated list of EEC services that AC is authorized for.
8.14.2.2.4 AC deregistration p. 167
Figure 8.14.2.2.4-1 illustrates AC deregistration procedure.
Pre-conditions:
- AC is registered with the EEC.
Step 1.
The AC sends an AC deregistration request to the EEC. The request includes the registration ID and AC's security credentials.
Step 2.
The EEC checks AC's security credentials and validates the request.
Step 3.
Upon successful authorization, the EEC deregisters the AC and sends a successful de-registration response.
8.14.2.3 EAS discovery p. 168
Pre-conditions:
- The AC can communicate with the EEC.
Step 1.
The AC sends an EAS discovery request to the EEC. The request includes AC profile and AC's security credentials and may include EAS discovery filters.
Step 2.
The EEC checks AC's security credentials and validates the request.
Step 3.
If the request is successfully validated, the EEC determines if the required EAS is available or not. The EEC may use information cached or preconfigured at the EEC or may use the EAS discovery procedures to query the EES. If step 1 includes the AC profile or EAS discovery filters, then the EEC may utilize the provided AC profile and filters, to form the EAS discovery request towards EES. If step 1 does not include any of the optional IEs of the AC profile and EAS discovery filters, and AC registration was performed, the EEC may utilize the AC profile provided by the AC during AC registration. The EEC also needs to take user privacy requirements, e.g., regarding the disclosure of location information towards the network into account. If required, e.g., when EAS discovery procedures returns a list of EASs, the EEC performs EAS selection based on the information received in step 1 and the AC profile. The EEC can perform EAS discovery with different EESs before selecting an EAS.
Step 4.
The EEC responds back to the AC with the EAS discovery response. The response includes the EAS profile(s) of the available EAS(s).
8.14.2.4 ACR request p. 168
Pre-conditions:
- The AC can communicate with the EEC.
Step 1.
The AC sends an ACR request to the EEC. The request includes AC's security credentials, type of requested operation (i.e., ACR detection, ACR initiation) and AC profile. If the request is to initiate the ACR, the request may also include the target EAS information.
Step 2.
The EEC checks AC's security credentials and validates the request.
Step 3.
If the request is successfully validated, the EEC process the request from the AC. If the type of requested operation in the request received in step 1 is:
- ACR detection, then the EEC determines if ACR is required or not. If it is required, the EEC uses one of the EEC initiated ACR scenarios or launches ACR with action "determination", leading to S-EES executed ACR;
- ACR initiation, then the EEC uses one of the EEC initiated ACR scenarios and initiate ACR. If the request in step 1 also includes target information, the EEC uses it to select the ACR targets;
8.14.2.5 EEC services subscription p. 169
8.14.2.5.1 General p. 169
Following are supported for EEC services subscription:
- Subscribe;
- Notify;
- Subscription update; and
- Unsubscribe.
8.14.2.5.2 Subscribe p. 169
Pre-conditions:
- The AC can communicate with the EEC.
Step 1.
The AC sends an EEC services subscription request to the EEC. The request includes AC profile, AC's security credentials, a list of EEC's services that AC requires the EEC to handle, and related parameters as described in 8.14.3.10. If the subscription request includes:
Step 2.
- EAS discovery or EAS dynamic information subscription, then the request may include a list of EAS characteristics and a list of EAS dynamic information filters respectively;
- ACR, then the request includes a list of S-EAS information and corrosponding type of ACR operations:
- ACR monitoring, where the EEC monitors the need for ACR and notifies the AC as and when required e.g., on receiving ACR related notifications on EDGE-1 interface.
- EEC managed ACR, where the EEC monitors the need for ACR. If need for ACR is detected, then the EEC decides and initiates ACR using one of the EEC initiated ACR scenarios. The EEC notifies the AC about the imminent ACR and may include the target information.
The EEC checks AC's security credentials and validates the request.
Step 3.
If the request is successfully validated, the EEC creates the subscription and sends an EEC services subscription response message to the AC. The response includes the list of services that the EEC will handle and related details.
Step 4.
The EEC executes the services e.g., EAS discovery, ACR, and notifies the AC with information as necessary. The EEC may use locally cached information or configurations while providing services to the AC.
8.14.2.5.3 EEC services notification p. 170
Pre-conditions:
- The AC has subscribed to the EEC.
8.14.2.5.4 EEC services subscription update p. 171
Figure 8.14.2.5.4-1 illustrates EEC services subscription update procedure.
Pre-conditions:
- The AC has subscribed to the EEC.
Step 1.
The AC sends an EEC services subscription update request to the EEC. The request includes the subscription ID, AC's security credentials, and may include updated notification related details or updated list of required EEC services.
Step 2.
The EEC checks AC's security credentials and validates the request.
Step 3.
If the request is successfully validated, the EEC updates the subscription and sends a successful subscription update response.
Step 4.
The EEC executes the services e.g., EAS discovery, ACR, and notifies the AC with information as necessary. The EEC may use locally cached information or configurations while providing services to the AC.
8.14.2.5.5 Unsubscribe p. 172
Figure 8.14.2.5.5-1 illustrates the unsubscribe procedure.
Pre-conditions:
- The AC has subscribed to the EEC.
Step 1.
The AC sends EEC services unsubscribe request to the EEC. The request includes the subscription ID and AC's security credentials.
Step 2.
The EEC checks AC's security credentials and validates the request.
Step 3.
Upon successful authorization, the EEC sends a successful de-registration response.
8.14.3 Information flows p. 172
8.14.3.1 General p. 172
8.14.3.2 AC registration request p. 172
Table 8.14.3.2-1 describes information elements of the AC registration request sent by the AC to the EEC .
| Information element | Status | Description |
|---|---|---|
| AC profile | M | AC profile of the AC sending the registration request. |
| Security credentials | M | Security credentials of the AC sending the registration request. |
| List of EAS characteristics | O | List of EAS characteristics as described in EAS discovery filters (see Table 8.5.3.2-2). |
| List of requested EEC services | O | One or more EEC services requested by the AC e.g., EAS discovery, ACR. |
| List of ECS information | O | One or more ECS configuration information. |
8.14.3.3 AC registration response p. 173
Table 8.14.3.3-1 describes information elements of the AC registration response sent by the EEC to the AC.
| Information element | Status | Description |
|---|---|---|
| Successful response | O | Indicates that the registration request was successful. |
| > Registration ID | M | Identifier of the AC registration. |
| > List of allowed EEC services | M | List of all the EEC services AC is authorized to use. |
| > Expiration time | O | Indicates the expiration time of the registration. To maintain an active registration status, a registration update is required before the expiration time. |
| Failure response | O | Indicates that the registration request failed. |
| > Cause | M | Provides the cause for registration request failure. |
8.14.3.4 AC registration update request p. 173
Table 8.14.3.4-1 describes information elements in the AC registration update request sent by the AC to the EEC.
| Information element | Status | Description |
|---|---|---|
| Registration ID | M | AC registration identifier provided by the EEC during AC registration. |
| Security credentials | M | Security credentials of the AC sending the registration update request. |
| AC profile | O | AC profile of the AC sending the registration update request. |
| List of EAS characteristics | O | List of EAS characteristics as described in EAS discovery filters (see Table 8.5.3.2-2). |
| List of requested EEC services | O | One or more EEC services requested by the AC e.g., EAS discovery, ACR. |
| List of ECS information | O | One or more ECS configuration information. |
8.14.3.5 AC registration update response p. 173
Table 8.14.3.5-1 describes information elements in the AC registration update response sent by the EEC to the AC.
| Information element | Status | Description |
|---|---|---|
| Successful response | O | Indicates that the registration request was successful. |
| > List of allowed EEC services | M | List of all the EEC services AC is authorized to use. |
| > Expiration time | O | Indicates the expiration time of the registration. To maintain an active registration status, a registration update is required before the expiration time. |
| Failure response | O | Indicates that the registration request failed. |
| > Cause | M | Provides the cause for registration request failure. |
8.14.3.6 AC deregistration request p. 173
Table 8.14.3.6-1 describes information elements in the AC deregistration request sent by the AC to the EEC.
| Information element | Status | Description |
|---|---|---|
| Registration ID | M | AC registration identifier provided by the EEC during AC registration. |
| Security credentials | M | Security credentials of the AC sending the deregistration request. |
8.14.3.7 AC deregistration response p. 174
Table 8.14.3.7-1 describes information elements in the AC deregistration response sent by the EEC to the AC.
| Information element | Status | Description |
|---|---|---|
| Successful response | O | Indicates that the deregistration request was successful. |
| Failure response | O | Indicates that the deregistration request failed. |
| > Cause | M | Provides the cause for deregistration request failure. |
8.14.3.8 EAS discovery request p. 174
Table 8.14.3.8-1 describes information elements for the EAS discovery request sent by the AC to the EEC.
| Information element | Status | Description |
|---|---|---|
| AC profile | M | AC profile of the AC sending the registration request. |
| Security credentials | M | Security credentials of the AC. |
| List of EAS characteristics | O | List of EAS characteristics as described in EAS discovery filters (see Table 8.5.3.2-2). |
8.14.3.9 EAS discovery response p. 174
Table 8.14.3.9-1 describes information elements for the EAS discovery response sent by the EEC to the AC.
| Information element | Status | Description |
|---|---|---|
| Successful response | O | Indicates that the EAS discovery request was successful. |
| > Discovered EAS list | O | List of discovered EAS(s). Each element includes the information described below. |
| >> EAS profile | M | Profile of the EAS. Each element is described in clause 8.2.4. |
| >> Lifetime | O | Time interval or duration during which the information elements in the EAS profile is valid and supposed to be cached in the AC (e.g. time-to-live value for an EAS Endpoint). |
| Failure response | O | Indicates that the EAS discovery request failed. |
| > Cause | O | Indicates the cause of EAS discovery request failure. |
8.14.3.10 EEC services subscription request p. 174
Table 8.14.3.10-1 describes information elements for the EEC services subscription request sent by the AC to the EEC.
| Information element | Status | Description |
|---|---|---|
| AC profile | M | AC profile of the AC requesting subscription |
| Security credentials | M | Security credentials of the AC. |
| Notification details | M | Details on how the EEC can notify the AC. |
| Required EEC services | M | EEC handled services required by the AC. |
| > EAS discovery | O | Indicates that AC requires EEC to handle EAS discovery. |
| >> List of EAS characteristics | O | List of EAS characteristics as described in EAS discovery filters (see Table 8.5.3.2-2). |
| > EAS dynamic information | O | Indicates that the AC requires EAS dynamic information subscription. |
| >> List of EAS dynamic information filters | M | List of EAS dynamic information filters as described in Table 8.5.3.4-2. |
| > ACR | O | Indicates that the AC requires ACR related services for the following EASs. |
| >> List of S-EAS information | M | S-EAS information corresponding to the ACR operation. |
| >>> ACR operation | O | Indicates if AC requires ACR monitoring or EEC managed ACR corresponding to each S-EAS. |
8.14.3.11 EEC services subscription response p. 175
Table 8.14.3.11-1 describes information elements for the EEC services subscription response sent by the EEC to the AC.
| Information element | Status | Description |
|---|---|---|
| Successful response | O | Indicates that the EEC services subscription request was successful. |
| > Subscription ID | M | Subscription identifier corresponding to the subscription. |
| > Expiration time | O | Indicates the expiration time of the subscription. To maintain an active subscription, a subscription update is required before the expiration time. |
| > Confirmed EEC services | M | List of services EEC confirms to handle. |
| >> EAS discovery | O | Indicates that the EEC will handle EAS discovery. |
| >> EAS dynamic information | O | Indicates that the EEC will handle EAS dynamic information subscription. |
| >> ACR | O | Indicates that the EEC will handle ACR. |
| >>> List of S-EAS information | M | Information of the S-EASs EEC will handle. |
| Failure response | O | Indicates that the subscription request failed. |
| > Cause | O | Indicates the cause of subscription request failure. |
8.14.3.12 EEC services notification p. 175
Table 8.14.3.12-1 describes information elements for the EEC services notification sent by the EEC to the AC.
| Information element | Status | Description |
|---|---|---|
| Subscription ID | M | Subscription identifier corresponding to the notification. |
| Notification details | M | Information related to the notification. |
| > EAS discovery | O | Indicates that the notification relates to EAS discovery. |
| >> List of EAS profiles | M | EAS profiles associated with the notification. Each element is described in clause 8.2.4. |
| >>> Lifetime | O | Time interval or duration during which the information in the EAS profile is valid and supposed to be cached in the AC (e.g. time-to-live value for an EAS Endpoint). |
| > EAS dynamic information | O | Indicates that the notification relates to EAS dynamic information subscription. |
| >> List of EAS profile | M | EAS profiles associated with the notification. Each element is described in clause 8.2.4. |
| >>> Lifetime | O | Time interval or duration during which the information in the EAS profile is valid and supposed to be cached in the AC (e.g. time-to-live value for an EAS Endpoint). |
| > ACR | O | Indicates that the notification relates to ACR. |
8.14.3.13 EEC services subscription update request p. 176
Table 8.14.3.13-1 describes information elements for the EEC services subscription update request sent by the AC to the EEC.
| Information element | Status | Description |
|---|---|---|
| Subscription ID | M | Subscription identifier corresponding to the update request. |
| Security credentials | M | Security credentials of the AC. |
| Notification details | O | Details on how the EEC can notify the AC. |
| Required EEC services | O | EEC handled services required by the AC. |
| > EAS discovery | O | Indicates that AC requires EEC to handle EAS discovery. |
| >> List of EAS discovery filters | M | List of EAS discovery filters as described in Table 8.5.3.2-2. |
| >>> Preferred ECSP list | O | Preferred ECSP list corresponding to each set of EAS discovery filters. |
| > EAS dynamic information | O | Indicates that the AC requires EAS dynamic information subscription. |
| >> List of EAS dynamic information filters | M | List of EAS dynamic information filters as described in Table 8.5.3.4-2. |
| > ACR | O | Indicates that the AC requires ACR related services for the following EASs. |
| >> List of S-EAS information | M | S-EAS information corresponding to the ACR operation. |
| >>> ACR operation | O | Indicates if AC requires ACR monitoring or EEC managed ACR corresponding to each S-EAS. |
8.14.3.14 EEC services subscription update response p. 176
Table 8.14.3.14-1 describes information elements for the EEC services subscription update response sent by the EEC to the AC.
| Information element | Status | Description |
|---|---|---|
| Successful response | O | Indicates that the EEC services subscription update request was successful. |
| > Expiration time | O | Indicates the expiration time of the subscription. To maintain an active subscription, a subscription update is required before the expiration time. |
| > Confirmed EEC services | M | List of services EEC confirms to handle. |
| >> EAS discovery | O | Indicates that the EEC will handle EAS discovery. |
| >> EAS dynamic information | O | Indicates that the EEC will handle EAS dynamic information subscription. |
| >> ACR | O | Indicates that the EEC will handle ACR. |
| >>> List of S-EAS information | M | Information of the S-EASs EEC will handle. |
| Failure response | O | Indicates that the subscription update request failed. |
| > Cause | O | Indicates the cause of subscription update request failure. |
8.14.3.15 EEC services unsubscribe request p. 177
Table 8.14.3.15-1 describes information elements for the EEC services unsubscribe request sent by the AC to the EEC.
| Information element | Status | Description |
|---|---|---|
| Subscription ID | M | EEC services subscription identifier provided by the EEC during subscription. |
| Security credentials | M | Security credentials of the AC sending the EEC services unsubscribe request. |
8.14.3.16 EEC services unsubscribe response p. 177
Table 8.14.3.16-1 describes information elements for the EEC services unsubscribe response sent by the EEC to the AC.
| Information element | Status | Description |
|---|---|---|
| Successful response | O | Indicates that the EEC services unsubscribe request was successful. |
| Failure response | O | Indicates that the EEC services unsubscribe request failed. |
| > Cause | M | Provides the cause for EEC services unsubscribe request failure. |
8.14.4 APIs p. 177
