Nnwdaf_AnalyticsInfo

The NWDAF slice congestion events notification Service is provided by the Network Data Analytics Function (NWDAF).

  • Allows NF consumers to subscribe to and unsubscribe from load events of network slice instance.

  • Notifies NF consumers with a corresponding subscription about observed events.

OpenAPI

OpenAPI Version: 3.0.0

info

Description: Nnwdaf_AnalyticsInfo Service API

Version: "1.0.0"

Title: Nnwdaf_AnalyticsInfo

externalDocs

Description: 3GPP TS 29.520 V15.2.0; 5G System; Network Data Analytics Services.

URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.520/'

security

- {}

- oAuth2ClientCredentials:

- nnwdaf-analyticsinfo

servers

URL: '{apiRoot}/nnwdaf-analyticsinfo/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501.

paths

/analytics

get:

Parameters:

- name: event-id

In: query

Description: Identify the analytics.

Required/Optional: true

Schema:

Reference: '#/components/schemas/EventId'

- name: event-filter

In: query

Description: Identify the analytics when the eventId is "Load_Level_Information".

Required/Optional: false

Schema:

Reference: '#/components/schemas/EventFilter'

- name: supported-features

In: query

Description: To filter irrelevant responses related to unsupported features

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

Responses:

'200' The individual PCF session biding session binding information resource matching the query parameter(s) is returned.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/AnalyticsData'

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29571_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29571_CommonData.yaml#/components/responses/403'

'404' Indicates that the NWDAF Analytics resource does not exist.

Content:

application/problem+json:

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'

'406': Reference 'TS29571_CommonData.yaml#/components/responses/406'

'414': Reference 'TS29571_CommonData.yaml#/components/responses/414'

'429': Reference 'TS29571_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default: Reference 'TS29571_CommonData.yaml#/components/responses/default'

components

securitySchemes

oAuth2ClientCredentials

Type: oauth2

Flows:

clientCredentials:

tokenUrl: '{nrfApiRoot}/oauth2/token'

scopes:

nnwdaf-analyticsinfo: Access to the Nnwdaf_AnalyticsInfo API

schemas

AnalyticsData

Type: object

Properties:

sliceLoadLevelInfos:

Type: array

Items:

Reference: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/SliceLoadLevelInformation'

minItems: 1

Description: The slices and there load level information.

EventFilter

Type: object

Properties:

anySlice:

Reference: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AnySlice'

snssais:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'

minItems: 1

Description: Identification(s) of network slice to which the subscription belongs. When eventId is "Load_level_Information", either information about slice(s) identified by snssai, or anySlice set to "TRUE" shall be included.

not:

Required: [anySlice, snssais]

EventId

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- LOAD_LEVEL_INFORMATION: Represent the analytics of load level information of corresponding network slice instance.