Policy Control Events Subscriptions

/subscriptions

POST

Subscription to the notification of policy control events and creation of an Individual Policy Control Events Subscription resource.

Individual Policy Control Events Subscription

/subscriptions/{subscriptionId}

GET

Reads an Individual Policy Control Events Subscription resource.

PUT

Modifies an Individual Policy Control Events Subscription.

DELETE

Cancels an individual subscription to notifications of policy control events.

apiRoot

string

See clause 5.1

n/a

PcEventExposureSubsc

M

1

Contains the information required for the creation of a new individual policy control events subscription.

PcEventExposureSubsc

M

1

201 Created

Contains the representation of the Individual Policy Control Events Subscription resource.

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

Location

string

M

1

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

apiRoot

string

See clause 5.1

subscriptionId

string

Identifies a subscription to the PCF event exposure service.

n/a

n/a

PcEventExposureSubsc

M

1

200 OK

A representation of the Individual Policy Control Events Subscription is returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

Applicable if the feature "ES3XX" is supported.

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

Location

string

M

1

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

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Location

string

M

1

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

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

n/a

PcEventExposureSubsc

M

1

Modifies the existing Individual Policy Control Events Subscription resource.

PcEventExposureSubsc

M

1

200 OK

Successful case: The Individual Policy Control Events Subscription was modified and a representation is returned.

n/a

204 No Content

Successful case: The Individual Policy Control Events Subscription was modified.

RedirectResponse

O

0..1

307 Temporary Redirect

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

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (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 [5] also apply.

Location

string

M

1

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

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Location

string

M

1

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

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

n/a

n/a

n/a

204 No Content

Successful case: The Individual Policy Control Events Subscription resource matching the subscriptionId was deleted.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

Applicable if the feature "ES3XX" is supported.

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

Location

string

M

1

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

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Location

string

M

1

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

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Policy Control Event Notification

{notifUri}

POST

Notification of policy control event reporting.

notifUri

Uri

The Notification Uri as assigned by the NF service consumer either during the explicit subscription service operation and described within the PcEventExposureSubsc data type (see table 5.6.2.2-1) or during the implicit subscription via the provisioning of the corresponding application data in UDR (see 3GPP TS 29.519 [24]. (NOTE).

NOTE: When obtained from the UDR, it corresponds to the notification URI previously stored by the NEF.

n/a

PcEventExposureNotif

M

1

Provides Information about observed policy control events

n/a

204 No Content

The receipt of the Notification is acknowledged.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during 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 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: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply.

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 ID towards which the notification request is redirected.

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 ID towards which the notification request is redirected.

EthernetFlowInfo

5.6.2.6

Identification of an UL/DL ethernet flow.

ExtendedSessionInformation

IpFlowInfo

5.6.2.7

Identification of an UL/DL IP flow.

ExtendedSessionInformation

PcEvent

5.6.3.3

Policy Control Events.

PcEventExposureNotif

5.6.2.3

Describes notifications about Policy Control events that occurred in an Individual Policy Events Subscription resource.

PcEventExposureSubsc

5.6.2.2

Represents an Individual Policy Events Subscription resource.

PcEventNotification

5.6.2.8

Represents the information reported for a Policy Control event.

PduSessionInformation

5.6.2.9

Represents PDU session identification information.

ExtendedSessionInformation

ReportingInformation

5.6.2.4

Represents the type of reporting the subscription requires.

ServiceIdentification

5.6.2.5

Identification of the service to which the subscription applies.

ExtendedSessionInformation

SnssaiDnnCombination

5.6.2.10

Represents a combination of S-NSSAI and DNN(s).

EneNA

AccessType

3GPP TS 29.571 [14]

Access Type.

AdditionalAccessInfo

3GPP TS 29.512 [9]

Indicates the combination of additional Access Type and RAT Type for MA PDU session.

ATSSS

AfAppId

3GPP TS 29.514 [12]

AF application Identifier.

ExtendedSessionInformation

AnGwAddress

3GPP TS 29.514 [12]

Carries the control plane address of the EPC untrusted non-3GPP access network gateway. (NOTE 1)

DateTime

3GPP TS 29.571 [14]

Time stamp.

Dnn

3GPP TS 29.571 [14]

Identifies a DNN.

DurationSec

3GPP TS 29.571 [14]

Seconds of duration.

EthFlowDescription

3GPP TS 29.514 [12]

Identifies an ethernet flow description. (NOTE 2)

ExtendedSessionInformation

Failure

3GPP TS 29.522 [25]

Indicates the failure reason for an unsuccessful outcome of the UE Policy Delivery.

DeliveryOutcome

FlowDescription

3GPP TS 29.514 [12]

Identifies an IP flow description.

ExtendedSessionInformation

Gpsi

3GPP TS 29.571 [14]

Generic Public Subscription Identifier.

GroupId

3GPP TS 29.571 [14]

Identifies a group of UEs.

MacAddr48

3GPP TS 29.571 [14]

Mac Address of the UE.

ExtendedSessionInformation

NotificationFlag

3GPP TS 29.571 [14]

Notification flag.

EneNA

NotificationMethod

3GPP TS 29.508 [15]

Represents the Notification Method.

PartitioningCriteria

3GPP TS 29.571 [14]

Used to partition UEs before applying sampling.

EneNA

PlmnIdNid

3GPP TS 29.571 [14]

Identifies the network: the PLMN Identifier or the SNPN Identifier. (NOTE 3)

RatType

3GPP TS 29.571 [14]

RAT Type.

RedirectResponse

3GPP TS 29.571 [14]

Contains redirection related information.

ES3XX

SamplingRatio

3GPP TS 29.571 [14]

Sampling Ratio.

SatelliteBackhaulCategory

3GPP TS 29.571 [14]

Indicates the satellite or non-satellite backhaul category.

SatelliteBackhaul

ServiceAreaCoverageInfo

3GPP TS 29.534 [23]

Service area coverage in terms of tracking area codes and serving network.

AMPoliciesEvents

Snssai

3GPP TS 29.571 [14]

Identifies a S-NSSAI.

Supi

3GPP TS 29.571 [14]

Identifies the SUPI of the UE.

SupportedFeatures

3GPP TS 29.571 [14]

Used to negotiate the applicability of the optional features defined in clause 5.8.

Uinteger

3GPP TS 29.571 [14]

Unsigned integer.

NOTE 1: "AnGwAddress" data structure is only used to encode the ePDG address and is only applicable to the 5GS and EPC/E-UTRAN interworking scenario as defined in 3GPP TS 29.512 [9], Annex B.

NOTE 2: In order to support a set of MAC addresses with a specific range in the traffic filter, feature MacAddressRange as specified in clause 5.8 shall be supported.

NOTE 3: The SNPN Identifier consists of the PLMN Identifier and the NID.

eventSubs

array(PcEvent)

M

1..N

Subscribed Policy Control events.

eventsRepInfo

ReportingInformation

O

0..1

Represents the reporting requirements of the subscription.

groupId

GroupId

C

0..1

Represents an internal group identifier and identifies a group of UEs. It shall be present when the subscription is targeting a Group of UE(s).

filterDnns

array(Dnn)

O

1..N

Represents the DNNs for which the policy event report shall apply. Each DNN is a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. If omitted it represents any DNN.

filterSnssais

array(Snssai)

O

1..N

Represents the S-NSSAIs for which the policy event report shall apply. If omitted it represents any S-NSSAI.

snssaiDnn

array(SnssaiDnnCombination)

O

1..N

Represents the combination list of S-NSSAI and DNN for which the policy event report shall apply. If omitted, it represents any combination.

EneNA

filterServices

array(ServiceIdentification)

O

1..N

Represents the services for which the policy event report shall apply. If omitted, the policy event report shall apply for all the active services.

ExtendedSessionInformation

notifUri

Uri

M

1

Notification URI for Policy Control event reporting.

notifId

string

M

1

Notification Correlation ID assigned by the NF service consumer.

eventNotifs

array(PcEventNotification)

C

1..N

Represents the Policy Control Events to be reported in the Npcf_EvenExposure_Subscribe response.
It shall be present in the resource creation/update response when the "eventsRepInfo" attribute includes the "immRep" attribute set to true. Otherwise, it shall be omitted.

ERIR

suppFeat

SupportedFeatures

C

0..1

This IE represents a list of Supported features used as described in clause 5.8.

Shall be present in the HTTP POST request/response. (NOTE)

NOTE: In the HTTP request, it represents the set of features supported by the NF service consumer. In the HTTP response, it represents the set of features supported by both the NF service consumer and the PCF.

notifId

string

M

1

Notification Correlation ID assigned by the NF service consumer.

eventNotifs

array(PcEventNotification)

M

1..N

Represents the Policy Control Events to be reported according to the subscription corresponding to the Notification Correlation ID.

immRep

boolean

O

0..1

Indication of immediate reporting. If included, when it is set to true it indicates immediate reporting of the subscribed events, if available. Otherwise, reporting will occur when the event is met.

notifMethod

NotificationMethod

O

0..1

Represents the notification method (periodic, one time, on event detection). If "notifMethod" attribute is not supplied, the default value "ON_EVENT_DETECTION" applies.

maxReportNbr

Uinteger

O

0..1

Represents the maximum number of reports, after which the subscription ceases to exist (i.e., the reporting ends). It may be present for the "PERIODIC" and on "ON_EVENT_DETECTION" notification methods. If omitted, there is no limit.

monDur

DateTime

C

0..1

Represents the time at which the subscription ceases to exist (i.e. the subscription becomes invalid and the reporting ends). If omitted, there is no time limit. If present in the subscription request, it shall be present in the subscription response.

repPeriod

DurationSec

O

0..1

Indicates the time interval between successive event notifications. It is supplied for notification method "PERIODIC".

sampRatio

SamplingRatio

O

0..1

Indicates the ratio of the random subset to target UEs, event reports only relates to the subset.

partitionCriteria

array(PartitioningCriteria)

O

1..N

Defines criteria for partitioning the UEs in order to apply the sampling ratio for each partition. It may only be included in event subscription requests when the "sampRatio" attribute is also provided. (NOTE)

EneNA

grpRepTime

DurationSec

O

0..1

Indicates the time during which the event reports detected for the concerned UEs are aggregated in a group, in order to be reported together to the NF service consumer.

notifFlag

NotificationFlag

O

0..1

Indicates the notification flag, which is used to mute/unmute notifications and to retrieve events stored during a period of muted notifications.

Default: "ACTIVATE".

EneNA

NOTE: For a given type of partitioning criteria, the UE shall belong to only one single partition as long as it is served by the NF service producer.

servEthFlows

array(EthernetFlowInfo)

C

1..N

Ethernet flows of a service.

ExtendedSessionInformation

servIpFlows

array(IpFlowInfo)

C

1..N

IP flows of a service.

ExtendedSessionInformation

afAppId

AfAppId

O

0..1

Contains an AF application identifier.

ExtendedSessionInformation

NOTE: At least one of the "servEthFlows", "servIpFlows" or "afAppId" attributes shall be present. The "servEthFlows" attribute and the "servIpFlows" attribute shall not be both present at the same time.

ethFlows

array(EthFlowDescription)

C

1..2

Contains the flow description for the Uplink and/or Downlink Ethernet flows. It shall be present in the subscription request.

ExtendedSessionInformation

flowNumber

integer

M

1

Identifies the ordinal number of the Ethernet flow.

ExtendedSessionInformation

ipFlows

array(FlowDescription)

C

1..2

Contains the flow description for the Uplink and/or Downlink IP flows. It shall be present in the subscription request.

ExtendedSessionInformation

flowNumber

integer

M

1

Identifies the ordinal number of the IP flow.

ExtendedSessionInformation

event

PcEvent

M

1..N

Reported Policy Control event.

accType

AccessType

C

0..1

Access Type. It shall be included when the reported PcEvent is "AC_TY_CH".

addAccessInfo

AdditionalAccessInfo

O

0..1

Indicates the additional combination of Access Type and RAT Type available for MA PDU session. It may be present when the notified event is "AC_TY_CH" and the PDU session is a Multi-Access PDU session.

ATSSS

relAccessInfo

AdditionalAccessInfo

O

0..1

Indicates the release of a combination of Access Type and RAT Type available for MA PDU session. It may be present when the notified event is "AC_TY_CH" and the PDU session is a Multi-Access PDU session.

ATSSS

anGwAddr

AnGwAddress

O

0..1

ePDG address. It shall be included if applicable when the reported PcEvent is "AC_TY_CH".

ratType

RatType

O

0..1

RAT Type. It shall be included if applicable when the reported PcEvent is "AC_TY_CH".

plmnId

PlmnIdNid

C

0..1

PLMN Identifier or the SNPN Identifier. It shall be included when the reported PcEvent is "PLMN_CH".

(NOTE)

appliedCov

ServiceAreaCoverageInfo

C

0..1

The list of applied allowed Tracking Areas for the serving network where the UE is camping. It shall be included when the reported PcEvent is "SAC_CH".

AMPoliciesEvents

supi

Supi

C

0..1

SUPI of the UE. It shall be present if available.

gpsi

Gpsi

O

0..1

Gpsi shall contain either an External Id or an MSISDN.

timeStamp

DateTime

M

1

Time at which the event is observed.

pduSessInfo

PduSessionInformation

O

0..1

Represents PDU session information related to the observed event.

ExtendedSessionInformation

repServices

ServiceIdentification

O

0..1

Represents service information related to the observed event.

ExtendedSessionInformation

satBackhaulCategory

SatelliteBackhaulCategory

C

0..1

Indicates the satellite or non-satellite backhaul category of the PDU session. It shall be included when the reported PcEvent is "SAT_CATEGORY_CH".

SatelliteBackhaul

delivFailure

Failure

C

0..1

Indicates the failure reason for an unsuccessful outcome of the UE Policy Delivery. It shall be included when the reported PcEvent is "UNSUCCESS_UE_POL_DEL_SP".

DeliveryOutcome

NOTE: The SNPN Identifier consists of the PLMN Identifier and the NID.

snssai

Snssai

M

1

S-NSSAI of the PDU session.

ExtendedSessionInformation

dnn

Dnn

M

1

Dnn of the PDU session, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.

ExtendedSessionInformation

ueIpv4

Ipv4Addr

C

0..1

The IPv4 address of the served UE.

(NOTE 1)

ExtendedSessionInformation

ueIpv6

Ipv6Prefix

C

0..1

The IPv6 prefix of the served UE.

(NOTE 1)

ExtendedSessionInformation

ipDomain

string

O

0..1

Identifies the IP domain.

(NOTE 2)

ExtendedSessionInformation

ueMac

MacAddr48

C

0..1

UE MAC address.

(NOTE 1)

ExtendedSessionInformation

NOTE 1: Either the served UE IP address (an Ipv4Addr or Ipv6Prefix or both if available) or UE MAC address shall be present.

NOTE 2: An "ipDomain" attribute, may be provided in combination with a "ueIpv4" attribute.

snssai

Snssai

M

1

S-NSSAI

dnns

array(Dnn)

M

1..N

Dnn

AC_TY_CH

Access Type Change

PLMN_CH

PLMN Change

SAC_CH

Service Area Coverage change

AMPoliciesEvents

SAT_CATEGORY_CH

Indicates that a change between different satellite backhaul category, or non-satellite backhaul, has been detected.

SatelliteBackhaul

SUCCESS_UE_POL_DEL_SP

Indicates about the successful UE Policy delivery related to the invocation of AF provisioned service parameters.

DeliveryOutcome

UNSUCCESS_UE_POL_DEL_SP

Indicates about the unsuccessful UE Policy delivery related to the invocation of AF provisioned service parameters.

DeliveryOutcome

1

ExtendedSessionInformation

Indicates the support of additional session information in the subscription and report of policy control event.

2

MacAddressRange

Indicates the support of a set of MAC addresses with a specific range in the traffic filter.

3

ATSSS

Indicates the support of the report of the multiple access types of a MA PDU session.

4

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 clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [5] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [5].

5

AMPoliciesEvents

Indicates the support of the report of changes of service area coverage for a UE.

6

EneNA

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

7

SatelliteBackhaul

Indicates the support of the report of the satellite or non-satellite backhaul category of the PDU session.

8

DeliveryOutcome

Indicates the support of notifications about the outcome of the UE Policy delivery related to the invocation of AF provisioned service parameters.

9

ERIR

Indicates the support of immediate report within the subscription response.