Content for TS 29.591 Word version: 19.0.0
4.5 Nnef_ECSAddress Service
4.5.1 Service Description
4.5.1.1 Overview
4.5.1.2 Service Architecture
4.5.1.3 Network Functions
4.5.2 Service Operations
4.5.2.1 Introduction
4.5.2.2 Nnef_ECSAddress_Subscribe service operation
4.5.2.3 Nnef_ECSAddress_Unsubscribe service operation
4.5.2.4 Nnef_ECSAddress_Notify service operation
...
...
4.5 Nnef_ECSAddress Service |R18| p. 32
4.5.1 Service Description p. 32
4.5.1.1 Overview p. 32
The Nnef_ECSAddress service, as defined in TS 23.502, is provided by the Network Exposure Function (NEF). This service allows the NF service consumer (e.g., V-SMF)to subscribe/unsubscribe the notification of ECS Address Configuration Information from AF in VPLMN, and for the V-NEF to notify the ECS Address Configuration Information to the subscribed NF service consumer (e.g., V-SMF).
4.5.1.2 Service Architecture p. 32
The Nnef_ECSAddress service is part of the Nnef service-based interface exhibited by the Network Exposure Function (NEF).
Known NF service consumer of the Nnef_ECSAddress service is:
- Session Management Function (SMF)
4.5.1.3 Network Functions p. 33
4.5.1.3.1 Network Exposure Function (NEF) p. 33
The Network Exposure Function (NEF) allows the NF service consumer to subscribe to and unsubscribe from the NEF for the ECS Address Configuration Information from the AF.
4.5.1.3.2 NF Service Consumers p. 33
The known NF service consumers are as follows:
The Session Management Function (SMF):
- supports (un)subscribing to notifications of ECS Address Configuration Information from the NEF.
- supports receiving the notifications of ECS Address Configuration Information from the NEF.
4.5.2 Service Operations p. 33
4.5.2.1 Introduction p. 33
Service operations defined for the Nnef_ECSAddress Service are shown in Table 4.5.2.1-1.
| Service Operation Name | Description | Initiated by |
|---|---|---|
| Nnef_ | This service operation is used by an NF service consumer to explicitly subscribe the notification of ECS Address Configuration Information. | NF service consumer |
| Nnef_ | This service operation is used by an NF service consumer to explicitly unsubscribe the notification of ECS Address Configuration Information. | NF service consumer |
| Nnef_ | This service operation is used by the NEF to provide ECS Address Configuration Information to the NF service consumer. | NEF |
4.5.2.2 Nnef_ECSAddress_Subscribe service operation p. 34
4.5.2.2.1 General p. 34
This service operation is provided by the NEF for NF service consumers to explicitly subscribe the notification of ECS Address Configuration Information.
4.5.2.2.2 Creating a new subscription p. 34
Figure 4.5.2.2.2-1 illustrates the creation of a Individual ECS Address Configuration Information Subscription.
In order to subscribe to ECS Address Configuration Information, the NF service consumersshall send an Nnef_ECSAddress_Subscribe request using the HTTP POST method to the NEF with "{apiRoot}/nnef-ecs-addr-cfg-info/<apiVersion>/subscriptions" as request URI as shown in step 1 of Figure 4.5.2.2.2-1. The HTTP POST message shall include EcsAddrCfgInfoSub data structure as request body. The EcsAddrCfgInfoSub data structure shall include:
DataRepository service as described in TS 29.504 to retrieve and subscribethe ECS Address Configuration Information in the application data in the UDR.
After receiving a successful response from the UDR, the NEF shall create a new subscription and assign a subscription identifier for the "Individual ECS Address Configuration Information Subscription" resource. Then the NEF shall send an HTTP "201 Created" response with EcsAddrCfgInfoSub data structure as response body and a Location header field containing the URI of the created individual subscription resource to the NF service consumer.
If the immediate report indication is included in the subscription request, the NEF shall include the currently available ECS Address Configuration Information in "immReports" attribute in the response body.
If errors occur when processing the HTTP POST request or receiving an error code from the UDR, the NEF shall send an HTTP error response as specified in clause 5.4.7.
- the notification URI in the "notifUri" attribute;
- the notification correlation identifier in the "notifCorrId" attribute;
- the identification(s) of DNN in "dnns" attribute;
- the identification(s) of network slice in "snssais" attribute;
- an indicator to immediately report the currently available ECS Address Configuration Information in "immRepInd" attribute;
4.5.2.2.3 Modifying an existing subscription p. 35
Figure 4.5.2.2.3-1 illustrates the modification of an existing subscription.
To modify an existing subscription to event notifications, the NF service consumer shall send an HTTP PUT/PATCH request with: "{apiRoot}/nnef-ecs-addr-cfg-info/<apiVersion>/subscriptions/{subscriptionId}" as request URI, as shown in step 1 of Figure 4.5.2.2.3-1, where "{subscriptionId}" is the subscription ID of the existing subscription. The EcsAddrCfgInfoSub data structure is included as PUT request body as described in clause 4.5.2.2.2 or the EcsAddrCfgInfoSubPatch data structure is included as PATCH request body as defined in clause 5.4.6.2.4.
Upon successful reception of an HTTP PUT/PATCH request with: "{apiRoot}/nnef-ecs-addr-cfg-info/<apiVersion>/subscriptions/{subscriptionId}" as request URI and EcsAddrCfgInfoSub/EcsAddrCfgInfoSubPatch data structure as request body, the NEF shall interact with the UDR by invoking the Nudr_DataRepository service as described in TS 29.504 to retrieve and subscribethe ECS Address Configuration Information in the application data in the UDR.
After receiving a successful response from the UDR, the NEF shall:
- send HTTP "200 OK" response (as shown in Figure 4.5.2.2.3-1, step 2a) with a response body containing a representation of the updated subscription in the EcsAddrCfgInfoSub data type; or
- send HTTP "204 No Content" response (as shown in Figure 4.5.2.2.3-1, step 2b).
4.5.2.3 Nnef_ECSAddress_Unsubscribe service operation p. 36
4.5.2.3.1 General p. 36
This service operation is used by an NF service consumer to explicitly unsubscribe the notification of ECS Address Configuration Information.
The following procedure using the Nnef_ECSAddress_Unsubscribe service operation is supported:
- unsubscription from the notification of ECS Address Configuration Information.
4.5.2.3.2 Unsubscription of notification of ECS Address Configuration Information p. 36
Figure 4.5.2.3.2-1 illustrates the unsubscription of event notifications from NEF.
In order to delete an existing subscription to ECS Address Configuration Information, the NF service consumer shall send an HTTP DELETE request message with "{apiRoot}/nnef-ecs-addr-cfg-info/<apiVersion>/subscriptions/{subscriptionId}" as request URI, as shown in step 1 of Figure 4.5.2.3.2-1, where "{subscriptionId}" is the subscription identifier of the existing subscription resource that is to be deleted.
Upon successful reception of an HTTP DELETE, the NEF shall delete the individual resource and shall respond to the NF service consumer with an HTTP "204 No Content" response message, as shown in step 2 of Figure 4.5.2.3.2-1.
If the received HTTP DELETE request needs to be redirected, the NEF shall send an HTTP redirect response as specified in clause 6.10.9 of TS 29.500.
If errors occur when processing the HTTP DELETE request, the NEF shall send an HTTP error response as specified in clause 5.4.7.
4.5.2.4 Nnef_ECSAddress_Notify service operation p. 36
4.5.2.4.1 General p. 36
The Nnef_ECSAddress_Notify service operation enables the NEF to notify the ECS Address Configuration Information to the NF service consumer.
The following procedure using the Nnef_ECSAddress_Notify service operation is supported:
- notification about subscribed ECS Address Configuration Information.
4.5.2.4.2 Notification of changes of ECS Address Configuration Information p. 36
Figure 4.5.2.4.2-1 illustrates the notification about ECS Address Configuration Information.
If the NEF observes ECS Address Configuration Information that an NF service consumer has subscribed, the NEF shall send an HTTP POST request as shown in step 1 of Figure 4.5.2.4.2-1, with the "{notifUri}" as request URI containing the value previously provided by the NF service consumer within the corresponding subscription, and the EcsAddrCfgInfoNotification data structure as request body.
The EcsAddrCfgInfoNotification data structure shall include:
- the notification correlation identifier in the "notifCorrId" attribute;
- the ECS Address Configuration Information within the "ecsAddrCfgInfo" attribute.
