8.7 Eees_EECContextRelocation API
29.5583GPPApplication Programming Interface (API) specificationEnabling Edge ApplicationsRelease 18Stage 3TS
8.7.1 API URI
The Eees_EECContextRelocation service shall use the Eees_EECContextRelocation API.
The request URIs used in HTTP requests shall have the Resource URI structure as defined in clause 7.5 with the following clarifications:
– The <apiName> shall be "eees-eeccontextreloc".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 8.7.2.
8.7.2 Resources
8.7.2.1 Overview
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 8.7.2.1-1 depicts the resource URIs structure for the Eees_EECContextRelocation API.
Figure 8.7.2.1-1: Resource URI structure of the Eees_EECContextRelocation API
Table 8.7.2.1-1 provides an overview of the resources and applicable HTTP methods.
Table 8.7.2.1-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
|
Collection of EEC contexts |
/eec-contexts |
GET |
Retrieve the EEC Context information from S-EES. |
|
POST |
Push the EEC Context information to the T-EES. |
8.7.2.2 Resource: Collection of EEC Contexts
8.7.2.2.1 Description
This resource allows to transfer the EEC Context from an S-EES to the T-EES, for EEC context relocation.
8.7.2.2.2 Resource Definition
Resource URI: {apiRoot}/eees-eeccontextreloc/<apiVersion>/eec-contexts
This resource shall support the resource URI variables defined in the table 8.7.2.2.2-1.
Table 8.7.2.2.2-1: Resource URI variables for this resource
|
Name |
Data Type |
Definition |
|
apiRoot |
string |
See clause 7.5 |
8.7.2.2.3 Resource Standard Methods
8.7.2.2.3.1 GET
This method allows a T-EES to pull the EEC Context from the S-EES as specified in 3GPP TS 23.558 [2], based on the information in the discovery filters. This method shall support the URI query parameters specified in table 8.7.2.2.3.1-1.
Table 8.7.2.2.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
ees-id |
string |
M |
1 |
The identifier of the requesting EES (T-EES). |
|
eec-cntx-id |
string |
M |
1 |
Unique identifier of the EEC Context to authorize the transfer. |
|
sess-cntxs |
SessionContexts |
O |
0..1 |
List of service session context information being requested. |
This method shall support the request data structures specified in table 8.7.2.2.3.1-2 and the response data structures and response codes specified in table 8.7.2.2.3.1-3.
Table 8.7.2.2.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 8.7.2.2.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
EECContext |
M |
1 |
200 OK |
The EEC context information matching the input parameters in the request is returned by the S-EES. |
|
NOTE: The manadatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
||||
8.7.2.2.3.2 POST
This method allows the S-EES to transfer the EEC Context to T-EES to relocate the EEC Context, as specified in 3GPP TS 23.558 [2]. This method shall support the URI query parameters specified in table 8.7.2.2.3.2-1.
Table 8.7.2.2.3.2-1: URI query parameters supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 8.7.2.2.3.2-2 and the response data structures and response codes specified in table 8.7.2.2.3.2-3.
Table 8.7.2.2.3.2-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
EECContextPush |
M |
1 |
EEC Context information of an EEC available at the S-EES. |
Table 8.7.2.2.3.2-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
The EEC context has been successfully transferred to the T-EES. |
||
|
EECContextPushRes |
M |
1 |
200 OK |
The EEC context has been successfully transferred to the T-EES and the EEC is implicitly registered. |
|
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. |
||||
8.7.2.2.4 Resource Custom Operations
None.
8.7.3 Custom Operations without associated resources
None.
8.7.4 Notifications
None.
8.7.5 Data Model
8.7.5.1 General
This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API
Table 8.7.5.1-1 specifies the data types defined specifically for the Eees_EECContextRelocation API service.
Table 8.7.5.1-1: Eees_EECContextRelocation API specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
|
EECContext |
8.7.5.2.5 |
To represent the EEC context information to be relocated. |
|
|
EECContextPush |
8.7.5.2.4 |
To represent the EEC context information to be pushed to the T-EES. |
|
|
EECContextPushRes |
8.7.5.2.6 |
Represents the EEC context push relocation response. |
|
|
ImplicitRegDetails |
8.7.5.2.7 |
Represents the EEC implicit registration information. |
|
|
IndividualSessionContext |
8.7.5.2.3 |
To represent single Service session context information. |
|
|
SessionContexts |
8.7.5.2.2 |
To represent the Service session contexts information in EEC context pull request. |
Table 8.7.5.1-2 specifies data types re-used by the Eees_EECContextRelocation API service.
Table 8.7.5.1-2: Re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
EndPoint |
8.1.5.2.5 |
To represent the end point information of the EAS in service session context information. |
|
|
ACProfile |
3GPP TS 24.558 [14] |
Used to represent the application clients profiles in EEC context. |
|
|
Gpsi |
3GPP TS 29.571 [8] |
Used to indicate the identifier of the UE. |
|
|
LocationArea5G |
3GPP TS 29.122 [6] |
Used to indicate the location information of the UE in the EEC context. |
|
|
DateTime |
3GPP TS 29.122 [6] |
To indicate the expiry time of the implicit registration. |
8.7.5.2 Structured data types
8.7.5.2.1 Introduction
The data type for the Eees_EECContextRelocation API are defined in the clauses below.
8.7.5.2.2 Type: SessionContexts
Table 8.7.5.2.2-1: Definition of type SessionContexts
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
sessCntxs |
array(IndividualSessionContext) |
M |
1..N |
List of service session context information. |
8.7.5.2.3 Type: IndividualSessionContext
Table 8.7.5.2.3-1: Definition of type IndividualSessionContext
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
easId |
string |
M |
1 |
The application identifier of the EAS, e.g. URI, FQDN, providing the application services. |
|
|
endPt |
EndPoint |
M |
1 |
End point information of the EAS in easId attribute. |
|
|
acId |
string |
O |
0..1 |
Identifier of the AC for which the service session information is provided. |
8.7.5.2.4 Type: EECContextPush
Table 8.7.5.2.4-1: Definition of type EECContextPush
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
eesId |
string |
M |
1 |
Identifier of the S-EES pushing the EEC context. |
|
|
eecCntx |
EECContext |
M |
1 |
EEC Context to be relocated to T-EES. |
8.7.5.2.5 Type: EECContext
Table 8.7.5.2.5-1: Definition of type EECContext
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
eecId |
string |
M |
1 |
Unique identifier of the EEC |
|
|
cntxId |
string |
M |
1 |
Unique identifier assigned to the EEC Context |
|
|
ueId |
Gpsi |
O |
0..1 |
The identifier of the UE hosting the EEC. |
|
|
e1Subs |
array(string) |
O |
1..N |
List of subscription IDs for the capability exposure for the EEC ID. |
|
|
ueLoc |
LocationArea5G |
O |
0..1 |
Latest location information of the UE hosting the EEC, that is available at the EES. |
|
|
acProfs |
array(ACProfile) |
O |
1..N |
List of ACs profiles |
|
|
sessCntxs |
SessionContexts |
O |
0..1 |
List of associated Service Session Contexts. Each Service Session Context includes information maintained by the EES for the services (involving UE related resources) received from an EAS registered to the EES. |
8.7.5.2.6 Type: EECContextPushRes
Table 8.7.5.2.6-1: Definition of type EECContextPushRes
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
implReg |
ImplicitRegDetails |
C |
0..1 |
Provides implicit registration details. (NOTE) |
|
|
NOTE: This attribute shall be included if the T-EES has performed implicit registration of the EEC. |
|||||
8.7.5.2.7 Type: ImplicitRegDetails
Table 8.7.5.2.7-1: Definition of type ImplicitRegDetails
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
regId |
string |
M |
1 |
Represents registration ID of the EEC whose EEC context is pushed |
|
|
expTime |
DateTime |
O |
0..1 |
Represents the expiration time of the registration. If absent, then it indicates that the registration of the EEC never expires. |
8.7.5.3 Simple data types and enumerations
None.
8.7.6 Error Handling
General error responses are defined in clause 7.7.
8.7.7 Feature negotiation
General feature negotiation procedures are defined in clause 7.8. Table 8.7.7-1 lists the supported features for Eees_EECContextRelocation API.
Table 8.7.7-1: Supported Features
|
Feature number |
Feature Name |
Description |