5.1 Nnwdaf_EventsSubscription Service API

29.5203GPP5G SystemNetwork Data Analytics ServicesRelease 17Stage 3TS

5.1.1 Introduction

The Nnwdaf_EventsSubscription Service shall use the Nnwdaf_EventsSubscription API.

The API URI of the Nnwdaf_EventsSubscription API shall be:

{apiRoot}/<apiName>/<apiVersion>

The request URIs used in each HTTP requests from the NF service consumer towards the NWDAF shall have the Resource URI structure defined in subclause 4.4.1 of 3GPP TS 29.501 [7], i.e.:

{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>

with the following components:

– The {apiRoot} shall be set as described in 3GPP TS 29.501 [7].

– The <apiName> shall be "nnwdaf-eventssubscription".

– The <apiVersion> shall be "v1".

– The <apiSpecificResourceUriPart> shall be set as described in subclause 5.1.3.

5.1.2 Usage of HTTP

5.1.2.1 General

HTTP/2, IETF RFC 7540 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6].

HTTP/2 shall be transported as specified in subclause 5.3 of 3GPP TS 29.500 [6].

The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf_EventsSubscription is contained in Annex A.

5.1.2.2 HTTP standard headers

5.1.2.2.1 General

See subclause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers.

5.1.2.2.2 Content type

JSON, IETF RFC 8259 [10], shall be used as content type of the HTTP bodies specified in the present specification as specified in subclause 5.4 of 3GPP TS 29.500 [6]. The use of the JSON format shall be signalled by the content type "application/json".

"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [15].

5.1.2.3 HTTP custom headers

The Nnwdaf_EventsSubscription Service API shall support the mandatory HTTP custom header fields specified in subclause 5.2.3.2 of 3GPP TS 29.500 [6] and may support the optional HTTP custom header fields specified in subclause 5.2.3.3 of 3GPP TS 29.500 [6].

In this release of the specification, no specific custom headers are defined for the Nnwdaf_EventsSubscription Service API.

5.1.3 Resources

5.1.3.1 Resource Structure

Figure 5.1.3.1-1: Resource URI structure of the Nnwdaf_EventsSubscription API

Table 5.1.3.1-1 provides an overview of the resources and applicable HTTP methods.

Table 5.1.3.1-1: Resources and methods overview

Resource name

Resource URI

HTTP method or custom operation

Description

NWDAF Events Subscriptions

/subscriptions

POST

Creates a new Individual NWDAF Event Subscription resource.

Individual NWDAF Event Subscription

/subscriptions/{subscriptionId}

DELETE

Deletes an Individual NWDAF Event Subscription identified by subresource {subscriptionId}.

PUT

Modifies an existing Individual Event Subscription subresource.

NWDAF Event Subscription Transfers

/transfers

POST

Provides information about the requested analytics subscription transfer(s), potentially creating a new Individual NWDAF Event Subscription Transfer resource.

Individual NWDAF Event Subscription Transfer

/transfers/{transferId}

DELETE

Deletes an Individual NWDAF Event Subscription Transfer resource identified by subresource {transferId}.

PUT

Modifies an existing Individual NWDAF Event Subscription Transfer resource.

5.1.3.2 Resource: NWDAF Events Subscriptions

5.1.3.2.1 Description

The NWDAF Events Subscriptions resource represents all subscriptions to the Nnwdaf_EventsSubscription Service at a given NWDAF. The resource allows an NF service consumer to create a new Individual NWDAF Event Subscription resource.

5.1.3.2.2 Resource definition

Resource URI: {apiRoot}/nnwdaf-eventssubscription/v1/subscriptions

This resource shall support the resource URI variables defined in table 5.1.3.2.2-1.

Table 5.1.3.2.2-1: Resource URI variables for this resource

Name

Data type

Definition

apiRoot

string

See subclause 5.1.1

5.1.3.2.3 Resource Standard Methods
5.1.3.2.3.1 POST

This method shall support the URI query parameters specified in table 5.1.3.2.3.1-1.

Table 5.1.3.2.3.1-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 5.1.3.2.3.1-2 and the response data structures and response codes specified in table 5.1.3.2.3.1-3.

Table 5.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource

Data type

P

Cardinality

Description

NnwdafEventsSubscription

M

1

Create a new Individual NWDAF Event Subscription resource.

Table 5.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource

Data type

P

Cardinality

Response

codes

Description

NnwdafEventsSubscription

M

1

201 Created

The creation of an Individual NWDAF Event Subscription resource is confirmed and a representation of that resource is returned.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply.

Table 5.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nnwdaf-eventssubscription/v1/subscriptions/{subscriptionId}

5.1.3.2.4 Resource Custom Operations

None in this release of the specification.

5.1.3.3 Resource: Individual NWDAF Event Subscription

5.1.3.3.1 Description

The Individual NWDAF Event Subscription resource represents a single subscription to the Nnwdaf_EventsSubscription Service at a given NWDAF.

5.1.3.3.2 Resource definition

Resource URI: {apiRoot}/nnwdaf-eventssubscription/v1/subscriptions/{subscriptionId}

This resource shall support the resource URI variables defined in table 5.1.3.3.2-1.

Table 5.1.3.3.2-1: Resource URI variables for this resource

Name

Data type

Definition

apiRoot

string

See subclause 5.1.1

subscriptionId

string

Identifies a subscription to the Nnwdaf_EventsSubscription Service

5.1.3.3.3 Resource Standard Methods
5.1.3.3.3.1 DELETE

This method shall support the URI query parameters specified in table 5.1.3.3.3.1-1.

Table 5.1.3.3.3.1-1: URI query parameters supported by the DELETE method on this resource

Name

Data type

P

Cardinality

Description

n/a

This method shall support the request data structures specified in table 5.1.3.3.3.1-2 and the response data structures and response codes specified in table 5.1.3.3.3.1-3.

Table 5.1.3.3.3.1-2: Data structures supported by the DELETE Request Body on this resource

Data type

P

Cardinality

Description

n/a

Table 5.1.3.3.3.1-3: Data structures supported by the DELETE Response Body on this resource

Data type

P

Cardinality

Response

codes

Description

n/a

204 No Content

Successful case: The Individual NWDAF Event Subscription resource matching the subscriptionId was deleted.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual NWDAF Event Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual NWDAF Event Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

Applicable if the feature "ES3XX" is supported.

ProblemDetails

O

0..1

404 Not Found

The Individual NWDAF Event Subscription resource does not exist. (NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply.

NOTE 2: Failure cases are described in subclause 5.1.7.

Table 5.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Table 5.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

5.1.3.3.3.2 PUT

This method shall support the URI query parameters specified in table 5.1.3.3.3.2-1.

Table 5.1.3.3.3.2-1: URI query parameters supported by the PUT method on this resource

Name

Data type

P

Cardinality

Description

n/a

This method shall support the request data structures specified in table 5.1.3.3.3.2-2 and the response data structures and response codes specified in table 5.1.3.3.3.2-3.

Table 5.1.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource

Data type

P

Cardinality

Description

NnwdafEventsSubscription

M

1

Parameters to replace a subscription to NWDAF Event Subscription resource.

Table 5.1.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource

Data type

P

Cardinality

Response codes

Description

NnwdafEventsSubscription

M

1

200 OK

The Individual NWDAF Event Subscription resource was modified successfully and a representation of that resource is returned.

n/a

204 No Content

The Individual NWDAF Event Subscription resource was modified successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual NWDAF Event Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual NWDAF Event Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

Applicable if the feature "ES3XX" is supported.

ProblemDetails

O

0..1

404 Not Found

The Individual NWDAF Event Subscription resource does not exist. (NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply.

NOTE 2: Failure cases are described in subclause 5.1.7.

Table 5.1.3.3.3.2-4: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Table 5.1.3.3.3.2-5: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

5.1.3.3.4 Resource Custom Operations

None in this release of the specification.

5.1.3.4 Resource: NWDAF Event Subscription Transfers

5.1.3.4.1 Description

The NWDAF Event Subscription Transfers resource represents all requests to transfer subscription(s) of the Nnwdaf_EventsSubscription Service at a given NWDAF. The resource allows an NF service consumer to provide information about analytics subscriptions that are requested to be:

– prepared for transfer, leading to the creation of a new Individual NWDAF Event Subscription Transfer resource, which can be later modified, removed, or requested to be transferred.

– transferred, leading to the execution of the necessary steps for transferring the analytics subscription.

5.1.3.4.2 Resource definition

Resource URI: {apiRoot}/nnwdaf-eventssubscription/v1/transfers

This resource shall support the resource URI variables defined in table 5.1.3.4.2-1.

Table 5.1.3.4.2-1: Resource URI variables for this resource

Name

Data type

Definition

apiRoot

string

See subclause 5.1.1

5.1.3.4.3 Resource Standard Methods
5.1.3.4.3.1 POST

This method shall support the URI query parameters specified in table 5.1.3.4.3.1-1.

Table 5.1.3.4.3.1-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 5.1.3.4.3.1-2 and the response data structures and response codes specified in table 5.1.3.4.3.1-3.

Table 5.1.3.4.3.1-2: Data structures supported by the POST Request Body on this resource

Data type

P

Cardinality

Description

AnalyticsSubscriptionsTransfer

M

1

Information about analytics subscription(s) that are requested to be transferred or prepared for transfer.

Table 5.1.3.4.3.1-3: Data structures supported by the POST Response Body on this resource

Data type

P

Cardinality

Response

codes

Description

AnalyticsSubscriptionsTransfer

M

1

201 Created

The creation of an Individual NWDAF Event Subscription resource is confirmed and a representation of that resource is returned.

n/a

204 No Content

The receipt of the information about analytics subscription(s) that are requested to be transferred and the ability to handle this information (e.g. execute the steps required to transfer an analytics subscription directly) is confirmed.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply.

Table 5.1.3.4.3.1-4: Headers supported by the 201 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nnwdaf-eventssubscription/v1/transfers/{transferId}.

5.1.3.4.4 Resource Custom Operations

None in this release of the specification.

5.1.3.5 Resource: Individual NWDAF Event Subscription Transfer

5.1.3.5.1 Description

The Individual NWDAF Event Subscription Transfer resource represents a single request to transfer subscription(s) of the Nnwdaf_EventsSubscription Service at a given NWDAF.

5.1.3.5.2 Resource definition

Resource URI: {apiRoot}/nnwdaf-eventssubscription/v1/transfers/{transferId}

This resource shall support the resource URI variables defined in table 5.1.3.5.2-1.

Table 5.1.3.5.2-1: Resource URI variables for this resource

Name

Data type

Definition

apiRoot

string

See subclause 5.1.1

transferId

string

Identifies a request to transfer subscription(s) of the Nnwdaf_EventsSubscription Service

5.1.3.5.3 Resource Standard Methods
5.1.3.5.3.1 DELETE

This method shall support the URI query parameters specified in table 5.1.3.5.3.1-1.

Table 5.1.3.5.3.1-1: URI query parameters supported by the DELETE method on this resource

Name

Data type

P

Cardinality

Description

n/a

This method shall support the request data structures specified in table 5.1.3.5.3.1-2 and the response data structures and response codes specified in table 5.1.3.5.3.1-3.

Table 5.1.3.5.3.1-2: Data structures supported by the DELETE Request Body on this resource

Data type

P

Cardinality

Description

n/a

Table 5.1.3.5.3.1-3: Data structures supported by the DELETE Response Body on this resource

Data type

P

Cardinality

Response

codes

Description

n/a

204 No Content

Successful case: The Individual NWDAF Event Subscription Transfer resource matching the transferId was deleted.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual NWDAF Event Subscription Transfer deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual NWDAF Event Subscription Transfer deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

Applicable if the feature "ES3XX" is supported.

NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply.

Table 5.1.3.5.3.1-4: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Table 5.1.3.5.3.1-5: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

5.1.3.5.3.2 PUT

This method shall support the URI query parameters specified in table 5.1.3.5.3.2-1.

Table 5.1.3.5.3.2-1: URI query parameters supported by the PUT method on this resource

Name

Data type

P

Cardinality

Description

n/a

This method shall support the request data structures specified in table 5.1.3.5.3.2-2 and the response data structures and response codes specified in table 5.1.3.5.3.2-3.

Table 5.1.3.5.3.2-2: Data structures supported by the PUT Request Body on this resource

Data type

P

Cardinality

Description

AnalyticsSubscriptionsTransfer

M

1

Parameters to replace in an Individual NWDAF Event Subscription Transfer resource.

Table 5.1.3.5.3.2-3: Data structures supported by the PUT Response Body on this resource

Data type

P

Cardinality

Response codes

Description

AnalyticsSubscriptionsTransfer

M

1

200 OK

The Individual NWDAF Event Subscription Transfer resource was modified successfully and a representation of the resource is returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual NWDAF Event Subscription Transfer modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual NWDAF Event Subscription Transfer modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

Applicable if the feature "ES3XX" is supported.

NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply.

Table 5.1.3.5.3.2-4: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Table 5.1.3.5.3.2-5: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

5.1.3.5.4 Resource Custom Operations

None in this release of the specification.

5.1.4 Custom Operations without associated resources

None in this release of the specification.

5.1.5 Notifications

5.1.5.1 General

Notifications shall comply with subclause 6.2 of 3GPP TS 29.500 [6] and subclause 4.6.2.3 of 3GPP TS 29.501 [7].

Table 5.3.3.4.1-1: Notifications overview

Notification

Callback URI

HTTP method or custom operation

Description (service operation)

Event Notification

{notificationURI}

POST

Report one or several observed Events.

5.1.5.2 Event Notification

5.1.5.2.1 Description

The Event Notification is used by the NWDAF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications via the Individual NWDAF Event Subscription Resource.

5.1.5.2.2 Operation Definition

Callback URI: {notificationURI}

The operation shall support the callback URI variables defined in table 5.1.5.2.2-1, the request data structures specified in table 5.1.5.2.2-2 and the response data structure and response codes specified in table 5.1.5.2.2-3.

Table 5.1.5.2.2-1: Callback URI variables

Name

Data type

Definition

notificationURI

Uri

The Notification Uri as assigned within the Individual NWDAF Event Subscription and described within the NnwdafEventsSubscription type (see table 5.1.6.2.2-1).

Table 5.1.5.2.2-2: Data structures supported by the POST Request Body on this resource

Data type

P

Cardinality

Description

array(NnwdafEventsSubscriptionNotification)

M

1..N

Provides Information about observed events

Table 5.1.5.2.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 receipt of the Notification is acknowledged.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during the event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during the event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

Applicable if the feature "ES3XX" is supported.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply.

Table 5.1.5.2.2-4: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected.

Table 5.1.5.2.2-5: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected.

5.1.6 Data Model

5.1.6.1 General

This subclause specifies the application data model supported by the API.

Table 5.1.6.1-1 specifies the data types defined for the Nnwdaf_EventsSubscription service based interface protocol.

Table 5.1.6.1-1: Nnwdaf_EventsSubscription specific Data Types

Data type

Section defined

Description

Applicability

AbnormalBehaviour

5.1.6.2.15

Represents the abnormal behaviour information.

AbnormalBehaviour

Accuracy

5.1.6.3.5

Represents the preferred level of accuracy of the analytics.

AdditionalMeasurement

5.1.6.2.26

AbnormalBehaviour

AddressList

5.1.6.2.28

AbnormalBehaviour

AnalyticsContextIdentifer

5.1.6.2.43

Contains information about available analytics contexts.

EneNA

AnalyticsMetadata

5.1.6.3.14

Represents the types of analytics metadata information that can be requested.

Aggregation

AnalyticsMetadataIndication

5.1.6.2.36

Contains analytics metadata values indicated to be used during analytics generation.

Aggregation

AnalyticsMetadataInfo

5.1.6.2.37

Contains analytics metadata information required for analytics aggregation.

Aggregation

AnalyticsSubscriptionsTransfer

5.1.6.2.40

Contains information about a request to transfer analytics subscriptions.

EneNA

AnySlice

5.1.6.3.2

Represents the any slices.

BwRequirement

5.1.6.2.25

Represents bandwidth requirement.

ServiceExperience

CircumstanceDescription

5.1.6.2.29

AbnormalBehaviour

CongestionInfo

5.1.6.2.18

UserDataCongestion

CongestionType

5.1.6.3.8

UserDataCongestion

DatasetStatisticalProperty

5.1.6.3.15

Dataset statistical properties of the data used to generate the analytics.

Aggregation

EventNotification

5.1.6.2.5

Describes Notifications about events that occurred.

EventReportingRequirement

5.1.6.2.7

Represents the type of reporting the subscription requires.

EventSubscription

5.1.6.2.3

Represents the subscription to a single event.

Exception

5.1.6.2.16

Describes the Exception information.

AbnormalBehaviour

ExceptionId

5.1.6.3.6

Describes the Exception Id.

AbnormalBehaviour

ExceptionTrend

5.1.6.3.7

Describes the Exception Trend.

AbnormalBehaviour

ExpectedAnalyticsType

5.1.6.3.11

AbnormalBehaviour

FailureEventInfo

5.1.6.2.35

Contains information on the event for which the subscription is not successful.

IpEthFlowDescription

5.1.6.2.27

AbnormalBehaviour

LoadLevelInformation

5.1.6.3.2

Represents load level information of the network slice and the optionally associated network slice instance.

LocationInfo

5.1.6.2.11

UeMobility

MatchingDirection

5.1.6.3.12

Defines the matching direction when crossing a threshold.

NfLoad, QoSSustainability, UserDataCongestion, NetworkPerformance

ModelInfo

5.1.6.2.42

Contains information about an ML model.

EneNA

NetworkPerfInfo

5.1.6.2.23

NetworkPerformance

NetworkPerfRequirement

5.1.6.2.22

NetworkPerformance

NetworkPerfType

5.1.6.3.10

NetworkPerformance

NfLoadLevelInformation

5.1.6.2.31

Represents load level information of a given NF instance.

NfLoad

NfStatus

5.1.6.2.32

Provides the percentage of time spent on various NF states.

NfLoad

NwdafEvent

5.1.6.3.4

Describes the NWDAF Events.

NnwdafEventsSubscription

5.1.6.2.2

Represents an Individual NWDAF Event Subscription resource.

NnwdafEventsSubscriptionNotification

5.1.6.2.4

Represents an Individual NWDAF Event Subscription Notification resource.

NwdafFailureCode

5.1.6.3.13

Identifies the failure reason.

NotificationMethod

5.1.6.3.3

Represents the notification methods that can be subscribed.

NsiIdInfo

5.1.6.2.33

Represents the S-NSSAI and the optionally associated Network Slice Instance Identifier(s).

ServiceExperience

NsiLoad

NsiLoadExt

NsiLoadLevelInfo

5.1.6.2.34

Represents the load level information for an S-NSSAI and the optionally associated network slice instance.

NsiLoad

NsiLoadExt

OutputStrategy

5.1.6.3.16

Represents the output strategy used for the reporting of the analytics.

Aggregation

QosRequirement

5.1.6.2.20

QoSSustainability

QosSustainabilityInfo

5.1.6.2.19

Represents the QoS Sustainability information.

QoSSustainability

RetainabilityThreshold

5.1.6.2.21

QoSSustainability

ServiceExperienceInfo

5.1.6.2.24

Represents the service experience information.

ServiceExperience

SliceLoadLevelInformation

5.1.6.2.6

Represents the slices and their load level information.

SubscriptionTransferInfo

5.1.6.2.41

Contains information about subscriptions that are requested to be transferred.

EneNA

TargetUeInformation

5.1.6.2.8

Identifies the target UE information.

ServiceExperience

NfLoad

NetworkPerformance

UserDataCongestion

UserDataCongestionExt

UeMobility

UeCommunication

AbnormalBehaviour

QoSSustainability

ThresholdLevel

5.1.6.2.30

Describe a threshold level.

UserDataCongestion

NfLoad

TimeUnit

5.1.6.3.9

QoSSustainability

TrafficCharacterization

5.1.6.2.14

UeCommunication

TransferRequestType

5.1.6.3.17

Represents the type of a request for analytics subscription transfer.

EneNA

TopApplication

5.1.6.2.39

Top application that contributes the most to the traffic.

UserDataCongestionExt

UeAnalyticsContextDescriptor

5.1.6.2.44

Contains information about available UE related analytics contexts.

EneNA

UeCommunication

5.1.6.2.13

UeCommunication

UeMobility

5.1.6.2.10

UeMobility

UserDataCongestionInfo

5.1.6.2.17

Represents the user data congestion information.

UserDataCongestion

Table 5.1.6.1-2 specifies data types re-used by the Nnwdaf_EventsSubscription service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnwdaf service based interface.

Table 5.1.6.1-2: Nnwdaf_EventsSubscription re-used Data Types

Data type

Reference

Comments

Applicability

5Qi

3GPP TS 29.571 [8]

Identifies the 5G QoS identifier

QoSSustainability

AddrFqdn

3GPP TS 29.517 [22]

Represents the IP address or FQDN of the Application Server.

DnPerformance

ApplicationId

3GPP TS 29.571 [8]

Identifies the application identifier.

ServiceExperience

UeCommunication

AbnormalBehaviour

ArfcnValueNR

3GPP TS 29.571 [8]

Integer value indicating the ARFCN applicable for a downlink, uplink or bi-directional (TDD) NR global frequency raster.

Minimum = 0. Maximum = 3279165.

ServiceExperienceExt

BitRate

3GPP TS 29.571 [8]

String representing a bit rate that shall be formatted as follows:

pattern: "^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$"

Examples:

"125 Mbps", "0.125 Gbps", "125000 Kbps".

ServiceExperience

QoSSustainability

DateTime

3GPP TS 29.571 [8]

Identifies the time.

Dnai

3GPP TS 29.571 [8]

Identifies a user plane access to one or more DN(s).

ServiceExperience

Dnn

3GPP TS 29.571 [8]

Identifies the DNN.

ServiceExperience

AbnormalBehaviour

UeCommunication

DurationSec

3GPP TS 29.571 [8]

EthFlowDescription

3GPP TS 29.514 [21]

UeCommunication

AbnormalBehaviour

ExpectedUeBehaviourData

3GPP TS 29.503 [23]

AbnormalBehaviour

Float

3GPP TS 29.571 [8]

FlowDescription

3GPP TS 29.514 [21]

UeCommunication

AbnormalBehaviour

FlowInfo

3GPP TS 29.122 [19]

UserDataCongestionExt

GroupId

3GPP TS 29.571 [8]

Identifies a group of UEs.

UeMobility

UeCommunication NetworkPerformance

AbnormalBehaviour

ServiceExperience

Ipv4Addr

3GPP TS 29.571 [8]

Ipv6Addr

3GPP TS 29.571 [8]

NetworkAreaInfo

3GPP TS 29.554 [18]

Identifies the network area.

ServiceExperience

QoSSustainability

AbnormalBehaviour

UeMobility

UserDataCongestion

NetworkPerformance

NsiLoadExt

NfInstanceId

3GPP TS 29.571 [8]

Identifies an NF instance

NfLoad

NfSetId

3GPP TS 29.571 [8]

Identifies an NF Set instance

NfLoad

NFType

3GPP TS 29.510 [12]

Indentifies a type of NF

NfLoad

NsiId

3GPP TS 29.531 [24]

Identifies a Network Slice Instance

ServiceExperience

NsiLoad

NsiLoadExt

PacketDelBudget

3GPP TS 29.571 [8]

QoSSustainability

PacketErrRate

3GPP TS 29.571 [8]

QoSSustainability

PacketLossRate

3GPP TS 29.517 [22]

Indicates Packet Loss Rate.

DnPerformance

ProblemDetails

3GPP TS 29.571 [8]

Used in error responses to provide more detailed information about an error.

QosResourceType

3GPP TS 29.571 [8]

Identifies the resource type in QoS characteristics.

QoSSustainability

RatType

3GPP TS 29.571 [8]

Identifies the RAT type.

ServiceExperienceExt

RedirectResponse

3GPP TS 29.571 [8]

Contains redirection related information.

ES3XX

ReportingInformation

3GPP TS 29.523 [20]

Represents the type of reporting the subscription requires.

SamplingRatio

3GPP TS 29.571 [8]

ScheduledCommunicationTime

3GPP TS 29.122 [19]

UeMobility UeCommunication

Snssai

3GPP TS 29.571 [8]

Identifies the S-NSSAI (Single Network Slice Selection Assistance Information).

SpecificAnalyticsSubscription

5.2.6.2.10

Represents an existing subscription for a specific type of analytics to a specific NWDAF.

EneNA

Supi

3GPP TS 29.571 [8]

The SUPI for an UE.

ServiceExperience,

NfLoad

NetworkPerformance,

UserDataCongestion

UeMobility

UeCommunication

AbnormalBehaviour

Gpsi

3GPP TS 29.571 [8]

The GPSI for an UE.

UserDataCongestionExt

SupportedFeatures

3GPP TS 29.571 [8]

Used to negotiate the applicability of the optional features defined in table 5.1.8-1.

SvcExperience

3GPP TS 29.517 [22]

ServiceExperience

Tai

3GPP TS 29.571 [8]

Tracking Area Information

EneNA

TimeWindow

3GPP TS 29.122 [19]

Uinteger

3GPP TS 29.571 [8]

Unsigned Integer, i.e. only value 0 and integers above 0 are permissible.

Uri

3GPP TS 29.571 [8]

UserLocation

3GPP TS 29.571 [8]

UeMobility

Volume

3GPP TS 29.122 [19]

UeCommunication

AbnormalBehaviour

5.1.6.2 Structured data types

5.1.6.2.1 Introduction

This subclause defines the structures to be used in resource representations.

5.1.6.2.2 Type NnwdafEventsSubscription

Table 5.1.6.2.2-1: Definition of type NnwdafEventsSubscription

Attribute name

Data type

P

Cardinality

Description

Applicability

eventSubscriptions

array(EventSubscription)

M

1..N

Subscribed events

evtReq

ReportingInformation

O

0..1

Represents the reporting requirements of the event subscription. (NOTE 1, NOTE 2)

If omitted, the default values within the ReportingInformation data type apply.

notificationURI

Uri

C

0..1

Identifies the recipient of Notifications sent by the NWDAF.

This parameter shall be supplied by the NF service consumer in the HTTP POST requests that create the subscriptions for event notifications and in the HTTP PUT requests that update the subscriptions for event notifications..

eventNotifications

array(EventNotification)

C

1..N

Notifications about Individual Events.

Shall only be present if the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute sets to true in the event subscription, and the reports are available.

failEventReports

array(FailureEventInfo)

O

1..N

Supplied by the NWDAF When available, shall contain the event(s) for which the subscription is not successful including the failure reason(s).

consNfInfo

ConsumerNfInformation

O

0..1

Represents the analytics consumer NF Information.

EneNA

prevSub

SpecificAnalyticsSubscription

O

0..1

Contains information about the previous analytics subscription that the NF service consumer had with NWDAF. This attribute may be provided only in the NnwdafEventsSubscription that is provided directly in the body of the POST request that creates a subscription resource. Within each element of the "eventSubscriptions" attribute of the "nwdafEvSub" attribute of this attribute, all the conditional attributes may be omitted independently of the value of the "event" attribute.

supportedFeatures

SupportedFeatures

C

0..1

List of Supported features used as described in subclause 5.1.8.

This parameter shall be supplied by NF service consumer in the POST request that request the creation of an NWDAF Event Subscriptions resource, and shall be supplied by the NWDAF in the reply of corresponding request.

NOTE 1: If the "evtReq" attribute (of data type ReportingInformation) is provided and contains the "notifMethod" attribute, the notification method indicated by the "notifMethod" attribute within the ReportingInformation data type takes preference over the notification method indicated by the "notificationMethod" attribute within the EventSubscription data type.

NOTE 2: If the "evtReq" attribute (of data type ReportingInformation) is provided and contains the "repPeriod" attribute, the periodic reporting time indicated by the "repPeriod" attribute in the ReportingInformation data type takes preference over the periodic reporting time indicated by the "repetitionPeriod" attribute in the EventSubscription data type.

Editor’s Note: It is FFS to check if the description of the "prevSub" attribute fulfils stage 2 requirements about the information that needs to be included related to the previous subscription.

5.1.6.2.3 Type EventSubscription

Table 5.1.6.2.3-1: Definition of type EventSubscription

Attribute name

Data type

P

Cardinality

Description

Applicability

anySlice

AnySlice

C

0..1

Default is "FALSE". (NOTE 1)

appIds

array(ApplicationId)

C

1..N

Identification(s) of application to which the subscription applies.

The absence of appIds means subscription to all applications. (NOTE 8)

ServiceExperience

UeCommunication

AbnormalBehaviour

dnns

array(Dnn)

C

1..N

Identification(s) of DNN to which the subscription applies. Each DNN is a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.

The absence of dnns means subscription to all DNNs (NOTE 8)

ServiceExperience, AbnormalBehaviour

UeCommunication

dnais

array(Dnai)

C

1..N

Identification(s) of user plane access to DN(s) which the subscription applies.

ServiceExperience

event

NwdafEvent

M

1

Event that is subscribed.

extraReportReq

EventReportingRequirement

O

0..1

The extra event reporting requirement information.

loadLevelThreshold

integer

C

0..1

Indicates that the NWDAF shall report the corresponding network slice load level to the NF service consumer where the load level of the network slice identified by snssais is reached. (NOTE 4)

May be included when subscribed event is "SLICE_LOAD_LEVEL".

matchingDir

MatchingDirection

O

0..1

A matching direction may be provided alongside a threshold. If omitted, the default value is CROSSED.

NfLoad, QoSSustainability, UserDataCongestion, NetworkPerformance

nfLoadLvlThds

array(ThresholdLevel)

C

1..N

Shall be supplied in order to start reporting when an average load level is reached.(NOTE 4)

NfLoad

networkArea

NetworkAreaInfo

C

0..1

Identification of network area to which the subscription applies.

The absence of networkArea means subscription to all network areas. (NOTE 7), (NOTE 8)

ServiceExperience UeMobility

UeCommunication

QoSSustainability

AbnormalBehaviour

UserDataCongestion

NetworkPerformance

NsiLoadExt

maxTopAppUlNbr

Uinteger

O

0..1

Indicates the requested maximum number of top applications that contribute the most to the traffic in Uplink direction. If this attribute is present with value zero or undefined, means the maximum number is not limited.

UserDataCongestionExt

maxTopAppDlNbr

Uinteger

O

0..1

Indicates the requested maximum number of top applications that contribute the most to the traffic in Downlink direction. If this attribute is present with value zero or undefined, means the maximum number is not limited.

UserDataCongestionExt

nfInstanceIds

array(NfInstanceId)

O

1..N

Identification(s) of NF instances.

NfLoad

nfSetIds

array(NfSetId)

O

1..N

Identification(s) of NF instance sets.

NfLoad

nfTypes

array(NFType)

O

1..N

Identification(s) of NF types.

NfLoad

notificationMethod

NotificationMethod

O

0..1

Indicate the notification method. (NOTE 2)

nsiIdInfos

array(NsiIdInfo)

O

1..N

Each element identifies the S-NSSAI and the optionally associated network slice instance(s).

May be included when subscribed event is "NSI_LOAD_LEVEL" or

"SERVICE_EXPERIENCE".

(NOTE 1)

ServiceExperience

NsiLoad

NsiLoadExt

nsiLevelThrds

array(Uinteger)

O

1..N

Identifies the load threshold for each S-NSSAI or S-NSSAI and the optionally associated network slice instance identified by the "nsiIds" attribute within the "nsiIdInfos" attribute.

(NOTE 4)

NsiLoad

NsiLoadExt

qosRequ

QosRequirement

C

0..1

Indicates the QoS requirements. It shall be included when subscribed event is "QOS_SUSTAINABILITY".

QoSSustainability

qosFlowRetThds

array(RetainabilityThreshold)

C

1..N

Represents the QoS flow retainability thresholds.Shall be supplied for the 5QI ("5qi" in "qosRequ") or resource type ("resType" in "qosRequ") of GBR resource type. (NOTE 4)

QoSSustainability

ranUeThrouThds

array(BitRate)

C

1..N

Represents the RAN UE throughput thresholds.

Shall be supplied for the 5QI ("5qi" in "qosRequ") or resource type ("resType" in "qosRequ") of non-GBR resource type.(NOTE 4)

QoSSustainability

repetitionPeriod

DurationSec

C

0..1

Shall be supplied for notification Method "PERIODIC" by the "notificationMethod" attribute.

snssais

array(Snssai)

C

1..N

Identification(s) of network slice to which the subscription applies. (NOTE 1), (NOTE 8)

tgtUe

TargetUeInformation

O

0..1

Identifies target UE information

(NOTE 3)

congThresholds

array(ThresholdLevel)

C

1..N

Represents the congestion threshold levels. (NOTE 4)

UserDataCongestion

nwPerfRequs

array(NetworkPerfRequirement)

C

1..N

Represents the network performance requirements. This attribute shall be included when subscribed eventis "NETWORK_PERFORMANCE".

NetworkPerformance

bwRequs

array(BwRequirement)

O

1..N

Represents the bandwidth requirement for each application.

ServiceExperience

excepRequs

array(Exception)

C

1..N

Represents a list of Exception Ids with associated thresholds. May only be present when subscribed event is "ABNORMAL_BEHAVIOUR".

(NOTE 5, NOTE 6)

AbnormalBehaviour

exptAnaType

ExpectedAnalyticsType

C

0..1

Represents expected UE analytics type.

It shall not be present if the "excepRequs" attribute is provided. (NOTE 6)

AbnormalBehaviour

exptUeBehav

ExpectedUeBehaviourData

O

0..1

Represents expected UE behaviour.

AbnormalBehaviour

ratTypes

array(RatType)

O

1..N

Identification(s) of the RAT type which the subscription applies. (NOTE 9)

ServiceExperienceExt

freqs

array(ArfcnValueNR)

O

1..N

Idenfication(s) of the frequency of UE’s serving cell(s) where the subscription applies. (NOTE 9)

ServiceExperienceExt

listOfAnaSubsets

array(AnalyticsSubset)

O

1..N

The list of analytics subsets can be used to indicate the content of the analytics.

EneNA

NOTE 1: The "anySlice" attribute is not applicable to features "UeMobility" and "NetworkPerformance". The "snssais" attribute is not applicable to features "ServiceExperience", "NsiLoad", "UeMobility" and "NetworkPerformance". When subscribed event is "SLICE_LOAD_LEVEL", the identifications of network slices, either information about slice(s) identified by "snssais", or "anySlice" set to "TRUE" shall be included. When subscribed event is "QOS_SUSTAINABILITY", "NF_LOAD", "UE_COMM", "ABNORMAL_BEHAVIOUR" or "USER_DATA_CONGESTION", the identifications of network slices identified by "snssais" is optional. When subscribed event is "NSI_LOAD_LEVEL" or "SERVICE_EXPERIENCE", either the "nsiIdInfos" attribute or "anySlice" set to "TRUE" shall be included.

NOTE 2: When notificationMethod is not supplied, the default value is "THRESHOLD".

NOTE 3: Applicability is further described in the corresponding data type.

NOTE 4: This property shall be provided if the "notifMethod" in "evtReq" is set to "ON_EVENT_DETECTION" or "notificationMethod" in "eventSubscriptions" is set to "THRESHOLD" or omitted.

NOTE 5: Only "excepId" and "excepLevel" within the Exception data type apply to the "excepRequs" attribute within EventSubscription data type.

NOTE 6: Either "excepRequs" or "exptAnaType" shall be provided if subscribed event is "ABNORMAL_BEHAVIOUR".

NOTE 7: For "NETWORK_PERFORMANCE", "SERVICE_EXPERIENCE" or "USER_DATA_CONGESTION" event, this attribute shall be provided if the event applied for all UEs (i.e. "anyUe" attribute set to true within the "tgtUe" attribute). For "QOS_SUSTAINABILITY", this attribute shall be provided.

NOTE 8: For "ABNORMAL_BEHAVIOUR" event with "anyUe" attribute in "tgtUe" attribute sets to true,

– at least one of the "networkArea" and the "snssais" attribute should be included, if the expected analytics type via the"exptAnaType" attribute or the list of Exception Ids via the "excepRequs" attribute is mobility related;

– at least one of the "networkArea", "appIds", "dnns" and "snssais" attribute should be included, if the expected analytics type via the"exptAnaType" attribute or the list of Exception Ids via the "excepRequs" attribute is communication related;

– the expected analytics type via the"exptAnaType" attribute or the list of Exception Ids via "excepRequs" attribute shall not be requested for both mobility and communication related analytics at the same time.

NOTE 9: One or both of the property(ies) shall be provided when a consumer requires analytics for a UE or a group of UEs in an application or a set of applications over specific RAT type(s) and/or frequency(ies).

NOTE: Care shall be taken to avoid excessive signalling.

Editor’s Note: It’s FFS whether the "nfTypes", "nfSetIds", "nfInstanceIds" or "nfLoadLvlThds" attirbutes are applicable for the NsiLoadExt feature.

5.1.6.2.4 Type NnwdafEventsSubscriptionNotification

Table 5.1.6.2.4-1: Definition of type NnwdafEventsSubscriptionNotification

Attribute name

Data type

P

Cardinality

Description

Applicability

eventNotifications

array(EventNotification)

M

1..N

Notifications about Individual Events

subscriptionId

string

M

1

String identifying a subscription to the Nnwdaf_EventsSubscription Service

5.1.6.2.5 Type EventNotification

Table 5.1.6.2.5-1: Definition of type EventNotification

Attribute name

Data type

P

Cardinality

Description

Applicability

event

NwdafEvent

M

1

Event that is notified.

start

DateTime

O

0..1

It defines the start time of which the analytics information will become valid. (NOTE 1)

expiry

DateTime

O

0..1

It defines the expiration time after which the analytics information will become invalid. (NOTE 1)

timeStampGen

DateTime

O

0..1

It defines the timestamp of analytics generation.

failNotifyCode

NwdafFailureCode

C

0..1

Identifies the failure reason for the event notification.

It shall only be included if the event notification is failed or the analytics information is not ready. (NOTE 2)

EneNA

rvWaitTime

DateTime

O

0..1

UTC time indicating a recommended time which is used to determine the time when analytics information is needed in similar future event subscriptions. It may only be included if the "failNotifyCode" attribute sets to "UNSATISFIED_REQUESTED_ANALYTICS_TIME".

EneNA

anaMetaInfo

AnalyticsMetadataInfo

C

0..1

Contains information about analytics metadata required to aggregate the analytics. It shall be present if the "anaMeta" attribute was included in the subscription, containing the information indicated by the "anaMeta" attribute.

Aggregation

nwPerfs

array(NetworkPerfInfo)

C

1..N

The network performance information.

NetworkPerformance

nfLoadLevelInfos

array(NfLoadLevelInformation)

C

1..N

The NF load level information. When subscribed event is "NF_LOAD", the nfLoadLevelInfos shall be included.

NfLoad

nsiLoadLevelInfos

array(NsiLoadLevelInfo)

C

1..N

Each element identifies the load level information for each S-NSSAI and the optionally associated network slice instance.

Shall be included when subscribed event is "NSI_LOAD_LEVEL".

NsiLoad

NsiLoadExt

qosSustainInfos

array(QosSustainabilityInfo)

C

1..N

The QoS sustainability information.

When subscribed event is “QOS_SUSTAINABILITY”, the qosSustainInfos shall be included.

QoSSustainability

sliceLoadLevelInfo

SliceLoadLevelInformation

C

0..1

The slices and the load level information.

When subscribed event is "SLICE_LOAD_LEVEL", the sliceLoadLevelInfo shall be included.

svcExps

array(ServiceExperienceInfo)

C

1..N

The service experience information.

When subscribed event is "SERVICE_EXPERIENCE", the svcExps shall be included.

ServiceExperience

ueComms

array(UeCommunication)

C

1..N

The UE communication information.

When subscribed event is "UE_COMM", the ueComms shall be included.

UeCommunication

ueMobs

array(UeMobility)

C

1..N

The UE mobility information.

When subscribed event is "UE_MOBILITY", the ueMobs shall be included.

UeMobility

abnorBehavrs

array(AbnormalBehaviour)

C

1..N

The Abnormal Behaviour information.

When subscribed event is "ABNORMAL_BEHAVIOUR", the abnorBehavrs shall be included.

AbnormalBehaviour

userDataCongInfos

array(UserDataCongestionInfo)

C

1..N

The location and user data congestion information.

Shall be present if the subscribed event is "USER_DATA_CONGESTION".

UserDataCongestion

dnPerfInfos

array(DnPerfInfo)

C

1..N

The DN performance information.

Shall be present if the subscribed event is "DN_PERFORMANCE".

DnPerformance

NOTE 1: If the "start" attribute and the "expiry" attribute are both provided, the DateTime of the "expiry" attribute shall not be earlier than the DateTime of the "start" attribute.

NOTE 2: The values of "UNAVAILABLE_DATA" and "BOTH_STAT_PRED_NOT_ALLOWED" of the NwdafFailureCode data type are not applicable for the "failNotifyCode" attribute.

5.1.6.2.6 Type SliceLoadLevelInformation

Table 5.1.6.2.6-1: Definition of type SliceLoadLevelInformation

Attribute name

Data type

P

Cardinality

Description

Applicability

loadLevelInformation

LoadLevelInformation

M

1

Load level information which applies for each network slice identified by snssais.

snssais

array(Snssai)

M

1..N

Identification(s) of network slice to which the subscription applies.

numOfUes

NumberAverage

C

0..1

Indicates the number of UEs registered at the S-NSSAI and and optionally at the associated network slice instance.

Shall be present if the list of analytics subset indicates that the number of UE registered shall be included in the analytics.

EneNA

numOfPduSess

NumberAverage

C

0..1

Indicates the number of PDU sessions established at the S-NSSAI and optionally at the associated network slice instance.

Shall be present if the list of analytics subset indicates that the number of PDU sessions established shall be included in the analytics.

EneNA

exceedLoadLevelThrInd

boolean

C

0..1

Indicates whether the Load Level Threshold is met or exceeded by the statistics value. Set to "true" if the Load Level Threshold is met or exceeded, otherwise set to "false".

Shall be present if the list of analytics subset indicates that the indication of threshold being met or exceeded shall be included in the analytics.

EneNA

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction.

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

EneNA

5.1.6.2.7 Type EventReportingRequirement

Table 5.1.6.2.7-1: Definition of type EventReportingRequirement

Attribute name

Data type

P

Cardinality

Description

Applicability

accuracy

Accuracy

O

0..1

Preferred level of accuracy of the analytics.

startTs

DateTime

O

0..1

UTC time indicating the start time of the observation period.

The absence of this attribute means subscription at the present time unless the “offsetPeriod” attribute is included. (NOTE 3)

endTs

DateTime

O

0..1

UTC time indicating the end time of the observation period.

The absence of this attribute means subscription at the present time unless the “offsetPeriod” attribute is included.

If provided, it shall not be less than the start time. (NOTE 3)

offsetPeriod

integer

O

0..1

Offset period in units of seconds to the reporting time, if the value is negative means statistics in the past offset period, otherwise a positive value means prediction in the future offset period. May be present if the "repPeriod" attribute is included within the "evtReq" attribute. (NOTE m)

EneNA

sampRatio

SamplingRatio

O

0..1

Percentage of sampling (1%…100%) among impacted UEs.

Applicable to event targeting a group of UEs or any UE.

(NOTE 1)

maxSupiNbr

Uinteger

O

0..1

Represents the maximum number of SUPIs expected in an object.

Applicable for the event(s) providing a list of SUPIs during the analytics response.

maxObjectNbr

Uinteger

O

0..1

Maximum number of objects expected for an analytics report. It’s only applicable for the event(s) which may provide more than one entries or objects during event notification.

timeAnaNeeded

DateTime

O

0..1

UTC time indicating the time when analytcs information is needed. (NOTE 2)

anaMeta

array(AnalyticsMetadata)

O

1..N

List of analytics metadata that are requested to be included.

Aggregation

anaMetaInd

AnalyticsMetadataIndication

O

0..1

Contains values for the analytics metadata that the NF service consumer wants to be used for generating the analytics.

Aggregation

NOTE 1: The "sampRatio" attribute within EventReportingRequirement data type is not applicable for the Nnwdaf_EventsSubscription API.

NOTE 2: For the Nnwdaf_EventsSubscription API, the "timeAnaNeeded" attribute is only applicable when the feature EneNA is supported.

NOTE 3: When the "offsetPeriod" attribute is included, the "startTs" and "endTs" attributes shall not be included.

5.1.6.2.8 Type TargetUeInformation

Table 5.1.6.2.8-1: Definition of type TargetUeInformation

Attribute name

Data type

P

Cardinality

Description

Applicability

anyUe

boolean

O

0..1

Identifies any UE when setting to true.

ServiceExperience

NetworkPerformance

NfLoad

UserDataCongestion

AbnormalBehaviour

QoSSustainability

supis

array(Supi)

O

1..N

Identifies a SUPI for an UE.

(NOTE 2)

UeMobility

UeCommunication

NetworkPerformance

AbnormalBehaviour

UserDataCongestion

NfLoad

ServiceExperience

gpsis

array(Gpsi)

O

1..N

Identifies a GPSI for an UE.

UserDataCongestionExt

intGroupIds

array(GroupId)

O

1..N

Represents an internal group identifier and identifies a group of UEs.

(NOTE 2)

UeMobility

UeCommunication

NetworkPerformance

AbnormalBehaviour

ServiceExperience

NOTE 1: For an applicable feature or UserDataCongestion and UserDataCongestionExt features are both applicable, only one attribute identifying the target UE shall be provided.

NOTE 2: Only one element in the attribute shall be provided for the applicable events except the "SERVICE_EXPERIENCE" event.

5.1.6.2.9 Void
5.1.6.2.10 Type UeMobility

Table 5.1.6.2.10-1: Definition of type UeMobility

Attribute name

Data type

P

Cardinality

Description

Applicability

ts

DateTime

O

0..1

This attribute identifies the timestamp when the UE arrives the location. (NOTE 1)

recurringTime

ScheduledCommunicationTime

O

0..1

Identifies time of the day and day of the week which are valid within the observation period when the UE moves. (NOTE 1, NOTE 2)

duration

DurationSec

M

1

This attribute identifies the time duration the UE stays in the location.

If the analytics result applies for a group of UEs, it indicates the average duration for the group of UEs.

durationVariance

Float

C

0..1

This attribute indicates the variance of the analysed durations for the group of UEs. It shall be provided if the analytics result applies for a group of UEs.

locInfos

array(LocationInfo)

M

1..N

This attribute includes a list of UE location information during the time duration.

NOTE 1: Either ts or recurringTime shall be provided.

NOTE 2: If this attribute is present, it indicates the UE movement is periodic. This attribute is suitable to be present for a recurring mobility in a long observation time.

5.1.6.2.11 Type LocationInfo

Table 5.1.6.2.11-1: Definition of type LocationInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

loc

UserLocation

M

1

This attribute contains the detailed location, the ueLocationTimestamp attribute in the 3GPP access type of UserLocation data type shall not be provided.

ratio

SamplingRatio

C

0..1

This attribute contains the percentage of UEs with same analytics result in the group.

Shall be present if the analytics result applies for a group of UEs.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

5.1.6.2.12 Void
5.1.6.2.13 Type UeCommunication

Table 5.1.6.2.13-1: Definition of type UeCommunication

Attribute name

Data type

P

Cardinality

Description

Applicability

commDur

DurationSec

M

0..1

Identifies the duration of the communication.

If the analytics result applies for a group of UEs, it indicates the average duration for the subset of UEs indicated by a given ratio in the group.

commDurVariance

Float

C

0..1

This attribute indicates the variance of the analysed durations for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs.

perioTime

DurationSec

O

0..1

Identifies interval time of periodic communication, e.g. every 10 minutes or 1 hour. (NOTE 2)

If the analytics result applies for a group of UEs, it indicates the average interval time of periodic communication for the subset of UEs indicated by a given ratio in the group.

perioTimeVariance

Float

C

0..1

This attribute indicates the variance of the analysed intervals of periodic communication for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs.

ts

DateTime

C

0..1

Identifies the start time of the communication. (NOTE 1)

tsVariance

Float

O

0..1

This attribute indicates the variance of the analysed start time for the subset of UEs indicated by a given ratio in the group. It may only be provided if the ts attribute is provided.

recurringTime

ScheduledCommunicationTime

C

0..1

Identifies time of the day and day of the week which are valid within the observation period when the UE has communication. Providing the end time in ScheduledCommunicationTime data type is not required. (NOTE 1, NOTE 3)

trafChar

TrafficCharacterization

M

1

Identifies the detailed traffic characterization.

ratio

SamplingRatio

C

0..1

This attribute contains the percentage of UEs with same analytics result in the group.

Shall be present if the analytics result applies for a group of UEs.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE 4)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

NOTE 1: Either ts or recurringTime shall be provided.

NOTE 2: If this attribute is present, it indicates the communication is periodic and its value shall be larger than the commDur value. If this attribute is present with the ts attribute, it indicates the periodic communication time valid within the observation period; if it is present with the recurringTime attribute, it indicates the periodic communication time valid within the day(s).

NOTE 3: If this attribute is present, it indicates the communication is periodic. This attribute is suitable to be present for a recurring communication in a long observation time.

NOTE 4: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

5.1.6.2.14 Type TrafficCharacterization

Table 5.1.6.2.14-1: Definition of type TrafficCharacterization

Attribute name

Data type

P

Cardinality

Description

Applicability

appId

ApplicationId

O

0..1

Contains the application identifier.

dnn

Dnn

O

0..1

Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.

Shall be present if the "dnns" was provided within EventSubscription during the subscription for event notification procedure.

snssai

Snssai

C

0..1

Identifies the network slice.

Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure.

fDescs

array(IpEthFlowDescription)

O

1..2

Contains the flow description for the Uplink and/or Downlink flows.

ulVol

Volume

O

0..1

Identifies the uplink traffic volume. (NOTE)

If the analytics result applies for a group of UEs, it indicates the average uplink traffic volume for the subset of UEs indicated by a given ratio in the group.

ulVolVariance

Float

C

0..1

This attribute indicates the variance of the uplink traffic volumes for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs.

dlVol

Volume

O

0..1

Identifies the downlink traffic volume. (NOTE)

If the analytics result applies for a group of UEs, it indicates the average downlink traffic volume for the subset of UEs indicated by a given ratio in the group.

dlVolVariance

Float

C

0..1

This attribute indicates the variance of the downlink traffic volumes for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs.

NOTE: At least one of ulVol or dlVol shall be provided.

5.1.6.2.15 Type AbnormalBehaviour

Table 5.1.6.2.15-1: Definition of type AbnormalBehaviour

Attribute name

Data type

P

Cardinality

Description

Applicability

supis

array(Supi)

C

1..N

Each element identifies a UE which is affected with the Exception.

Shall be present if the subscription request applies to more than one UE.

dnn

Dnn

C

0..1

Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.

Shall be present if the "dnns" was provided within EventSubscription during the subscription for event notification procedure.

excep

Exception

M

1

Contains the exception information.

snssai

Snssai

C

0..1

Identifies the network slice information.

Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure.

ratio

SamplingRatio

C

0..1

Contains the percentage of UEs with same analytics result in the group or among all UEs.

Shall be present if the analytics result applies for a group of UEs or any UE.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

addtMeasInfo

AdditionalMeasurement

O

0..1

Additional measurement.

NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

5.1.6.2.16 Type Exception

Table 5.1.6.2.16-1: Definition of type Exception

Attribute name

Data type

P

Cardinality

Description

Applicability

excepId

ExceptionId

M

1

Indicating the Exception ID.

excepLevel

integer

O

0..1

Measured level, compared to the threshold

excepTrend

ExceptionTrend

O

0..1

Measured trend

5.1.6.2.17 Type UserDataCongestionInfo

Table 5.1.6.2.17-1: Definition of type UserDataCongestionInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

networkArea

NetworkAreaInfo

M

1

Identification of network area to which the subscription applies.

congestionInfo

CongestionInfo

M

1

The congestion information of the specific location.

snssai

Snssai

C

0..1

Identifies an S-NSSAI.

Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure.

5.1.6.2.18 Type CongestionInfo

Table 5.1.6.2.18-1: Definition of type CongestionInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

congType

CongestionType

M

1

Identification congestion analytics type.

timeIntev

TimeWindow

M

1

Represents a start time and a stop time requested for the congestion information.

nsi

ThresholdLevel

M

1

Network Status Indication.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

topAppListUl

array(TopApplication)

C

0..N

List of top applications in Uplink. Shall be present if the "maxTopAppUlNbr" attribute is included in the event subscription or analytics request with the value of maximum number of the array instances.

UserDataCongestionExt

topAppListDl

array(TopApplication)

C

0..N

List of top applications in Downlink. Shall be present if the "maxTopAppDlNbr" attribute is included and set to true in the event subscription or analytics request with the value of the maximum number of the array instances.

UserDataCongestionExt

NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

5.1.6.2.19 Type QosSustainabilityInfo

Table 5.1.6.2.19-1: Definition of type QosSustainabilityInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

areaInfo

NetworkAreaInfo

M

1

Identification(s) of applicable location areas to which the subscription.

startTs

DateTime

M

1

Represents the start time of the applicable observing period.

endTs

DateTime

M

1

Represents the end time of the applicable observing period.

qosFlowRetThd

RetainabilityThreshold

O

0..1

The reporting QoS Flow Retainability Threshold that are met or crossed for 5QI of GBR resource type.

(NOTE 1)

ranUeThrouThd

BitRate

O

0..1

The reporting RAN UE Throughput Threshold that are met or crossed for 5QI of non-GBR resource type.

(NOTE 1)

snssai

Snssai

C

0..1

Identifies an S-NSSAI.

Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE 2)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

NOTE 1: Either qosFlowRetThd or ranUeThrouThd shall be provided.

NOTE 2: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

5.1.6.2.20 Type QosRequirement

Table 5.1.6.2.20-1: Definition of type QosRequirement

Attribute name

Data type

P

Cardinality

Description

Applicability

5qi

5Qi

C

1

Represents a 5G QoS Identifier. It shall be included for standardized or preconfigured 5QIs. (NOTE)

gfbrUl

BitRate

C

0..1

Indicates GFBR in the uplink.

It shall be included for GBR 5QIs.

gfbrDl

BitRate

C

0..1

Indicates GFBR in the downlink.

It shall be included for GBR 5QIs.

resType

QosResourceType

C

0..1

Resource type.

Shall be provided for the non-standardized and non-preconfigured QoS characteristics. (NOTE)

pdb

PacketDelBudget

C

0..1

Packet Delay Budget.

May be supplied for the non-standardized and non-pre-configured QoS characteristics.

per

PacketErrRate

C

0..1

Packet Error Rate.

May be supplied for the non-standardized and non-pre-configured QoS characteristics.

NOTE: Either 5QI within "5qi" attribute or the resource type within "resType" attribute shall be provided.

5.1.6.2.21 Type RetainabilityThreshold

Table 5.1.6.2.21-1: Definition of type RetainabilityThreshold

Attribute name

Data type

P

Cardinality

Description

Applicability

relFlowNum

Uinteger

O

0..1

Represents the number of abnormally released QoS flows. (NOTE)

relTimeUnit

TimeUnit

C

0..1

Represents the unit for the session active time, shall be present if relFlowNum is present. (NOTE)

relFlowRatio

SamplingRatio

O

0..1

Represents the ratio of abnormally released QoS flows to the total released QoS flows, expressed in percentage. (NOTE)

NOTE: Either relFlowNum and its associated relTimeUnit or relFlowRatio shall be provided. relFlowNum and relTimeUnit together represents the number of abnormally released QoS flows (i.e. relFlowNum) within the time unit (i.e. relTimeUnit).

5.1.6.2.22 Type NetworkPerfRequirement

Table 5.1.6.2.22-1: Definition of type NetworkPerfRequirement

Attribute name

Data type

P

Cardinality

Description

Applicability

nwPerfType

NetworkPerfType

M

1

The type of the network performance.

relativeRatio

SamplingRatio

C

0..1

The relative ratio expressed in percentage. (NOTE)

absoluteNum

Uinteger

C

0..1

The absolute number (NOTE)

NOTE: Either relativeRatio or absoluteNum shall be provided if the "notifMethod" in "evtReq" is set to "ON_EVENT_DETECTION" or "notificationMethod" in "eventSubscriptions" is set to "THRESHOLD" or omitted.

5.1.6.2.23 Type NetworkPerfInfo

Table 5.1.6.2.23-1: Definition of type NetworkPerfInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

networkArea

NetworkAreaInfo

M

1

Identification of network area to which the subscription applies.

nwPerfType

NetworkPerfType

M

1

The type of the network performance

relativeRatio

SamplingRatio

O

0..1

The reported relative ratio expressed in percentage. (NOTE 1)

absoluteNum

Uinteger

O

0..1

The reported absolute number (NOTE 1)

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE 2)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

NOTE 1: Either relativeRatio or absoluteNum shall be provided.

NOTE 2: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

5.1.6.2.24 Type ServiceExperienceInfo

Table 5.1.6.2.24-1: Definition of type ServiceExperienceInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

svcExprc

SvcExperience

M

1

Service experience

svcExprcVariance

Float

O

0..1

This attribute indicates the variance .

supis

array(Supi)

O

1..N

Each element identifies a UE.

May only be present if the subscription request applies to more than one UE.

snssai

Snssai

C

0..1

Identifies an S-NSSAI.

Shall be presented if the "snssais" was provided within EventSubscription during the subscription for event notification procedure.

appId

ApplicationId

C

0..1

Identifies an application.

Shall be present if the "appIds" was provided within EventSubscription during the subscription for event notification procedure.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

dnn

Dnn

C

0..1

Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.

Shall be present if the "dnns" was provided within EventSubscription during the subscription for event notification procedure.

networkArea

NetworkAreaInfo

C

0..1

Identifies the network area where the service experience applies. Shall be presented if the "networkArea" was provided within EventSubscription during the subscription for event notification procedure.

nsiId

NsiId

C

0..1

Identifies a network slice instance which is associated with the S-NSSAI identified by the "snssai" attribute.

Shall be presented if the "nsiIds" was provided within the NsiIdInfo data in the EventSubscription data during the subscription.

ratio

SamplingRatio

C

0..1

Contains the percentage of UEs with same analytics result in the group or among all UEs.

Shall be present if the analytics result applies for a group of UEs or any UE.

ratType

RatType

O

0..1

Identifies the RAT type which the application service experience analytics applies.

ServiceExperienceExt

frequency

ArfcnValueNR

O

0..1

Identifies the carrier frequency of UE’s serving cell(s) where the application service experience analytics applies.

ServiceExperienceExt

NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

5.1.6.2.25 Type BwRequirement

Table 5.1.6.2.25-1: Definition of type BwRequirement

Attribute name

Data type

P

Cardinality

Description

Applicability

appId

ApplicationId

M

1

Represents an application.

(NOTE)

marBwUl

BitRate

O

0..1

Maximum requested bandwidth for the Uplink.

marBwDl

BitRate

O

0..1

Maximum requested bandwidth for the Downlink.

mirBwUl

BitRate

O

0..1

Minimum requested bandwidth for the Uplink.

mirBwDl

BitRate

O

0..1

Minimum requested bandwidth for the Downlink.

NOTE: If the "appIds" attribute is provided within EventSubscription data, this attribute shall be indicated by the "appIds" attribute.

5.1.6.2.26 Type AdditionalMeasurement

Table 5.1.6.2.26-1: Definition of type AdditionalMeasurement

Attribute name

Data type

P

Cardinality

Description

Applicability

unexpLoc

NetworkAreaInfo

C

0..1

The unexpected locations which the UE stays.

It may only be present when the "excepId" within the Exception data sets to "UNEXPECTED_UE_LOCATION"

unexpFlowTeps

array(IpEthFlowDescription)

C

1..N

Unexpected IP or Ethernet flow templates.

It may only be present when the "excepId" within the Exception data sets to "UNEXPECTED_LONG_LIVE_FLOW" or "UNEXPECTED_LARGE_RATE_FLOW".

unexpWakes

array(DateTime)

C

1..N

Unexpected wake up times.

It may only be present when the "excepId" within the Exception data sets to "UNEXPECTED_WAKEUP".

ddosAttack

AddressList

C

0..1

Victim’s address list.

It may only be present when the "excepId" within the Exception data sets to "SUSPICION_OF_DDOS_ATTACK".

wrgDest

AddressList

C

0..1

Wrong destination address list.

It may only be present when the "excepId" within the Exception data sets to "WRONG_DESTINATION_ADDRESS".

circums

array(CircumstanceDescription)

C

1..N

The description of circumstances.

It may only be present when the "excepId" within the Exception data sets to "TOO_FREQUENT_SERVICE_ACCESS", "UNEXPECTED_RADIO_LINK_FAILURES" or "PING_PONG_ACROSS_CELLS".

5.1.6.2.27 Type IpEthFlowDescription

Table 5.1.6.2.27-1: Definition of type FlowDescription

Attribute name

Data type

P

Cardinality

Description

Applicability

ipTrafficFilter

FlowDescription

O

0..1

Identifies IP packet filter.(NOTE)

ethTrafficFilter

EthFlowDescription

O

0..1

Identifies Ethernet packet filter.(NOTE)

NOTE: Either "ipTrafficFilter" or "ethTrafficFilter" shall be provided.

5.1.6.2.28 Type AddressList

Table 5.1.6.2.28-1: Definition of type AddressList

Attribute name

Data type

P

Cardinality

Description

Applicability

ipv4Addrs

array(Ipv4Addr)

O

1..N

Each element identifies an IPv4 address.

ipv6Addrs

array(Ipv6Addr)

O

1..N

Each element identifies an IPv6 address.

NOTE: At least one of "ipv4Addrs" or "ipv6Addrs" shall be provided.

5.1.6.2.29 Type CircumstanceDescription

Table 5.1.6.2.29-1: Definition of type CircumstanceDescription

Attribute name

Data type

P

Cardinality

Description

Applicability

freq

Float

O

0..1

Communication frequency of the UE in units of MHz.

tm

DateTime

O

0..1

Time when UE enters the location.

locArea

NetworkAreaInfo

C

0..1

The location of the UE.

It shall be present when the "excepId" within the Exception data sets to "UNEXPECTED_RADIO_LINK_FAILURES" or "PING_PONG_ACROSS_CELLS".

vol

Volume

C

0..1

The traffic volume.

It shall be present when the "excepId" within the Exception data sets to "TOO_FREQUENT_SERVICE_ACCESS" or "UNEXPECTED_LARGE_RATE_FLOW ".

5.1.6.2.30 Type ThresholdLevel

Table 5.1.6.2.30 -1: Definition of type ThresholdLevel

Attribute name

Data type

P

Cardinality

Description

Applicability

congLevel

integer

C

0..1

Value of Congestion that triggers notification (NOTE 1)

UserDataCongestion

nfLoadLevel

integer

C

0..1

Value of NF Load that triggers notification (NOTE 2)

NfLoad

nfCpuUsage

integer

C

0..1

Value of NF CPU Usage that triggers notification (NOTE 2)

NfLoad

nfMemoryUsage

integer

C

0..1

Average usage of memory (NOTE 2)

NfLoad

nfStorageUsage

integer

C

0..1

Average usage of storage (NOTE 2)

NfLoad

NOTE 1: This attribute shall be provided when subscribed event is "USER_DATA_CONGESTION".

NOTE 2: At least one attribute should be provided when subscribed event is "NF_LOAD".

5.1.6.2.31 Type NfLoadLevelInformation

Table 5.1.6.2.31-1: Definition of type NfLoadLevelInformation

Attribute name

Data type

P

Cardinality

Description

Applicability

nfType

NFType

M

1

Type of the NF instance

nfInstanceId

NfInstanceId

M

1

Identification of the NF instance

nfSetId

NfSetId

O

0..1

Identification of the NF instance set

nfStatus

NfStatus

O

0..1

Availability status of the NF

nfCpuUsage

integer

C

0..1

Average usage CPU (NOTE 1) (NOTE 2)

nfMemoryUsage

integer

C

0..1

Average usage of memory (NOTE 1) (NOTE 2)

nfStorageUsage

integer

C

0..1

Average usage of storage (NOTE 1) (NOTE 2)

nfLoadLevelAverage

integer

C

0..1

Average load information (NOTE 1) (NOTE 2)

nfLoadLevelPeak

integer

O

0..1

Peak load information(NOTE 2)

snssai

Snssai

C

0..1

Identifies an S-NSSAI.

Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE 3)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

NOTE 1: At least one value shall be provided.

NOTE 2: The values are percentages which are provided as estimated over a given period.

NOTE 3: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

5.1.6.2.32 Type NfStatus

Table 5.1.6.2.32-1: Definition of type NfStatus

Attribute name

Data type

P

Cardinality

Description

Applicability

statusRegistered

SamplingRatio

C

0..1

Percentage of time with status “registered” (NOTE)

statusUnregistered

SamplingRatio

C

0..1

Percentage of time with status “unregistered” (NOTE)

statusUndiscoverable

SamplingRatio

C

0..1

Percentage of time with status “undiscoverable” (NOTE)

NOTE: The availability statuses of the NF on the Analytics target period are expressed as a percentage of time. The total of status values should be equal or lower than 100%. At least one value shall be provided.

5.1.6.2.33 Type NsiIdInfo

Table 5.1.6.2.33-1: Definition of type NsiIdInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

snssai

Snssai

M

1

Identification of network slice to which the subscription for event notification procedure applies.

nsiIds

array(NsiId)

O

1..N

Identification of network slice instance(s) associated with the subscribed S-NSSAI identified by the "snssai" attribute.

May be included when subscribed event is "NSI_LOAD_LEVEL" or

"SERVICE_EXPERIENCE".

(NOTE)

NOTE: This attribute is not applicable when the NF service consumer is CEF or PCF.

5.1.6.2.34 Type NsiLoadLevelInfo

Table 5.1.6.2.34-1: Definition of type NsiLoadLevelInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

loadLevelInformation

LoadLevelInformation

M

1

Load level information of the network slice identified by the "snssai" attribute and if provided, the associated NSI ID identified by the "nsiId" attribute.

snssai

Snssai

M

1

Identification of network slice to which the subscription applies.

nsiId

NsiId

C

0..1

Identification of network slice instance associated with the S-NSSAI identified by the "snssai" attribute.

Shall be presented if the "nsiIds" attribute was provided within the NsiIdInfo data in the EventSubscription data during the subscription.

resUsage

ResourceUsage

C

0..1

The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance.

Shall be present if the list of analytics subset indicates that the resource usage shall be included in the analytics.

NsiLoadExt

numOfExceedLoadLevelThr

integer

C

0..1

Indicates the number of times the resource usage threshold of the network slice instance is reached or exceeded if a threshold value is provided by the consumer.

Shall be present if the list of analytics subset indicates that the number of times the resource usage threshold of the network slice instance being reached or exceeded shall be include in the analytics.

NsiLoadExt

exceedLoadLevelThrInd

boolean

C

0..1

Indicates whether the Load Level Threshold is met or exceeded by the statistics value. Set to "true" if the Load Level Threshold is met or exceeded, otherwise set to "false".

Shall be present if the list of analytics subset indicates that the indication of threshold being met or exceeded shall be included in the analytics.

NsiLoadExt

networkArea

NetworkAreaInfo

O

0..1

Identification of network area to which the subscription applies.

NsiLoadExt

timePeriod

TimeWindow

O

0..1

Indicates a start time and a stop time of the load level information identified by the "loadLevelInformation" attribute.

NsiLoadExt

numOfUes

NumberAverage

O

0..1

Indicates the number of UE registrations at the S-NSSAI and the optionally associated network slice instance.

NsiLoadExt

numOfPduSess

NumberAverage

O

0..1

Indicates the number of PDU session establishments at the S-NSSAI and the optionally associated network slice instance.

NsiLoadExt

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE Y)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

NsiLoadExt

NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

Editor’s Note: It’s FFS that whether the "numOfUes" and "numOfPduSess" attirbutes are optional or conditional provided under the new NsiLoadExt feature.

Editor’s Note: It’s FFS that whether the "timePeriod" attribute is a time interval or time duration for the load level information of the network slice (instance).

Editor’s Note: It’s FFS to implement the "Resource usage threshold crossings time period".

5.1.6.2.35 Type FailureEventInfo

Table 5.1.6.2.35-1: Definition of type FailureEventInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

event

NwdafEvent

M

1

Event that is subscribed.

failureCode

NwdafFailureCode

M

1

Identifies the failure reason

5.1.6.2.36 Type AnalyticsMetadataIndication

Table 5.1.6.2.36-1: Definition of type AnalyticsMetadataIndication

Attribute name

Data type

P

Cardinality

Description

Applicability

dataWindow

TimeWindow

O

0..1

Data time window of the data samples.

dataStatProps

array(DatasetStatisticalProperty)

O

1..N

List of dataset statistical properties of the data to be used to generate the analytics.

strategy

OutputStrategy

O

0..1

Output strategy to be used for the reporting of the analytics.

aggrNwdafIds

array(NfInstanceId)

O

1..N

NWDAF identifiers of NWDAF instances used by the NWDAF service consumer when aggregating multiple analytics subscriptions.

5.1.6.2.37 Type AnalyticsMetadataInfo

Table 5.1.6.2.37-1: Definition of type AnalyticsMetadataInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

numSamples

Uinteger

O

0..1

Number of data samples used for the generation of the output analytics.

dataWindow

TimeWindow

O

0..1

Data time window of the data samples.

dataStatProps

array(DatasetStatisticalProperty)

O

1..N

List of dataset statistical properties of the data used to generate the analytics.

strategy

OutputStrategy

O

0..1

Output strategy used for the reporting of the analytics.

accuracy

Accuracy

O

0..1

Level of accuracy reached for the analytics.

5.1.6.2.38 Type NumberAverage

Table 5.1.6.2.38-1: Definition of type NumberAverage

Attribute name

Data type

P

Cardinality

Description

Applicability

number

integer

M

1

The average number.

variance

Float

M

1

Identifies the variance.

5.1.6.2.39 Type TopApplication

Table 5.1.6.2.39-1: Definition of type TopApplication

Attribute name

Data type

P

Cardinality

Description

Applicability

appId

ApplicationId

C

0..1

Indicates an application identifier.

(NOTE)

ipTrafficFilter

FlowInfo

C

0..1

Identifies IP packet filter. (NOTE)

ratio

SamplingRatio

O

0..1

The application’s throughput as a percentage of the total throughput in the Area of Interest.

NOTE: Either "appId" or "ipTrafficFilter" shall be provided.

5.1.6.2.40 Type AnalyticsSubscriptionsTransfer

Table 5.1.6.2.40-1: Definition of type AnalyticsSubscriptionsTransfer

Attribute name

Data type

P

Cardinality

Description

Applicability

subsTransInfos

array(SubscriptionTransferInfo)

M

1..N

Contains information about the subscription(s) that are requested to be transferred.

5.1.6.2.41 Type SubscriptionTransferInfo

Table 5.1.6.2.41-1: Definition of type SubscriptionTransferInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

transReqType

TransferRequestType

M

1

Indicates the type of the transfer request (i.e. if it is a request for transfer preparation or transfer execution)

nwdafEvSub

NnwdafEventsSubscription

M

1

Contains information about the analytics subscription that is to be transferred.

consumerId

NfInstanceId

M

1

NF instance identifer of the consumer of the analytics subscription that is to be transferred.

contextId

AnalyticsContextIdentifier

O

0..1

Identifier of analytics context information available at the NF service consumer.

sourceNfIds

array(NfInstanceId)

O

1..N

NF instance identifer(s) of active data source(s) the NF service consumer is currently using for the analytics of the subscription that is to be transferred.

sourceSetIds

array(NfSetId)

O

1..N

NF set identifer(s) of active data source(s) the NF service consumer is currently using for the analytics of the subscription that is to be transferred.

modelInfo

array(ModelInfo)

O

1..N

Contains information identifying the ML model(s) that the NF service consumer is currently using for the analytics.

modelProvIds

array(NfInstanceId)

O

1..N

NF instance identifer(s) of the ML model provider NWDAF(s) from which the NF service consumer currently subscribes to the ML model information used for the analytics.

5.1.6.2.42 Type ModelInfo

Table 5.1.6.2.42-1: Definition of type ModelInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

analyticsId

NwdafEvent

M

1

Type of analytics for which this ML model is used.

mlFileAddr

Uri

M

1

Address of ML model file.

5.1.6.2.43 Type AnalyticsContextIdentifier

Table 5.1.6.2.43-1: Definition of type AnalyticsContextIdentifier

Attribute name

Data type

P

Cardinality

Description

Applicability

subscriptionId

string

M

1

Identifies a subscription to the Nnwdaf_EventsSubscription Service.

nfAnaCtxts

array(NwdafEvent)

O

1..N

List of analytics types for which NF related analytics contexts can be retrieved. (NOTE)

ueAnaCtxts

array(UeAnalyticsContextDescriptor)

O

1..N

List of objects that indicate for which SUPI and analytics types combinations analytics context can be retrieved. (NOTE)

NOTE: At least one of "nfAnaCtxt" and "ueAnaCtxt" shall be provided.

5.1.6.2.44 Type UeAnalyticsContextDescriptor

Table 5.1.6.2.44-1: Definition of type UeAnalyticsContextDescriptor

Attribute name

Data type

P

Cardinality

Description

Applicability

supi

Supi

M

1

SUPI of the UE for which analytics context can be retrieved.

anaTypes

array(NwdafEvent)

M

1..N

List of analytics types for which UE related analytics contexts can be retrieved.

5.1.6.2.45 Type DnPerfInfo

Table 5.1.6.2.45-1: Definition of type DnPerfInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

appId

ApplicationId

O

0..1

Indicates an application identifier.

dnn

Dnn

C

0..1

Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.

Shall be present if the "dnns" was provided within EventSubscription during the subscription for event notification procedure.

snssai

Snssai

C

0..1

Identifies the network slice information.

Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure.

dnPerf

array(DnPerf)

M

1..N

List of DN performances for the application.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE 1)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

NOTE 1: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

Editor’s Note: It is FFS to resolve the stage 2 restriction that the "dnn"attribute and "snssai" attribute shall not be included if the consumer of this analytics type is an untrusted AF.

5.1.6.2.46 Type DnPerf

Table 5.1.6.2.46-1: Definition of type DnPerf

Attribute name

Data type

P

Cardinality

Description

Applicability

appServerInsAddr

AddrFqdn

O

0..1

Represents the Application Server Instance (IP address/FQDN of the Application Server).

upfId

string

O

0..1

Identifies the UPF.

dnai

Dnai

O

0..1

Indicates the DN Access Identifier representing location of the service flow.

perfData

PerfData

M

1

Represents the performance data.

spatialValidCon

NetworkAreaInfo

O

0..1

Represents the area where the DN performance analytics applies.

temporalValidCon

TimeWindow

O

0..1

Represents the valid period for the DN performance analytics.

Editor’s Note: It is FFS to resolve the stage 2 restriction that the " upfId "attribute shall not be included if the consumer of this analytics type is an AF.

5.1.6.2.47 Type PerfData

Table 5.1.6.2.47-1: Definition of type PerfData

Attribute name

Data type

P

Cardinality

Description

Applicability

avgTrafficRate

BitRate

O

0..1

Indicates average traffic rate.

maxTrafficRate

BitRate

O

0..1

Indicates maximum traffic rate.

avePacketDelay

PacketDelBudget

O

0..1

Indicates average Packet Delay.

maxPacketDelay

PacketDelBudget

O

0..1

Indicates maximum Packet Delay.

avgPacketLossRate

PacketLossRate

O

0..1

Indicates average Loss Rate.

5.1.6.2.48 Type ResourceUsage

Table 5.1.6.2.48-1: Definition of type ResourceUsage

Attribute name

Data type

P

Cardinality

Description

Applicability

cpuUsage

Uinteger

O

0..1

Average usage of virtual CPU.

(NOTE)

memoryUsage

Uinteger

O

0..1

Average usage of memory.

(NOTE)

storageUsage

Uinteger

O

0..1

Average usage of storage.

(NOTE)

NOTE: The values are percentages which are provided as estimated over a given period.

5.1.6.2.49 Type ConsumerNfInformation

Table 5.1.6.2.49-1: Definition of type ConsumerNfInformation

Attribute name

Data type

P

Cardinality

Description

Applicability

nfId

NfInstanceId

O

0..1

Identifies the analytics consumer NF instance. (NOTE)

taiList

array(Tai)

O

1..N

The list of TAIs the analytics consumer NF can serve. (NOTE)

NOTE: Either "nfId" or "taiList" shall be provided.

Editor’s Note: It is FFS whether the NF ID can be implemented as NfInstanceId.

5.1.6.3 Simple data types and enumerations

5.1.6.3.1 Introduction

This subclause defines simple data types and enumerations that can be referenced from data structures defined in the previous subclauses.

5.1.6.3.2 Simple data types

The simple data types defined in table 5.1.6.3.2-1 shall be supported.

Table 5.1.6.3.2-1: Simple data types

Type Name

Type Definition

Description

Applicability

AnySlice

boolean

"FALSE" represents not applicable for all slices.

"TRUE" represents applicable for all slices.

LoadLevelInformation

integer

Load level information of the network slice and the optionally associated network slice instance.

5.1.6.3.3 Enumeration: NotificationMethod

Table 5.1.6.3.3-1: Enumeration NotificationMethod

Enumeration value

Description

Applicability

PERIODIC

The subscription of NWDAF Event is peridodicly. The periodic of the notification is identified by repetitionPeriod defined in subclause 5.1.6.2.3.

THRESHOLD

The subscription of NWDAF Event is upon threshold exceeded.

5.1.6.3.4 Enumeration: NwdafEvent

Table 5.1.6.3.4-1: Enumeration NwdafEvent

Enumeration value

Description

Applicability

NF_LOAD

Indicates that the event subscribed is NF Load.

NfLoad

QOS_SUSTAINABILITY

Indicates that the event subscribed is QoS sustainability.

QoSSustainability

SLICE_LOAD_LEVEL

Indicates that the event subscribed is load level information of Network Slice

SERVICE_EXPERIENCE

Indicates that the event subscribed is service experience.

ServiceExperience

UE_MOBILITY

Indicates that the event subscribed is UE mobility information.

UeMobility

UE_COMM

Indicates that the event subscribed is UE communication information.

UeCommunication

ABNORMAL_BEHAVIOUR

Indicates that the event subscribed is abnormal behaviour information.

AbnormalBehaviour

USER_DATA_CONGESTION

Indicates that the event subscribed is user data congestion information

UserDataCongestion

NETWORK_PERFORMANCE

Indicates that the event subscribed is network performance information

NetworkPerformance

NSI_LOAD_LEVEL

Indicates that the event subscribed is load level information of Network Slice and the optionally associated Network Slice Instance

NsiLoad

5.1.6.3.5 Enumeration: Accuracy

Table 5.1.6.3.5-1: Enumeration Accuracy

Enumeration value

Description

Applicability

LOW

Low accuracy.

HIGH

High accuracy.

5.1.6.3.6 Enumeration: ExceptionId

Table 5.1.6.3.6-1: Enumeration ExceptionId

Enumeration value

Description

Applicability

UNEXPECTED_UE_LOCATION

Unexpected UE location

UNEXPECTED_LONG_LIVE_FLOW

Unexpected long-live rate flows

UNEXPECTED_LARGE_RATE_FLOW

Unexpected large rate flows

UNEXPECTED_WAKEUP

Unexpected wakeup

SUSPICION_OF_DDOS_ATTACK

Suspicion of DDoS attack

WRONG_DESTINATION_ADDRESS

Wrong destination address

TOO_FREQUENT_SERVICE_ACCESS

Too frequent Service Access

UNEXPECTED_RADIO_LINK_FAILURES

Unexpected radio link failures

PING_PONG_ACROSS_CELLS

Ping-ponging across neighbouring cells

5.1.6.3.7 Enumeration: ExceptionTrend

Table 5.1.6.3.7-1: Enumeration ExceptionTrend

Enumeration value

Description

Applicability

UP

Up trend of the exception level.

DOWN

Down trend of the exception level.

UNKNOWN

Unknown trend of the exception level.

STABLE

Stable trend of the exception level.

5.1.6.3.8 Enumeration: CongestionType

Table 5.1.6.3.8-1: Enumeration CongestionType

Enumeration value

Description

Applicability

USER_PLANE

The congestion analytics type is User Plane.

CONTROL_PLANE

The congestion analytics type is Control Plane.

USER_AND_CONTROL_PLANE

The congestion analytics type is User Plane and Control Plane.

5.1.6.3.9 Enumeration: TimeUnit

Table 5.1.6.3.9-1: Enumeration TimeUnit

Enumeration value

Description

Applicability

MINUTE

Time unit is per minute.

HOUR

Time unit is per hour.

DAY

Time unit is per day.

5.1.6.3.10 Enumeration: NetworkPerfType

Table 5.1.6.3.10-1: Enumeration NetworkPerfType

Enumeration value

Description

Applicability

GNB_ACTIVE_RATIO

Indicates the ratio of gNB active (i.e. up and running) number to the total number of gNB.

GNB_COMPUTING_USAGE

Indicates gNodeB computing resource usage.

GNB_MEMORY_USAGE

Indicates gNodeB memory usage.

GNB_DISK_USAGE

Indicates gNodeB disk usage.

NUM_OF_UE

Indicates number of UEs.

SESS_SUCC_RATIO

Indicates ratio of successful setup of PDU sessions to total PDU session setup attempts.

HO_SUCC_RATIO

Indicates Ratio of successful handovers to the total handover attempts.

5.1.6.3.11 Enumeration: ExpectedAnalyticsType

Table 5.1.6.3.11-1: Enumeration ExpectedAnalyticsType

Enumeration value

Description

Applicability

MOBILITY

Mobility related abnormal behaviour analytics is expected by the consumer

COMMUN

Communication related abnormal behaviour analytics is expected by the consumer

MOBILITY_AND_COMMUN

Both mobility and communication related abnormal behaviour analytics is expected by the consumer

5.1.6.3.12 Enumeration: MatchingDirection

Table 5.1.6.3.12-1: Enumeration MatchingDirection

Enumeration value

Description

Applicability

ASCENDING

Threshold is crossed in ascending direction.

DESCENDING

Threshold is crossed in descending direction.

CROSSED

Threshold is crossed either in ascending or descending direction.

5.1.6.3.13 Enumeration: NwdafFailureCode

Table 5.1.6.3.13-1: Enumeration NwdafFailureCode

Enumeration value

Description

Applicability

UNAVAILABLE_DATA

Indicates the requested statistics information for the event is rejected since necessary data to perform the service is unavailable.

BOTH_STAT_PRED_NOT_ALLOWED

Indicates the requested analysis information for the event is rejected since the start time is in the past and the end time is in the future, which means the NF service consumer requested both statistics and prediction for the analytics.

UNSATISFIED_REQUESTED_ANALYTICS_TIME

Indicates that the requested event is rejected since the analytics information is not ready when the time indicated by the "timeAnaNeeded" attribute (as provided during the creation or modification of subscription) is reached.

EneNA

OTHER

Indicates the requested analysis information for the event is rejected due to other reasons.

5.1.6.3.14 Enumeration: AnalyticsMetadata

Table 5.1.6.3.14-1: Enumeration AnalyticsMetadata

Enumeration value

Description

Applicability

NUM_OF_SAMPLES

Number of data samples used for the generation of the output analytics.

DATA_WINDOW

Data time window of the data samples.

DATA_STAT_PROPS

Dataset statistical properties of the data used to generate the analytics.

STRATEGY

Output strategy used for the reporting of the analytics.

ACCURACY

Level of accuracy reached for the analytics.

5.1.6.3.15 Enumeration: DatasetStatisticalProperty

Table 5.1.6.3.15-1: Enumeration DatasetStatisticalProperty

Enumeration value

Description

Applicability

UNIFORM_DIST_DATA

Indicates the use of data samples that are uniformly distributed according to the different aspects of the requested analytics.

NO_OUTLIERS

Indicates that the data samples shall disregard data samples that are at the extreme boundaries of the value range.

5.1.6.3.16 Enumeration: OutputStrategy

Table 5.1.6.3.16-1: Enumeration OutputStrategy

Enumeration value

Description

Applicability

BINARY

Indicates that the analytics shall only be reported when the requested level of accuracy is reached within a cycle of periodic notification as defined in the analytics reporting information (i.e. in the ReportingInformation data type or the EventSubscription data type).

GRADIENT

Indicates that the analytics shall be reported according with the periodicity defined in the analytics reporting information (i.e. in the ReportingInformation data type or the EventSubscription data type) irrespective of whether the requested level of accuracy has been reached or not.

5.1.6.3.17 Enumeration: TransferRequestType

Table 5.1.6.3.17-1: Enumeration TransferRequestType

Enumeration value

Description

Applicability

PREPARE

Indicates that the request is for analytics subscription transfer preparation.

TRANSFER

Indicates that the request is for analytics subscription transfer execution.

Editor’s Note: It is FFS whether CANCEL transfer type needs to be added.

5.1.6.3.18 Enumeration: AnalyticsSubset

Table 5.1.6.3.18-1: AnalyticsSubset

Enumeration value

Description

Applicability

NUM_OF_UE_REG

The number of UE registered. This value is only applicable to NSI_LOAD_LEVEL event.

NUM_OF_PDU_SESS_ESTBL

The number of PDU sessions established. This value is only applicable to NSI_LOAD_LEVEL event.

RES_USAGE

The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance. This value is only applicable to NSI_LOAD_LEVEL event.

NUM_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR

The number of times the resource usage threshold of the network slice instance is reached or exceeded if a threshold value is provided by the consumer. This value is only applicable to NSI_LOAD_LEVEL event.

PERIOD_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR

The time interval between each time the threshold being met or exceeded on the network slice (instance). This value is only applicable to NSI_LOAD_LEVEL event.

EXCEED_LOAD_LEVEL_THR_IND

Whether the Load Level Threshold is met or exceeded by the statistics value. This value is only applicable to NSI_LOAD_LEVEL event.

LIST_OF_TOP_APP_UL

The list of applications that contribute the most to the traffic in the UL direction. This value is only applicable to USER_DATA_CONGESTION event.

LIST_OF_TOP_APP_DL

The list of applications that contribute the most to the traffic in the DL direction. This value is only applicable to USER_DATA_CONGESTION event.

Editor’s Note: More values of the analytics subsets will be introduced later.

5.1.7 Error handling

5.1.7.1 General

HTTP error handling shall be supported as specified in subclause 5.2.4 of 3GPP TS 29.500 [6].

For the Nnwdaf_EventsSubscription API, HTTP error responses shall be supported as specified in subclause 4.8 of 3GPP TS 29.501 [7].

Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [6].

In addition, the requirements in the following subclauses shall apply.

5.1.7.2 Protocol Errors

In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf_EventsSubscription API.

5.1.7.3 Application Errors

The application errors defined for the Nnwdaf_EventsSubscription API are listed in table 5.1.7.3-1. The NWDAF shall include in the HTTP status code a "ProblemDetails" data structure with the "cause" attribute indicating the application error as listed in table 5.1.7.3-1.

Table 5.1.7.3-1: Application errors

Application Error

HTTP status code

Description

SUBSCRIPTION_NOT_FOUND

404 Not Found

Indicates the Individual NWDAF Event Subscription resource does not exist. (NOTE)

BOTH_STAT_PRED_NOT_ALLOWED

400 Bad Request

For the requested observation period, the start time is in the past and the end time is in the future, which means the NF service consumer requested both statistics and prediction for the analytics.

UNAVAILABLE_DATA

500 Internal Server Error

Indicates the requested statistics in the past is rejected since necessary data to perform the service is unavailable.

NOTE: This application error is only applicable for the responses to the PUT request (see subclause 4.2.2.2.3)and the DELETE request (see subclause 4.2.2.3.2).

5.1.8 Feature negotiation

The optional features in table 5.1.8-1 are defined for the Nnwdaf_EventsSubscription API. They shall be negotiated using the extensibility mechanism defined in subclause 6.6 of 3GPP TS 29.500 [6].

Table 5.1.8-1: Supported Features

Feature number

Feature Name

Description

1

ServiceExperience

This feature indicates support for the event related to service experience.

2

UeMobility

This feature indicates the support of analytics based on UE mobility information.

3

UeCommunication

This feature indicates the support of analytics based on UE communication information.

4

QoSSustainability

This feature indicates support for the event related to QoS sustainability.

5

AbnormalBehaviour

This feature indicates support for the event related to abnormal behaviour information.

6

UserDataCongestion

This feature indicates support for the event related to user data congestion.

7

NfLoad

This feature indicates the support of the analytics related to the load of NF instances.

8

NetworkPerformance

This feature indicates the support of analytics based on network performance.

9

NsiLoad

This feature indicates the support of the event related to the load level of Network Slice and the optionally associated Network Slice Instance.

10

ES3XX

Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in subclauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [6] and according to HTTP redirection principles for indirect communication, as specified in subclause 6.10.9 of 3GPP TS 29.500 [6].

11

EneNA

This feature indicates support for the enhancements of network data analytics requirements.

12

UserDataCongestionExt

This feature indicates support for the extensions to the event related to user data congestion. Supporting this feature also requires the support of feature UserDataCongestion.

13

Aggregation

This feature indicates support for analytics aggregation. Supporting this feature also requires the support of feature EneNA.

14

NsiLoadExt

This feature indicates support for the extensions to the event related to the load level of Network Slice and the optionally associated Network Slice Instance. Supporting this feature also requires the support of feature NsiLoad.

15

ServiceExperienceExt

This feature indicates support for the extensions to the event related to service experience. Supporting this feature also requires the support of feature ServiceExperience.

16

DnPerformance

This feature indicates the support of the analytics related to DN performance.

5.1.9 Security

As indicated in 3GPP TS 33.501 [13] and 3GPP TS 29.500 [6], the access to the Nnwdaf_EventsSubscription API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [14]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [12]) plays the role of the authorization server.

If OAuth2 is used, a n NF Service Consumer, prior to consuming services offered by the Nnwdaf_EventsSubscription API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [12], subclause 5.4.2.2.

NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnwdaf_EventsSubscription service.

The Nnwdaf_EventsSubscription API defines a single scope "nnwdaf-eventssubscription" for the entire service, and it does not define any additional scopes at resource or operation level.