Tech-
invite
3GPP
space
IETF
space
21
22
23
24
25
26
27
28
29
31
32
33
34
35
36
37
38
4‑5x
Content for
TS 29.564
Word version: 18.5.0
1…
5…
5
Services offered by the UPF
5.1
Introduction
5.2
Nupf_EventExposure Service
5.3
Nupf_GetUEPrivateIPaddrAndIdentifiers Service
6
API Definitions
6.1
Nupf_EventExposure Service API
6.2
Nupf_GetUEPrivateIPaddrAndIdentifiers Service API
A
OpenAPI specification
A.1
General
A.2
Nupf_EventExposure API
A.3
Nupf_GetUEPrivateIPaddrAndIdentifiers API
$
Change history
5
Services offered by the UPF
p. 9
5.1
Introduction
p. 9
5.2
Nupf_EventExposure Service
p. 9
5.2.1
Service Description
p. 9
5.2.1.1
Service operations
|R18|
p. 9
5.2.1.2
Subscription to UPF events
|R18|
p. 10
5.2.1.3
UPF events supported by the Nupf_EventExposure service
|R18|
p. 10
5.2.1.3.1
General
p. 10
5.2.1.3.2
QoS Monitoring
p. 11
5.2.1.3.3
User Data Usage Measures
p. 12
5.2.1.3.4
User Data Usage Trends
p. 13
5.2.1.3.5
TSC Management Information
p. 13
5.2.2
Service Operations
p. 13
5.2.2.1
Introduction
p. 13
5.2.2.2
Subscribe
p. 14
5.2.2.2.1
General
|R18|
p. 14
5.2.2.2.2
Creation of a subscription
|R18|
p. 14
5.2.2.2.3
Modification of a subscription
|R18|
p. 16
5.2.2.2A
Unsubscribe
|R18|
p. 17
5.2.2.2A.1
General
p. 17
5.2.2.3
Notify
p. 17
5.2.2.3.1
General
p. 17
5.2.2.3.2
UPF sends notification on subscribed events
p. 18
5.3
Nupf_GetUEPrivateIPaddrAndIdentifiers Service
|R18|
p. 19
5.3.1
Service Description
p. 19
5.3.2
Service Operations
p. 19
5.3.2.1
Introduction
p. 19
5.3.2.2
Get
p. 19
5.3.2.2.1
General
p. 19
6
API Definitions
p. 20
6.1
Nupf_EventExposure Service API
p. 20
6.1.1
API URI
p. 20
6.1.2
Usage of HTTP
p. 20
6.1.2.1
General
p. 20
6.1.2.2
HTTP standard headers
p. 21
6.1.2.2.1
General
p. 21
6.1.2.2.2
Content type
p. 21
6.1.2.3
HTTP custom headers
p. 21
6.1.3
Resources
p. 21
6.1.3.1
Overview
p. 21
6.1.3.2
Resource: EventExposureSubscriptions
p. 22
6.1.3.2.1
Description
p. 22
6.1.3.2.2
Resource Definition
p. 22
6.1.3.2.3
Resource Standard Methods
p. 22
6.1.3.2.4
Resource Custom Operations
|R18|
p. 23
6.1.3.3
Resource: Individual subscription
|R18|
p. 24
6.1.3.3.1
Description
p. 24
6.1.3.3.2
Resource Definition
p. 24
6.1.3.3.3
Resource Standard Methods
p. 24
6.1.3.3.4
Resource Custom Operations
p. 27
6.1.4
Void
6.1.5
Notifications
p. 27
6.1.5.1
General
p. 27
6.1.5.2
Event Notification
p. 27
6.1.5.2.1
Description
p. 27
6.1.5.2.2
Target URI
p. 27
6.1.6
Data Model
p. 28
6.1.6.1
General
p. 28
6.1.6.2
Structured data types
p. 30
6.1.6.2.1
Introduction
p. 30
6.1.6.2.2
Type: NotificationData
p. 31
6.1.6.2.3
Type: NotificationItem
p. 32
6.1.6.2.4
Type: QosMonitoringMeasurement
p. 33
6.1.6.2.5
Type: UserDataUsageMeasurements
|R18|
p. 36
6.1.6.2.6
Type: VolumeMeasurement
|R18|
p. 37
6.1.6.2.7
Type: ThroughputMeasurement
|R18|
p. 37
6.1.6.2.8
Type: ApplicationRelatedInformation
|R18|
p. 37
6.1.6.2.9
Type: ThroughputStatisticMeasurement
|R18|
p. 38
6.1.6.2.10
Type: DomainInformation
|R18|
p. 38
6.1.6.2.11
Type: UpfEventSubscription
|R18|
p. 39
6.1.6.2.12
Type: UpfEventMode
|R18|
p. 40
6.1.6.2.13
Type: UpfEvent
|R18|
p. 42
6.1.6.2.14
Type: CreateEventSubscription
|R18|
p. 43
6.1.6.2.15
Type: CreatedEventSubscription
|R18|
p. 43
6.1.6.2.16
Type: ReportingSuggestionInformation
|R18|
p. 43
6.1.6.2.17
Type: TscManagementInfo
|R18|
p. 43
6.1.6.3
Simple data types and enumerations
p. 43
6.1.6.3.1
Introduction
p. 43
6.1.6.3.2
Simple data types
p. 44
6.1.6.3.3
Enumeration: EventType
p. 44
6.1.6.3.4
Enumeration: UpfEventTrigger
|R18|
p. 44
6.1.6.3.5
Enumeration: MeasurementType
|R18|
p. 44
6.1.6.3.6
Enumeration: GranularityOfMeasurement
|R18|
p. 45
6.1.6.3.7
Enumeration: DnProtocol
|R18|
p. 45
6.1.6.3.8
Enumeration: ReportingUrgency
|R18|
p. 45
6.1.7
Error Handling
p. 45
6.1.7.1
General
p. 45
6.1.7.2
Protocol Errors
p. 45
6.1.7.3
Application Errors
p. 45
6.1.8
Feature negotiation
p. 46
6.1.9
Security
p. 46
6.1.10
HTTP redirection
|R18|
p. 46
6.2
Nupf_GetUEPrivateIPaddrAndIdentifiers Service API
|R18|
p. 47
6.2.1
Introduction
p. 47
6.2.2
Usage of HTTP
p. 47
6.2.2.1
General
p. 47
6.2.2.2
HTTP standard headers
p. 47
6.2.2.2.1
General
p. 47
6.2.2.2.2
Content type
p. 47
6.2.2.3
HTTP custom headers
p. 47
6.2.3
Resources
p. 48
6.2.3.1
Overview
p. 48
6.2.3.2
Resource: UE IP Address Info
p. 48
6.2.3.2.1
Description
p. 48
6.2.3.2.2
Resource Definition
p. 48
6.2.3.2.3
Resource Standard Methods
p. 48
6.2.3.2.4
Resource Custom Operations
p. 50
6.2.4
Custom Operations without associated resources
p. 50
6.2.5
Notifications
p. 50
6.2.5.1
General
p. 50
6.2.6
Data Model
p. 50
6.2.6.1
General
p. 50
6.2.6.2
Structured data types
p. 50
6.2.6.2.1
Introduction
p. 50
6.2.6.2.2
Type: UeIpInfo
p. 51
6.2.6.3
Simple data types and enumerations
p. 51
6.2.6.3.1
Introduction
p. 51
6.2.7
Error Handling
p. 51
6.2.7.1
General
p. 51
6.2.7.2
Protocol Errors
p. 52
6.2.7.3
Application Errors
p. 52
6.2.8
Feature negotiation
p. 52
6.2.9
Security
p. 52
6.2.10
HTTP redirection
p. 52
A
(Normative) OpenAPI specification
p. 53
A.1
General
p. 53
A.2
Nupf_EventExposure API
p. 53
A.3
Nupf_GetUEPrivateIPaddrAndIdentifiers API
|R18|
p. 61
$
Change history
p. 65