Content for TS 24.558 Word version: 18.5.1
5 Services offered by Edge Enabler Server
5.1 Introduction
5.2 Eees_EECRegistration Service
5.3 Eees_EASDiscovery service
5.4 Eees_ACREvents Service
5.5 Eees_AppContextRelocation Service
5.6 Eees_UEIdentifier Service
5.7 Eees_EASInformationProvisioning Service
6 Edge Enabler Server API Definitions
6.2 Eees_EECRegistration API
6.3 Eees_EASDiscovery API
6.4 Eees_ACREvents API
6.5 Eees_AppContextRelocation API
6.6 Eees_EASInformationProvisioning API
7 Services offered by Edge Configuration Server
7.1 Introduction
7.2 Eecs_ServiceProvisioning Service
8 Edge Configuration Server API Definitions
8.1 Eecs_ServiceProvisioning API
9 Security
10 SEAL services
A Edge Enabler Server OpenAPI specification
B Edge Configuration Server OpenAPI specification
B.1 Eecs_ServiceProvisioning
C Protocol options considered for EDGE-4 reference point
$ Change history
5 Services offered by Edge Enabler Server p. 13
5.1 Introduction p. 13
5.2 Eees_EECRegistration Service p. 14
5.2.1 Service Description p. 14
5.2.2 Service Operations p. 14
5.2.2.1 Introduction p. 14
5.2.2.2 Eees_EECRegistration_Request p. 14
5.2.2.2.1 General p. 14
5.2.2.2.2 EEC registering to EES using Eees_EECRegistration_Request operation p. 14
5.2.2.3 Eees_EECRegistration_Update p. 16
5.2.2.3.1 General p. 16
5.2.2.3.2 EEC updating registration information using Eees_EECRegistration_Update operation p. 16
5.2.2.4 Eees_EECRegistration_Deregister p. 17
5.3 Eees_EASDiscovery service p. 17
5.3.1 Service Description p. 17
5.3.2 Service Operations p. 18
5.3.2.1 Introduction p. 18
5.3.2.2 Eees_EASDiscovery_EasDiscRequest p. 18
5.3.2.2.1 General p. 18
5.3.2.2.2 EEC requesting EAS discovery information using Eees_EASDiscovery_EasDiscRequest operation p. 18
5.3.2.3 Eees_EASDiscovery_Subscribe p. 20
5.3.2.3.1 General p. 20
5.3.2.3.2 EEC subscribing to EAS discovery information from EES using Eees_EASDiscovery_Subscribe operation p. 20
5.3.2.4 Eees_EASDiscovery_Notify p. 21
5.3.2.4.1 General p. 21
5.3.2.4.2 EES notifying the EAS discovery information to EEC using Eees_EASDiscovery_Notify operation p. 21
5.3.2.5 Eees_EASDiscovery_UpdateSubscription p. 22
5.3.2.5.1 General p. 22
5.3.2.5.2 EEC updating EAS discovery information subscription at EES using Eees_EASDiscovery_UpdateSubscription operation p. 22
5.3.2.6 Eees_EASDiscovery_Unsubscribe p. 22
5.4 Eees_ACREvents Service p. 23
5.4.1 Service Description p. 23
5.4.2 Service Operations p. 23
5.4.2.1 Introduction p. 23
5.4.2.2 Eees_ACREvents_Subscribe p. 23
5.4.2.2.1 General p. 23
5.4.2.2.2 EEC subscribing to ACR information from EES using Eees_ACREvents_Subscribe operation p. 23
5.4.2.3 Eees_ACREvents_Notify p. 24
5.4.2.3.1 General p. 24
5.4.2.3.2 EES notifying the ACR information to EEC using Eees_ACREvents_Notify operation p. 24
5.4.2.4 Eees_ACREvents_UpdateSubscription p. 25
5.4.2.4.1 General p. 25
5.4.2.4.3 EEC updating ACR information subscription at EES using Eees_ACREvents_UpdateSubscription operation p. 25
5.4.2.5 Eees_ACREvents_Unsubscribe p. 25
5.5 Eees_AppContextRelocation Service p. 26
5.5.1 Service Description p. 26
5.5.2 Service Operations p. 26
5.5.2.1 Introduction p. 26
5.5.2.2 Eees_AppContextRelocation_Determine p. 26
5.5.2.2.1 General p. 26
5.5.2.2.2 ACR Determination p. 26
5.5.2.3 Eees_AppContextRelocation_Initiate p. 27
5.5.2.3.1 General p. 27
5.5.2.3.2 ACR Initiation p. 27
5.6 Eees_UEIdentifier Service p. 28
5.6.1 Service Description p. 28
5.6.2 Service Operations p. 28
5.6.2.1 Introduction p. 28
5.6.2.2 Eees_UEIdentifier_Get p. 28
5.6.2.2.1 General p. 28
5.6.2.2.2 Retrieve UE identifier p. 28
5.7 Eees_EASInformationProvisioning Service p. 29
6 Edge Enabler Server API Definitions p. 31
6.1 Void
6.2 Eees_EECRegistration API p. 31
6.2.1 API URI p. 31
6.2.2 Resources p. 31
6.2.2.1 Overview p. 31
6.2.2.2 Resource: EEC Registrations p. 32
6.2.2.2.1 Description p. 32
6.2.2.2.2 Resource Definition p. 32
6.2.2.2.3 Resource Standard Methods p. 32
6.2.2.2.4 Resource Custom Operations p. 33
6.2.2.3 Resource: Individual EEC registration p. 33
6.2.3 Custom Operations without associated resources p. 37
6.2.4 Notifications p. 37
6.2.5 Data Model p. 37
6.2.5.1 General p. 37
6.2.5.2 Structured data types p. 38
6.2.5.2.1 Introduction p. 38
6.2.5.2.2 Type: EecRegistration p. 39
6.2.5.2.3 Type: ACProfile p. 41
6.2.5.2.4 Type: EasDetail p. 41
6.2.5.2.5 Type: ACServiceKPIs p. 42
6.2.5.2.6 Type: EecRegistrationPatch p. 42
6.2.5.2.7 Type: UnfulfilledAcProfile p. 42
6.2.5.3 Simple data types and enumerations p. 43
6.2.6 Error Handling p. 43
6.2.6.0 General p. 43
6.2.6.1 Application Errors p. 43
6.2.7 Feature negotiation p. 44
6.3 Eees_EASDiscovery API p. 44
6.3.1 API URI p. 44
6.3.2 Resources p. 45
6.3.2.1 Overview p. 45
6.3.2.2 Resource: EAS Discovery Subscriptions p. 45
6.3.2.2.1 Description p. 45
6.3.2.2.2 Resource Definition p. 46
6.3.2.2.3 Resource Standard Methods p. 46
6.3.2.2.4 Resource Custom Operations p. 46
6.3.2.3 Resource: Individual EAS Discovery Subscription p. 47
6.3.2.3.1 Description p. 47
6.3.2.3.2 Resource Definition p. 47
6.3.2.3.3 Resource Standard Methods p. 47
6.3.2.3.4 Resource Custom Operations p. 50
6.3.2.4 Resource: EAS Profiles p. 50
6.3.3 Custom operations without associated resources p. 51
6.3.4 Notifications p. 51
6.3.4.1 General p. 51
6.3.4.2 EAS Discovery Notification p. 52
6.3.5 Data Model p. 53
6.3.5.1 General p. 53
6.3.5.2 Structured data types p. 54
6.3.5.2.1 Introduction p. 54
6.3.5.2.2 Type: EasDiscoveryReq p. 55
6.3.5.2.3 Type: EasDiscoveryResp p. 56
6.3.5.2.4 Type: EasDiscoverySubscription p. 57
6.3.5.2.5 Type: EasDiscoveryNotification p. 59
6.3.5.2.6 Type: EasDiscoveryFilter p. 59
6.3.5.2.7 Type: EasCharacteristics p. 60
6.3.5.2.8 Type: DiscoveredEas p. 60
6.3.5.2.9 Type: EasDynamicInfoFilter p. 60
6.3.5.2.10 Type: EasDynamicInfoFilterData p. 61
6.3.5.2.11 Type: ACCharacteristics p. 61
6.3.5.2.12 Type: EasDiscoverySubscriptionPatch p. 61
6.3.5.2.13 Type: RequestorId p. 61
6.3.5.2.14 Type: EdgeLoadAnalytic p. 62
6.3.5.2.15 Type: PredictiveData p. 62
6.3.5.2.16 Type: StatisticalData p. 62
6.3.5.3 Simple data types and enumerations p. 62
6.3.6 Error Handling p. 63
6.3.7 Feature negotiation p. 63
6.4 Eees_ACREvents API p. 64
6.4.1 API URI p. 64
6.4.2 Resources p. 64
6.4.2.1 Overview p. 64
6.4.2.2 Resource: ACR events subscriptions p. 65
6.4.2.2.1 Description p. 65
6.4.2.2.2 Resource Definition p. 65
6.4.2.2.3 Resource Standard Methods p. 65
6.4.2.2.4 Resource Custom Operations p. 66
6.4.2.3 Resource: Individual ACR events subscription p. 66
6.4.3 Custom operations without associated resources p. 70
6.4.4 Notifications p. 70
6.4.4.1 General p. 70
6.4.4.2 ACR Information Notification p. 70
6.4.5 Data Model p. 71
6.4.5.1 General p. 71
6.4.5.2 Structured data types p. 72
6.4.5.2.1 Introduction p. 72
6.4.5.2.2 Type: ACREventsSubscription p. 72
6.4.5.2.3 Type: ACRInfoNotification p. 73
6.4.5.2.4 Type: TargetInfo p. 73
6.4.5.2.5 Type: ACREventsSubscriptionPatch p. 74
6.4.5.2.6 Type: EecCtxtRelocStatus p. 74
6.4.5.2.7 Type: ACRCompleteEventInfo p. 74
6.4.5.3 Simple data types and enumerations p. 74
6.4.6 Error Handling p. 75
6.4.7 Feature negotiation p. 75
6.5 Eees_AppContextRelocation API p. 75
6.5.1 Introduction p. 75
6.5.2 Resources p. 75
6.5.3 Custom Operations without associated resources p. 76
6.5.3.1 Overview p. 76
6.5.3.2 Operation: Determine p. 76
6.5.3.2.1 Description p. 76
6.5.3.2.2 Operation Definition p. 76
6.5.3.3 Operation: Initiate p. 77
6.5.3.3.1 Description p. 77
6.5.3.3.2 Operation Definition p. 77
6.5.3.4 Operation: Declare p. 78
6.5.3.4.1 Description p. 78
6.5.3.4.2 Operation Definition p. 78
6.5.4 Notifications p. 79
6.5.5 Data Model p. 79
6.5.5.1 General p. 79
6.5.5.2 Structured data types p. 80
6.5.5.2.1 Introduction p. 80
6.5.5.2.2 Type: AcrDetermReq p. 80
6.5.5.2.3 Type: AcrInitReq p. 81
6.5.5.2.4 Type: AcrDecReq p. 83
6.5.5.2.5 Type: EecCtxtReloc p. 83
6.5.5.2.6 Type: ExpectedLocationArea p. 84
6.5.5.2.7 Type: AcrParameters p. 84
6.5.5.2.8 Type: AcrModificationParams p. 84
6.5.5.3 Simple data types and enumerations p. 84
6.5.5.3.1 Introduction p. 84
6.5.5.3.2 Simple data types p. 84
6.5.6 Error Handling p. 84
6.5.7 Feature negotiation p. 84
6.6 Eees_EASInformationProvisioning API p. 85
6.6.1 API URI p. 85
6.6.2 Resources p. 85
6.6.3 Custom operations without associated resources p. 85
6.6.3.1 Overview p. 85
6.6.3.2 Operation: Declare p. 86
6.6.3.2.1 Description p. 86
6.6.3.2.2 Operation Definition p. 86
6.6.3.3 Void
6.6.3.4 Void
6.6.4 Notifications p. 86
6.6.5 Data Model p. 87
6.6.5.1 General p. 87
6.6.5.2 Structured data types p. 87
6.6.5.2.1 Introduction p. 87
6.6.5.2.2 Type: EasInfoProvReq p. 88
6.6.5.2.3 Type: EasInfoProvResp p. 88
6.6.5.2.4 Type: InstantiatedEASInfo p. 89
6.6.5.2.5 Void
6.6.5.2.6 Void
6.6.5.2.7 Void
6.6.5.3 Simple data types and enumerations p. 89
6.6.6 Error Handling p. 90
6.6.7 Feature negotiation p. 90
7 Services offered by Edge Configuration Server p. 90
7.1 Introduction p. 90
7.2 Eecs_ServiceProvisioning Service p. 91
7.2.1 Service Description p. 91
7.2.2 Service Operations p. 91
7.2.2.1 Introduction p. 91
7.2.2.2 Eecs_ServiceProvisioning_Request p. 91
7.2.2.2.1 General p. 91
7.2.2.2.2 EEC requesting service provisioning information using Eecs_ServiceProvisioning_Request operation p. 91
7.2.2.3 Eecs_ServiceProvisioning_Subscribe p. 93
7.2.2.3.1 General p. 93
7.2.2.3.2 EEC subscribing to service provisioning information from ECS using Eecs_ServiceProvisioning_Subscribe operation p. 93
7.2.2.4 Eecs_ServiceProvisioning_Notify p. 94
7.2.2.4.1 General p. 94
7.2.2.4.2 ECS notifying the service provisioning information to EEC using Eecs_ServiceProvisioning_Notify operation p. 94
7.2.2.5 Eecs_ServiceProvisioning_UpdateSubscription p. 95
7.2.2.5.1 General p. 95
7.2.2.5.2 EEC updating service provisioning information subscription at ECS using Eecs_ServiceProvisioning_UpdateSubscription operation p. 95
7.2.2.6 Eecs_ServiceProvisioning_Unsubscribe p. 95
8 Edge Configuration Server API Definitions p. 96
8.1 Eecs_ServiceProvisioning API p. 96
8.1.1 API URI p. 96
8.1.2 Resources p. 96
8.1.2.1 Overview p. 96
8.1.2.3 Resource: Service Provisioning Subscriptions p. 97
8.1.2.3.1 Description p. 97
8.1.2.3.2 Resource Definition p. 97
8.1.2.3.3 Resource Standard Methods p. 97
8.1.2.3.4 Resource Custom Operations p. 98
8.1.2.4 Resource: Individual Service Provisioning Subscription p. 98
8.1.3 Custom Operations without associated resources p. 101
8.1.3.1 Overview p. 101
8.1.3.2 Operation: Request p. 102
8.1.3.2.1 Description p. 102
8.1.3.2.2 Operation Definition p. 102
8.1.4 Notifications p. 103
8.1.4.1 General p. 103
8.1.4.2 Service Provisioning Notification p. 103
8.1.4.2.1 Description p. 103
8.1.4.2.2 Notification definition p. 103
8.1.5 Data Model p. 104
8.1.5.1 General p. 104
8.1.5.2 Structured data types p. 105
8.1.5.2.1 Introduction p. 105
8.1.5.2.2 Type: ECSServProvReq p. 105
8.1.5.2.3 Type: ECSServProvResp p. 106
8.1.5.2.4 Type: ECSServProvSubscription p. 107
8.1.5.2.5 Type: ConnectivityInfo p. 108
8.1.5.2.6 Type: ServProvNotification p. 108
8.1.5.2.7 Type: EDNConfigInfo p. 108
8.1.5.2.8 Type: EDNConInfo p. 108
8.1.5.2.9 Type: EESInfo p. 109
8.1.5.2.10 Type: ECSServProvSubscriptionPatch p. 109
8.1.5.2.11 Enumeration: EesAuthMethod p. 109
8.1.5.2.12 Type: ECSRedirectInfo p. 110
8.1.5.2.13 Type: AppGroupProfile p. 110
8.1.5.2.14 Type: ApplicationInfo p. 110
8.1.5.2.15 Type: EASBundleDetail p. 111
8.1.5.3 Simple data types and enumerations p. 111
8.1.6 Error Handling p. 111
8.1.7 Feature negotiation p. 111
9 Security p. 111
10 SEAL services p. 112
A (Normative) Edge Enabler Server OpenAPI specification p. 112
A.1 General p. 112
A.2 Eees_EECRegistration API p. 112
A.3 Eees_EASDiscovery API p. 118
A.4 Eees_ACREvents API p. 127
A.5 Eees_AppContextRelocation API p. 133
A.6 Eees_ EASInformationProvisioning API p. 137
B (Normative) Edge Configuration Server OpenAPI specification p. 140
B.1 Eecs_ServiceProvisioning p. 140
C Protocol options considered for EDGE-4 reference point p. 149
$ Change history p. 150
