5.2 Nnwdaf_AnalyticsInfo Service API

29.5203GPP5G SystemNetwork Data Analytics ServicesRelease 17Stage 3TS

5.2.1 Introduction

The Nnwdaf_AnalyticsInfo Service shall use the Nnwdaf_AnalyticsInfo API.

The API URI of the Nnwdaf_AnalyticsInfo 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-analyticsinfo".

– The <apiVersion> shall be "v1".

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

5.2.2 Usage of HTTP

5.2.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_AnalyticsInfo is contained in Annex A.

5.2.2.2 HTTP standard headers

5.2.2.2.1 General

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

5.2.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.2.2.3 HTTP custom headers

The Nnwdaf_AnalyticsInfo 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_AnalyticsInfo Service API.

5.2.3 Resources

5.2.3.1 Resource Structure

Figure 5.2.3.1-1: Resource URI structure of the Nnwdaf_AnalyticsInfo API

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

Table 5.2.3.1-1: Resources and methods overview

Resource name

Resource URI

HTTP method or custom operation

Description

NWDAF Analytics

/analytics

GET

Retrieve the NWDAF analytics.

NWDAF Context

/context

GET

Retrieve the NWDAF context information related to analytics subscriptions.

5.2.3.2 Resource: NWDAF Analytics

5.2.3.2.1 Description

The NWDAF Analytics resource represents the analytics to the Nnwdaf_AnalyticsInfo Service at a given NWDAF.

5.2.3.2.2 Resource definition

Resource URI: {apiRoot}/nnwdaf-analyticsinfo/v1/analytics

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

Table 5.2.3.2.2-1: Resource URI variables for this resource

Name

Data type

Definition

apiRoot

string

See subclause 5.2.1

5.2.3.2.3 Resource Standard Methods
5.2.3.2.3.1 GET

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

Table 5.2.3.2.3.1-1: URI query parameters supported by the GET method on this resource

Name

Data type

P

Cardinality

Description

ana-req

EventReportingRequirement

O

0..1

Identifies the analytics reporting requirement information.

event-id

EventId

M

1

Shall be included to identify the analytics.

event-filter

EventFilter

C

0..1

Shall be included to identify the analytics when filter information is needed for the related event.

supported-features

SupportedFeatures

O

0..1

To filter irrelevant responses related to unsupported features.

tgt-ue

TargetUeInformation

O

0..1

Identifies the target UE information.

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

Table 5.2.3.2.3.1-2: Data structures supported by the GET Request Body on this resource

Data type

P

Cardinality

Description

n/a

Table 5.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource

Data type

P

Cardinality

Response

codes

Description

AnalyticsData

M

1

200 OK

Containing the analytics with parameters as relevant for the requesting NF service consumer

n/a

204 No Content

If the request NWDAF Analytics data does not exist, the NWDAF shall respond with "204 No Content ".

ProblemDetailsAnalyticsInfoRequest

O

0..1

500 Internal Server Error

The request is rejected by the NWDAF and more details (not only the ProblemDetails) are returned.

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

5.2.3.2.4 Resource Custom Operations

None in this release of the specification.

5.2.3.3 Resource: NWDAF Context

5.2.3.3.1 Description

The NWDAF Context resource represents the context information related to analytics subscriptions at the Nnwdaf_AnalyticsInfo Service at a given NWDAF.

5.2.3.3.2 Resource definition

Resource URI: {apiRoot}/nnwdaf-analyticsinfo/v1/context

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

Table 5.2.3.3.2-1: Resource URI variables for this resource

Name

Data type

Definition

apiRoot

string

See subclause 5.2.1

5.2.3.3.3 Resource Standard Methods
5.2.3.3.3.1 GET

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

Table 5.2.3.3.3.1-1: URI query parameters supported by the GET method on this resource

Name

Data type

P

Cardinality

Description

context-ids

ContextIdList

M

1

Identifies specific context information related to analytics subscriptions.

req-context

RequestedContext

O

0..1

Identfies the types of the analytics context information the consumer wishes to receive. Absence of this attribute means that the consumer wishes to receive available context information of all types.

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

Table 5.2.3.3.3.1-2: Data structures supported by the GET Request Body on this resource

Data type

P

Cardinality

Description

n/a

Table 5.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource

Data type

P

Cardinality

Response

codes

Description

ContextData

M

1

200 OK

Contains the context information corresponding with the context identifiers provided in the request.

n/a

204 No Content

If the requested context information does not exist, the NWDAF shall respond with "204 No Content".

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

Editor’s Note: It is FFS to decide if redirection codes 307 and 308 are applicable for the GET response of this resource.

5.2.4 Custom Operations without associated resources

None in this release of the specification.

5.2.5 Notifications

None in this release of the specification.

5.2.6 Data Model

5.2.6.1 General

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

Table 5.2.6.1-1 specifies the data types defined for the Nnwdaf_AnalyticsInfo service based interface protocol.

Table 5.2.6.1-1: Nnwdaf_AnalyticsInfo specific Data Types

Data type

Section defined

Description

Applicability

AdditionInfoAnalyticsInfoRequest

5.2.6.2.5

Contains more details (not only the ProblemDetails) in case an Nnwdaf_AnalyticsInfo request is rejected.

EneNA

AdrfDataType

5.2.6.3.5

Represents a type of data that is stored in the ADRF.

EneNA

AnalyticsData

5.2.6.2.2

Describes analytics with parameters indicated in the request.

ContextData

5.2.6.2.6

Contains context information related to analytics subscriptions corresponding with one or more context identifiers.

EneNA

ContextElement

5.2.6.2.7

Contains context information corresponding with a specific context identifier.

EneNA

ContextIdList

5.2.6.2.8

Contains list of context identifiers of context information of analytics subscriptions.

EneNA

ContextType

5.2.6.3.4

Identfies the type of analytics context information.

EneNA

EventFilter

5.2.6.2.3

Represents the event filters used to identify the requested analytics.

EventId

5.2.6.3.3

Describes the type of analytics.

HistoricalData

5.2.6.2.9

Contains historical data related to an analytics subscription.

EneNA

ProblemDetailsAnalyticsInfoRequest

5.2.6.4.1

Data type that extends ProblemDetails.

EneNA

RequestedContext

5.2.6.2.11

Contains types of analytics context information.

EneNA

SmcceInfo

5.2.6.2.12

Represent the analytics of Session Management congestion control experience information.

SMCCE

SmcceUeList

5.2.6.2.13

Represents the List of UEs classified based on experience level of Session Management congestion control.

SMCCE

SpecificAnalyticsSubscription

5.2.6.2.10

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

EneNA

Table 5.2.6.1-2 specifies data types re-used by the Nnwdaf_AnalyticsInfo 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.2.6.1-2: Nnwdaf_AnalyticsInfo re-used Data Types

Data type

Reference

Comments

Applicability

AnalyticsContextIdentifier

5.1.6.2.43

Contains information about the available analytics contexts.

EneNA

AnalyticsMetadataInfo

5.1.6.2.37

Contains analytics metadata information required for analytics aggregation.

Aggregation

AnySlice

5.1.6.3.2

ApplicationId

3GPP TS 29.571 [8]

Identifies the application.

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

BwRequirement

5.1.6.2.25

ServiceExperience

DateTime

3GPP TS 29.571 [8]

Identifies the time.

Dnn

3GPP TS 29.571 [8]

Identifies the DNN.

ServiceExperience

AbnormalBehaviour

UeCommunication

SMCCE

Dnai

3GPP TS 29.571 [8]

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

ServiceExperience

EventNotification

5.1.6.2.5

Describes Notifications about events that occurred.

EneNA

EventReportingRequirement

5.1.6.2.7

ExceptionId

5.1.6.3.6

AbnormalBehaviour

ExpectedUeBehaviourData

3GPP TS 29.503 [23]

AbnormalBehaviour

ExpectedAnalyticsType

5.1.6.3.11

AbnormalBehaviour

GroupId

3GPP TS 29.571 [8]

Internal Group Identifier of a group of UEs.

UeMobility

UeCommunication

NetworkPerformance

AbnormalBehaviour

ServiceExperience

NetworkAreaInfo

3GPP TS 29.554 [18]

The network area information.

UeMobility

NetworkPerformance

QoSSustainability

ServiceExperience

UserDataCongestion

AbnormalBehaviour

NsiLoadExt

NetworkPerfInfo

5.1.6.2.23

NetworkPerformance

NetworkPerfType

5.1.6.3.10

Represents the network performance types.

NetworkPerformance

NfLoadLevelInformation

5.1.6.2.31

Represents load level information of a given NF instance.

NfLoad

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

NsiIdInfo

5.1.6.2.33

Identify the S-NSSAI and the associated Network Slice Instance(s).

ServiceExperience

NsiLoad

NsiLoadExt

NsiLoadLevelInfo

5.1.6.2.34

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

NsiLoad

NsiLoadExt

NwdafEvent

5.1.6.3.4

Describes the NWDAF Events.

EneNA

NwdafEventsSubscription

5.1.6.2.2

Represents an Individual NWDAF Event Subscription resource.

EneNA

ProblemDetails

3GPP TS 29.571 [8]

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

QosRequirement

5.1.6.2.20

QoSSustainability

QosSustainabilityInfo

5.1.6.2.19

QoSSustainability

RatType

3GPP TS 29.571 [8]

Identifies the RAT type.

ServiceExperienceExt

SamplingRatio

3GPP TS 29.571 [8]

ServiceExperienceInfo

5.1.6.2.24

ServiceExperience

Supi

3GPP TS 29.571 [8]

Identifies the UE.

ServiceExperience,

NfLoad

NetworkPerformance

UserDataCongestion

UeMobility

UeCommunication

AbnormalBehaviour

SMCCE

SupportedFeatures

3GPP TS 29.571 [8]

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

Snssai

3GPP TS 29.571 [8]

SliceLoadLevelInformation

5.1.6.2.6

TargetUeInformation

5.1.6.2.8

Identifies the target UE information.

ServiceExperience

NfLoad

NetworkPerformance

UserDataCongestion

UserDataCongestionExt

UeMobility

UeCommunication

AbnormalBehaviour

QoSSustainability

UeCommunication

5.1.6.2.13

UeCommunication

UeMobility

5.1.6.2.10

UeMobility

Uinteger

3GPP TS 29.571 [8]

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

UserDataCongestionInfo

5.1.6.2.17

UserDataCongestion

AbnormalBehaviour

5.1.6.2.15

Represents the abnormal behaviour information.

AbnormalBehaviour

5.2.6.2 Structured data types

5.2.6.2.1 Introduction

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

5.2.6.2.2 Type AnalyticsData

Table 5.2.6.2.2-1: Definition of type AnalyticsData

Attribute name

Data type

P

Cardinality

Description

Applicability

start

DateTime

O

0..1

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

expiry

DateTime

O

0..1

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

timeStampGen

DateTime

O

0..1

It defines the timestamp of analytics generation.

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 request, containing the information indicated by the "anaMeta" attribute.

Aggregation

sliceLoadLevelInfos

array(SliceLoadLevelInformation)

C

1..N

The slices and the load level information. Shall be present when the requested event is "LOAD_LEVEL_INFORMATION".

nsiLoadLevelInfos

array(NsiLoadLevelInfo)

C

1..N

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

Shall be presented when the requested event is "NSI_LOAD_LEVEL"

NsiLoad

NsiLoadExt

nwPerfs

array(NetworkPerfInfo)

C

1..N

The network performance information.

Shall be present when the requested event is "NETWORK_PERFORMANCE".

NetworkPerformance

nfLoadLevelInfos

array(NfLoadLevelInformation)

C

1..N

The NF load information.

When the requestedevent is "NF_LOAD", the nfLoadLevelInfos shall be included.

NfLoad

qosSustainInfos

array(QosSustainabilityInfo)

C

1..N

The QoS sustainability informations in the certain geographic areas.

It shall present if the requested eventis "QOS_SUSTAINABILITY"

QoSSustainability

ueMobs

array(UeMobility)

C

1..N

The UE mobility information.

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

UeMobility

ueComms

array(UeCommunication)

C

1..N

The UE communication information.

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

UeCommunication

userDataCongInfos

array(UserDataCongestionInfo)

C

1..N

The user data congestion information.

Shall be present when the requested event is "USER_DATA_CONGESTION".

UserDataCongestion

suppFeat

SupportedFeatures

C

0..1

List of Supported features used as described in subclause 5.2.8.

This parameter shall be supplied by NWDAF in the reply of GET request that request the analytics resource, if the consumer includes "supported-features" in the GET request.

svcExps

array(ServiceExperienceInfo)

C

1..N

The service experience information.

ServiceExperience

abnorBehavrs

array(AbnormalBehaviour)

C

1..N

The abnormal behaviour information.

AbnormalBehaviour

smccExps

array(SmcceInfo)

C

1..N

The Session Management congestion control experience information.

Shall be present when the requested event is "SM_CONGESTION".

SMCCE

NOTE: 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.

5.2.6.2.3 Type EventFilter

Table 5.2.6.2.3-1: Definition of type EventFilter

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. The absence of appIds means applicable to all applications. (NOTE 4)

ServiceExperience

UeCommunication AbnormalBehaviour

dnns

array(Dnn)

C

1..N

Identification(s) of DNN. 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 applicable to all DNNs. (NOTE 4)

ServiceExperience

UeCommunication

AbnormalBehaviour

SMCCE

dnais

array(Dnai)

C

1..N

Identification(s) of user plane accesses to DN(s) which the subscription applies. It may be included when event-id is "SERVICE_EXPERIENCE".

ServiceExperience

snssais

array(Snssai)

C

1..N

Identification(s) of network slice to which the subscription belongs. (NOTE 1), (NOTE 4)

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

networkArea

NetworkAreaInfo

C

0..1

This IE represents the network area where the NF service consumer wants to know the analytics result. (NOTE 2), (NOTE 4)

UeMobility

UeCommunication

NetworkPerformance

QoSSustainability

ServiceExperience

UserDataCongestion

AbnormalBehaviour

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

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

nwPerfTypes

array(NetworkPerfType)

C

1..N

Represents the network performance types. This attribute shall be included when event-id is "NETWORK_PERFORMANCE".

NetworkPerformance

qosRequ

QoSRequirement

C

0..1

Represents the QoS requirements. This attribute shall be included when event-id is "QOS_SUSTAINABILITY".

QoSSustainability

bwRequs

array(BwRequirement)

O

1..N

Represents the media/application bandwidth requirement for each application.

It may only be present if "appIds" attribute is provided.

ServiceExperience

excepIds

array(ExceptionId)

C

1..N

Represents a list of Exception Ids.

(NOTE 3)

AbnormalBehaviour

exptAnaType

ExpectedAnalyticsType

C

0..1

Represents expected UE analytics type.

(NOTE 3)

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 5)

ServiceExperienceExt

freqs

array(ArfcnValueNR)

O

1..N

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

ServiceExperienceExt

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 event-id in the request is "LOAD_LEVEL_INFORMATION", the identifications of network slices, either information about slice(s) identified by the "snssais" attribute, or "anySlice" set to "TRUE", shall be included. When subscribed event is "NSI_LOAD_LEVEL" or "SERVICE_EXPERIENCE", either the "nsiIdInfos" attribute 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 the "snssais" attribute is optional.

NOTE 2: 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). For "QOS_SUSTAINABILITY", this attribute shall be provided.

NOTE 3: Either "excepIds" or "exptAnaType" shall be provided if event-id in the request is "ABNORMAL_BEHAVIOUR".

NOTE 4: For "ABNORMAL_BEHAVIOUR" event with "anyUe" attribute in "tgt-ue" 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 "excepIds" 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 "excepIds" attribute is communication related;

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

NOTE 5: 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" and "nfInstanceIds" attirbutes are applicable for the NsiLoadExt feature.

5.2.6.2.4 Void
5.2.6.2.5 Type AdditionInfoAnalyticsInfoRequest

Table 5.2.6.2.5-1: Definition of type AdditionInfoAnalyticsInfoRequest

Attribute name

Data type

P

Cardinality

Description

Applicability

rvWaitTime

DateTime

O

0..1

Recommended minimum time interval (in seconds) to be used to determine the time when analytics information is needed in similar future requests.

It may only be included if the "cause" attribute within the ProblemDetails data type is set to "UNSATISFIED_REQUESTED_ANALYTICS_TIME".

5.2.6.2.6 Type ContextData

Table 5.2.6.2.6-1: Definition of type ContextData

Attribute name

Data type

P

Cardinality

Description

Applicability

contextElems

array(ContextElement)

M

1..N

List of items that contain context information corresponding with a context identifier.

5.2.6.2.7 Type ContextElement

Table 5.2.6.2.7-1: Definition of type ContextElement

Attribute name

Data type

P

Cardinality

Description

Applicability

contextId

AnalyticsContextIdentifier

M

1

Context identifier of the context information contained in the rest of the attributes.

pendAnalytics

array(EventNotification)

C

1..N

Contains output analytics for the analytics subscription this context element is associated with, which have not yet been sent to the analytics consumer. It shall be provided if such analytics are available and the NF service consumer has requested the "PENDING_ANALYTICS" context type.

histAnalytics

array(EventNotification)

C

1..N

Contains historical output analytics for the analytics subscription this context element is associated with. It shall be provided if such analytics are available and the NF service consumer has requested the "HISTORICAL_ANALYTICS" context type.

lastOutputTime

DateTime

C

0..1

Timestamp of the last output analytics provided to the analytics consumer. It shall be provided if output analytics had been provided and the NF service consumer has requested the "PENDING_ANALYTICS" and/or "HISTORICAL_ANALYTICS" context type. Absence of this attribute means that no output analytics had been sent.

aggrSubs

array(SpecificAnalyticsSubscription)

C

1..N

Contains analytics subscription aggregation information, i.e. information about analytics subscriptions that the NWDAF has with other NWDAFs that collectively serve an analytics subscription. It shall be provided if such subscriptions exist and the NF service consumer has requested the "AGGR_SUBS" context type.

histData

array(HistoricalData)

C

1..N

Contains historical data related to the analytics subscription this context element is associated with. It shall be provided if such data exists and the NF service consumer has requested the "DATA" context type.

adrfId

NfInstanceId

O

0..1

Identifier of the ADRF in which the NWDAF stores analytics context information.

adrfDataTypes

array(AdrfDataType)

C

1..N

Type(s) of data stored in the ADRF by the NWDAF. It shall be provided if the attribute "adrfId" is provided.

aggrNwdafIds

array(NfInstanceId)

C

1..N

NWDAF identifiers of NWDAF instances used by the NWDAF service consumer when aggregating multiple analytics subscriptions. It shall be provided if such information is available and the NF service consumer has requested the "AGGR_INFO" context type.

modelProvIds

array(NfInstanceId)

C

1..N

Instance ID(s) of the ML model provider NWDAF(s) from which the consumer NWDAF currently subscribes to the ML model information used for the analytics. It shall be provided if such information is available and the NF service consumer has requested the "ML_MODELS" context type.

Editor’s Note: It is FFS to add the information about subscriptions with the data sources that are related to the analytics.

5.2.6.2.8 Type ContextIdList

Table 5.2.6.2.8-1: Definition of type ContextIdList

Attribute name

Data type

P

Cardinality

Description

Applicability

contextIds

array(AnalyticsContextIdentifier)

M

1..N

List of context identifiers of context information of analytics subscriptions.

5.2.6.2.9 Type HistoricalData

Table 5.2.6.2.9-1: Definition of type HistoricalData

Attribute name

Data type

P

Cardinality

Description

Applicability

startTime

DateTime

O

0..1

Start of the time period during which the data was collected.

endTime

DateTime

O

0..1

End of the time period during which the data was collected.

sources

array(NfInstanceId)

O

1..N

Identifier(s) of the data source(s).

subsWithSources

string

O

1..N

Information about subscriptions with the data sources.

data

array(string)

M

1..N

Historical data related to the analytics.

Editor’s Note: The data type and the details of "data" are FFS, to be designed in line with the relevant parts of the DCCF and ADRF APIs.

Editor’s Note: The data type and the details of "subsWithSources" are FFS, pending clarification of the intended content and scope.

5.2.6.2.10 Type SpecificAnalyticsSubscription

Table 5.2.6.2.10-1: Definition of type SpecificAnalyticsSubscription

Attribute name

Data type

P

Cardinality

Description

Applicability

subscriptionId

string

M

1

The identifier of the specific analytics subscription.

producerId

NfInstanceId

O

0..1

NWDAF instance identifier to which the NF service consumer has established this subscription. (NOTE)

producerSetId

NfSetId

O

0..1

NWDAF set identifier to which the NF service consumer has established this subscription. (NOTE)

nwdafEvSub

NwdafEventsSubscription

M

1

Contains information about the analytics subscription.

NOTE: One of "producerId" and "producerSetId" shall be included.

5.2.6.2.11 Type RequestedContext

Table 5.2.6.2.11-1: Definition of type RequestedContext

Attribute name

Data type

P

Cardinality

Description

Applicability

contexts

array(ContextType)

M

1..N

Contains the types of the analytics context information the consumer wishes to receive.

5.2.6.2.12 Type SmcceInfo

Table 5.2.6.2.12-1: Definition of type SmcceInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

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 the "event-filter" attribute during the NWDAF analytics information request procedure.

snssai

Snssai

C

0..1

Identifies the network slice information.

Shall be present if the "snssais" was provided within the "event-filter" attribute during the NWDAF analytics information request procedure.

smcceUeList

SmcceUeList

M

1

Contains the list of UEs classified based on experience level of SM congestion control.

5.2.6.2.13 Type SmcceUeList

Table 5.2.6.2.13-1: Definition of type SmcceUeList

Attribute name

Data type

P

Cardinality

Description

Applicability

highLevel

array(Supi)

O

1..N

A list of UEs whose experience level of SMCC for specific DNN and/or S-NSSAI is high.

mediumLevel

array(Supi)

O

1..N

A list of UEs whose experience level of SMCC for specific DNN and/or S-NSSAI is medium.

lowLevel

array(Supi)

O

1..N

A list of UEs whose experience level of SMCC for specific DNN and/or S-NSSAI is low.

NOTE: At least one of "highLevel", "mediumLevel" or "lowLevel" shall be provided.

5.2.6.3 Simple data types and enumerations

5.2.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.2.6.3.2 Simple data types

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

Table 5.2.6.3.2-1: Simple data types

Type Name

Type Definition

Description

Applicability

n/a

5.2.6.3.3 Enumeration: EventId

Table 5.2.6.3.3-1: Enumeration EventId

Enumeration value

Description

Applicability

LOAD_LEVEL_INFORMATION

Represents the analytics of load level information of corresponding network slice.

NETWORK_PERFORMANCE

Represents the analytics of network performance information

NetworkPerformance

NF_LOAD

Represents the analytics of NF Load information.

NfLoad

QOS_SUSTAINABILITY

Represents the analytics of QoS sustainability in the certain area.

QoSSustainability

SERVICE_EXPERIENCE

Represents the analytics of service experience of corresponding application and/or network slice.

ServiceExperience

UE_MOBILITY

Represents the analytics of UE mobility.

UeMobility

UE_COMM

Represents the analytics of UE communication.

UeCommunication

USER_DATA_CONGESTION

Represents the analytics of the user data congestion in the certain area.

UserDataCongestion

ABNORMAL_BEHAVIOUR

Represents the analytics of abnormal behaviour information.

AbnormalBehaviour

NSI_LOAD_LEVEL

Represents the analytics of load level information of Network Slice and the optionally associated Network Slice Instance

NsiLoad

SM_CONGESTION

Represents the analytics of Session Management congestion control experience information for specific DNN and/or S-NSSAI.

SMCCE

DN_PERFORMANCE

Represents the analytics of DN performance.

DnPerformance

5.2.6.3.4 Enumeration: ContextType

Table 5.2.6.3.4-1: Enumeration ContextType

Enumeration value

Description

Applicability

PENDING_ANALYTICS

Represents context information that relates to pending output analytics.

HISTORICAL_ANALYTICS

Represents context information that relates to historical output analytics.

AGGR_SUBS

Represents context information about the analytics subscriptions that an NWDAF has with other NWDAFs that collectively serve an analytics subscription.

DATA

Represents context information about historical data that is available.

AGGR_INFO

Represents context information that is related to aggregation of analytics from multiple NWDAF subscriptions.

ML_MODELS

Represents context information about used ML models.

5.2.6.3.5 Enumeration: AdrfDataType

Table 5.2.6.3.5-1: Enumeration AdrfDataType

Enumeration value

Description

Applicability

HISTORICAL_ANALYTICS

Indicates that historical analytics are stored in the ARDF.

HISTORICAL_DATA

Indicates that historical data are stored in the ARDF.

5.2.6.4 Data types describing alternative data types or combinations of data types

5.2.6.4.1 Type ProblemDetailsAnalyticsInfoRequest

Table 5.2.6.4.1-1: Definition of type ProblemDetailsAnalyticsInfoRequest as a list of to be combined data types

Data type

Cardinality

Description

Applicability

ProblemDetails

1

Details of the problem as defined in TS 29.571 [8].

AdditionInfoAnalyticsInfoRequest

1

Contains additional information why the analytics request is rejected.

5.2.7 Error handling

5.2.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_AnalyticsInfo 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.2.7.2 Protocol Errors

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

5.2.7.3 Application Errors

The application errors defined for the Nnwdaf_AnalyticsInfo API are listed in table 5.2.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.2.7.3-1.

Table 5.2.7.3-1: Application errors

Application Error

HTTP status code

Description

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.

UNSATISFIED_REQUESTED_ANALYTICS_TIME

500 Internal Server Error

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 request) is reached.

5.2.8 Feature negotiation

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

Table 5.2.8-1: Supported Features

Feature number

Feature Name

Description

1

UeMobility

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

2

UeCommunication

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

3

NetworkPerformance

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

4

ServiceExperience

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

5

QoSSustainability

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

6

AbnormalBehaviour

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

7

UserDataCongestion

This feature indicates the support of the analytics related on user data congestion.

8

NfLoad

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

9

NsiLoad

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

10

EneNA

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

11

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.

12

Aggregation

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

13

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.

14

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.

15

SMCCE

This feature indicates support for the event related to SM congestion control experience.

5.2.9 Security

As indicated in 3GPP TS 33.501 [13] and 3GPP TS 29.500 [6], the access to the Nnwdaf_AnalyticsInfo 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_AnalyticsInfo 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_AnalyticsInfo service.

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