5 Npcf_AMPolicyControl API
29.5073GPP5G SystemAccess and Mobility Policy Control ServiceRelease 18Stage 3TS
5.1 Introduction
The Access and Mobility Policy Control Service shall use the Npcf_AMPolicyControl API.
The API URI of the Npcf_AMPolicyControl API shall be:
{apiRoot}/<apiName>/<apiVersion>
The request URIs used in HTTP requests from the NF service consumer towards the PCF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [6], i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in 3GPP TS 29.501 [6].
– The <apiName> shall be "npcf-am-policy-control".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 5.3.
5.2 Usage of HTTP
5.2.1 General
HTTP/2, IETF RFC 7540 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [5].
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5].
The OpenAPI [10] specification of HTTP messages and content bodies for the Npcf_AMPolicyControl is contained in Annex A.
5.2.2 HTTP standard headers
5.2.2.1 General
See clause 5.2.2 of 3GPP TS 29.500 [5] for the usage of HTTP standard headers.
5.2.2.2 Content type
JSON, IETF RFC 8259 [9], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [5] 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 [21].
5.2.3 HTTP custom headers
The Npcf_AMPolicyControl API shall support HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [5] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [5].
In this Release of the specification, no specific custom headers are defined for the Npcf_AMPolicyControl API.
5.3 Resources
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 5.3.1-1 depicts the resource URIs structure for the Npcf_AMPolicyControl API.
5.3.1 Resource Structure
Figure 5.3.1-1: Resource URI structure of the Npcf_AMPolicyControl API
Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 5.3.1-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
|
AM Policy Associations |
/policies |
POST |
Create a new Individual AM Policy Association resource. |
|
Individual AM Policy Association |
/policies/{polAssoId} |
GET |
Read the Individual AM Policy Association resource. |
|
DELETE |
Delete the Individual AM Policy Association resource. |
||
|
/policies/{polAssoId}/update |
update (POST) |
Report observed event trigger and obtain updated policies. |
5.3.2 Resource: AM Policy Associations
5.3.2.1 Description
This resource represents a collection of Individual AM policy Associations.
5.3.2.2 Resource definition
Resource URI: {apiRoot}/npcf-am-policy-control/v1/policies
This resource shall support the resource URI variables defined in table 5.3.2.2-1.
Table 5.3.2.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 5.1 |
5.3.2.3 Resource Standard Methods
5.3.2.3.1 POST
This method shall support the URI query parameters specified in table 5.3.2.3.1-1.
Table 5.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.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3.
Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
PolicyAssociationRequest |
M |
1 |
Input parameters for the creation of a policy association. |
Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
PolicyAssociation |
M |
1 |
201 Created |
Policy association was created and policies are being provided. |
|
ProblemDetails |
O |
0..1 |
400 Bad Request |
(NOTE 2) |
|
NOTE 1: 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. NOTE 2: Failure cases are described in clause 5.7. |
||||
Table 5.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}/npcf-am-policy-control/v1/policies/{polAssoId} |
5.3.3 Resource: Individual AM Policy Association
5.3.3.1 Description
This document resource represents an individual AM policy association.
5.3.3.2 Resource definition
Resource URI: {apiRoot}/npcf-am-policy-control/v1/policies/{polAssoId}
This resource shall support the resource URI variables defined in table 5.3.2.2-1.
Table 5.3.2.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 5.1. |
|
polAssoId |
string |
Identifier of a policy association. |
5.3.3.3 Resource Standard Methods
5.3.3.3.1 GET
This method shall support the URI query parameters specified in table 5.3.2.3.1-1.
Table 5.3.3.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3.
Table 5.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.3.3.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
PolicyAssociation |
M |
1 |
200 OK |
|
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during Individual AM policy 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 Individual AM policy 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. |
||||
Table 5.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 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 |
Table 5.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 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 |
5.3.3.3.2 DELETE
This method shall support the URI query parameters specified in table 5.3.3.3.2-1.
Table 5.3.3.3.2-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.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3.
Table 5.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 5.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
The policy association was successfully deleted. |
||
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during Individual AM policy deletion. 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 Individual AM policy deletion. 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 DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. |
||||
Table 5.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 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 |
Table 5.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 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 |
5.3.3.4 Resource Custom Operations
5.3.3.4.1 Overview
Table 5.3.3.4.1-1: Custom operations
|
Operation Name |
Custom operation URI |
Mapped HTTP method |
Description |
|
Update |
/policies/{polAssoId}/update |
POST |
Report observed event trigger and obtain updated policies. |
5.3.3.4.2 Operation: Update
5.3.3.4.2.1 Description
The update custom operation allows an NF service consumer to report the occurrence of one or more policy control request trigger(s) and to obtain related updated policies.
5.3.3.4.2.2 Operation Definition
This operation shall support the request data structures specified in table 5.3.3.4.2.2-1 and the response data structure and response codes specified in table 5.3.3.4.2.2-2.
Table 5.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
PolicyAssociationUpdateRequest |
M |
1 |
Describes the observed policy control request trigger(s). |
Table 5.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
||||
|
PolicyUpdate |
M |
1 |
200 OK |
Describes updated policies. |
||||
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during Individual AM policy 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 Individual AM policy 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. |
||||
|
ProblemDetails |
O |
0..1 |
400 Bad Request |
(NOTE 2) |
||||
|
ProblemDetails |
O |
0..1 |
404 Not Found |
(NOTE 2) |
||||
|
NOTE 1: 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. NOTE 2: Failure cases are described in clause 5.7. |
||||||||
Table 5.3.3.4.2.2-3: 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 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 |
Table 5.3.3.4.2.2-4: 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 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 |
5.4 Custom Operations without associated resources
None.
5.5 Notifications
5.5.1 General
Table 5.5.1-1: Notifications overview
|
Notification |
Callback URI |
HTTP method or custom operation |
Description (service operation) |
|
Policy Update Notification |
{notificationUri}/update |
update (POST) |
Policy Update Notification. |
|
Request for termination of the policy association |
{notificationUri}/terminate |
terminate (POST) |
Request for termination of the policy association. |
5.5.2 Policy Update Notification
5.5.2.1 Description
This notification is used by the PCF to provide updates of access and mobility policies to the NF service consumer.
5.5.2.2 Operation Definition
This operation shall support the request data structures specified in table 5.5.2.2-1 and the response data structure and response codes specified in table 5.5.2.2-2.
Table 5.5.2.2-1: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
PolicyUpdate |
M |
1 |
Updated policies. |
Table 5.5.2.2-2: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
The policies were successfully updated. |
||
|
AmRequestedValueRep |
O |
0..1 |
200 OK |
The current applicable values corresponding to the policy control request trigger are reported. |
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during AM policy 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 AM policy 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 as defined in clause 6.5.3.2 of 3GPP TS 29.500 [5]. Applicable if the feature "ES3XX" is supported. |
|
ProblemDetails |
O |
0..1 |
400 Bad Request |
(NOTE 2) |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
The NF service consumer can use this response when the notification can be sent to another unknown host. |
|
NOTE 1: 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. NOTE 2: Failure cases are described in clause 5.7. |
||||
Table 5.5.2.2-3: 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 consumer (service) instance towards which the notification request is redirected. May be included if the feature "ES3XX" is supported. |
Table 5.5.2.2-4: 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.5.3 Request for termination of the policy association
5.5.3.1 Description
This notification is used by the PCF to request the termination of a policy association.
5.5.3.2 Operation Definition
This operation shall support the request data structures specified in table 5.5.3.2-1 and the response data structure and response codes specified in table 5.5.3.2-2.
Table 5.5.3.2-1: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
TerminationNotification |
M |
1 |
Request to terminate the policy association. |
Table 5.5.3.2-2: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
The request for policy association termination was received. |
||
|
RedirectResponse |
O |
0..1 |
307 temporary redirect |
Temporary redirection, during AM policy 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 AM policy 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. |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
The NF service consumer can use this response when the notification can be sent to another unknown host. |
|
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. |
||||
Table 5.5.3.2-3: 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 consumer (service) instance towards which the notification request is redirected. May be included if the feature "ES3XX" is supported. |
Table 5.5.3.2-4: 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 consumer (service) instance towards which the notification request is redirected |
5.6 Data Model
5.6.1 General
This clause specifies the application data model supported by the API.
Table 5.6.1-1 specifies the data types defined for the Npcf_AMPolicyControl service based interface protocol.
Table 5.6.1-1: Npcf_AMPolicyControl specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
|
AsTimeDistributionParam |
5.6.2.10 |
Contains the 5G access stratum time distribution parameters. |
5GAccessStratumTime |
|
CandidateForReplacement |
5.6.2.8 |
Contains the list of candidate DNNs for replacement per S-NSSAI. |
DNNReplacementControl |
|
PolicyAssociation |
5.6.2.2 |
Description of a policy association that is returned by the PCF when a policy Association is created, or read. |
|
|
PolicyAssociationReleaseCause |
5.6.3.4 |
The cause why the PCF requests the termination of the policy association. |
|
|
PolicyAssociationRequest |
5.6.2.3 |
Information that NF service consumer provides when requesting the creation of a policy association. |
|
|
PolicyAssociationUpdateRequest |
5.6.2.4 |
Information that NF service consumer provides when requesting the update of a policy association. |
|
|
PolicyUpdate |
5.6.2.5 |
Updated policies that the PCF provides in a notification or in the reply to an Update Request. |
|
|
RequestTrigger |
5.6.3.3 |
Enumeration of possible Request Triggers. |
|
|
SmfSelectionData |
5.6.2.7 |
Includes the SMF Selection information that may be replaced by the PCF. |
DNNReplacementControl |
|
TerminationNotification |
5.6.2.6 |
Request to terminate a policy Association that the PCF provides in a notification. |
|
|
AmRequestedValueRep |
5.6.2.9 |
Contains the current applicable values corresponding to the policy control request triggers. |
ImmediateReport |
|
UeSliceMbr |
5.6.2.11 |
Contains a UE-Slice-MBR and the related information. |
UE-Slice-MBR_Authorization |
Table 5.6.1-2 specifies data types re-used by the Npcf_AMPolicyControl 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 Npcf_AMPolicyControl service based interface.
Table 5.6.1-2: Npcf_AMPolicyControl re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
AccessType |
3GPP TS 29.571 [11] |
||
|
Ambr |
3GPP TS 29.571 [11] |
Aggregated Maximum Bit Rate. |
UE-AMBR_Authorization |
|
Dnn |
3GPP TS 29.571 [11] |
DNN |
DNNReplacementControl |
|
Fqdn |
3GPP TS 29.571 [11] |
FQDN |
|
|
Gpsi |
3GPP TS 29.571 [11] |
Generic Public Subscription Identifier |
|
|
GroupId |
3GPP TS 29.571 [11] |
||
|
Guami |
3GPP TS 29.571 [11] |
Globally Unique AMF Identifier |
|
|
Ipv4Addr |
3GPP TS 29.571 [11] |
||
|
Ipv6Addr |
3GPP TS 29.571 [11] |
||
|
MappingOfSnssai |
3GPP TS 29.531 [24] |
Identifies the mapping of an S-NSSAI of the Allowed NSSAI to the corresponding S-NSSAI of the HPLMN. |
DNNReplacementControl |
|
NwdafData |
3GPP TS 29.512 [27] |
Indicates the list of NWDAF instance IDs used for the UE and their associated Analytics ID(s) consumed by the NF service consumer. |
EneNA |
|
PcfUeCallbackInfo |
3GPP TS 29.571 [11] |
Contains the PCF for the UE information necessary for the PCF for the PDU session to send Establishment and Termination event. |
AMInfluence |
|
PduSessionInfo |
3GPP TS 29.571 [11] |
Contains information related to a PDU session. |
AMInfluence |
|
Pei |
3GPP TS 29.571 [11] |
Permanent Equipment Identifier |
|
|
PlmnIdNid |
3GPP TS 29.571 [11] |
Identifies the network: PLMN Identifier or the SNPN Identifier (the PLMN Identifier and the NID). |
|
|
PresenceInfo |
3GPP TS 29.571 [11] |
Presence reporting area information |
|
|
PresenceInfoRm |
3GPP TS 29.571 [11] |
This data type is defined in the same way as the "PresenceInfo" data type, but with the OpenAPI "nullable: true" property. |
|
|
ProblemDetails |
3GPP TS 29.571 [11] |
||
|
RedirectResponse |
3GPP TS 29.571 [11] |
Contains redirection related information. |
ES3XX |
|
Uri |
3GPP TS 29.571 [11] |
||
|
UserLocation |
3GPP TS 29.571 [11] |
||
|
RatType |
3GPP TS 29.571 [11] |
||
|
RfspIndex |
3GPP TS 29.571 [11] |
||
|
ServiceAreaRestriction |
3GPP TS 29.571 [11] |
Within the areas attribute, only tracking area codes shall be included. |
|
|
ServiceName |
3GPP TS 29.510 [13] |
Name of the service instance. |
|
|
SliceMbr |
3GPP TS 29.571 [11] |
Contains the slice Maximum Bit Rate including UL and DL. |
UE-Slice-MBR_Authorization |
|
Snssai |
3GPP TS 29.571 [11] |
Identifies an S-NSSAI. |
SliceSupport, TargetNSSAI, DNNReplacementControl |
|
Supi |
3GPP TS 29.571 [11] |
Subscription Permanent Identifier |
|
|
SupportedFeatures |
3GPP TS 29.571 [11] |
Used to negotiate the applicability of the optional features defined in table 5.8-1. |
|
|
TimeZone |
3GPP TS 29.571 [11] |
||
|
TraceData |
3GPP TS 29.571 [11] |
||
|
UintegerRm |
3GPP TS 29.571 [11] |
Indicates Unsigned Integer, but with the OpenAPI "nullable: true" property. |
5GAccessStratumTime |
|
WirelineServiceAreaRestriction |
3GPP TS 29.571 [11] |
WirelineWirelessConvergence |
5.6.2 Structured data types
5.6.2.1 Introduction
This clause defines the structures to be used in resource representations.
5.6.2.2 Type PolicyAssociation
Table 5.6.2.2-1: Definition of type PolicyAssociation
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
request |
PolicyAssociationRequest |
O |
0..1 |
The information provided by the NF service consumer when requesting the creation of a policy association |
|
|
triggers |
array(RequestTrigger) |
O |
1..N |
Request Triggers that the PCF subscribes. Only values "LOC_CH", "ALLOWED_NSSAI_CH", "TARGET_NSSAI", "SMF_SELECT_CH", "PRA_CH" and "ACCESS_TYPE_CH" are permitted. |
(NOTE 1) |
|
servAreaRes |
ServiceAreaRestriction |
O |
0..1 |
Service Area Restriction as part of the AMF Access and Mobility Policy as determined by the PCF |
|
|
wlServAreaRes |
WirelineServiceAreaRestriction |
O |
0..1 |
Wireline Service Area Restriction as part of the AMF Access and Mobility Policy as determined by the PCF |
WirelineWirelessConvergence |
|
rfsp |
RfspIndex |
O |
0..1 |
RFSP Index as part of the AMF Access and Mobility Policy as determined by the PCF. |
|
|
targetRfsp |
RfspIndex |
C |
0..1 |
RFSP Index associated with the Target NSSAI. It shall be present if the Target NSSAI was received in the request and the trigger "TARGET_NSSAI" is provided. |
TargetNSSAI |
|
pras |
map(PresenceInfo) |
C |
1..N |
If the Trigger "PRA_CH" is provided, the presence reporting area(s) for which reporting is requested shall be provided. The "praId" attribute within the PresenceInfo data type shall also be the key of the map. The "presenceState" and the "additionalPraId" attributes within the PresenceInfo data type shall not be supplied. The "praId" attribute within the PresenceInfo data type shall include the identifier of either a presence reporting area or a presence reporting area set. |
|
|
smfSelInfo |
SmfSelectionData |
O |
0..1 |
If the trigger "SMF_SELECT_CH" is provided, the conditions for SMF selection information replacement, as determined by the PCF shall be provided. |
DNNReplacementControl |
|
ueAmbr |
Ambr |
O |
0..1 |
UE-AMBR as part of the AMF Access and Mobility Policy as determined by the PCF. |
UE-AMBR_Authorization |
|
ueSliceMbrs |
array(UeSliceMbr) |
O |
1..N |
One or more UE-Slice-MBR(s) for S-NSSAI(s) of serving PLMN as part of the AMF Access and Mobility Policy as determined by the PCF. |
UE-Slice-MBR_Authorization |
|
pcfUeInfo |
PcfUeCallbackInfo |
O |
0..1 |
Contains the PCF for the UE information necessary for the PCF for the PDU session to send established/terminated events notifications to the PCF for the UE. |
AMInfluence |
|
matchPdus |
array(PduSessionInfo) |
C |
1..N |
Indicates the matched PDU session(s) for which the PCF for the UE information in the "pcfUeInfo" attribute shall be forwarded to the SMF. It shall be present when the "pcfUeInfo" attribute is present. (NOTE 2) |
AMInfluence |
|
asTimeDisParam |
AsTimeDistributionParam |
O |
0..1 |
Contains the 5G acess stratum time distribution parameters. |
5GAccessStratumTime |
|
suppFeat |
SupportedFeatures |
M |
1 |
Indicates the negotiated supported features. |
|
|
NOTE 1: The "ALLOWED_NSSAI_CH", "TARGET_NSSAI", "SMF_SELECT_CH" and "ACCESS_TYPE_CH" values in the "triggers" attribute apply under feature control as described in clause 4.2.3.2. NOTE 2: The DNN encoded within the PduSessionInfo element(s) of the "matchPdus" array contains a full DNN or only the DNN Network Identifier based on the DNN provided by the AF to the PCF in the AmInfluence API, as specified in 3GPP TS 29.522 [32]. When the DNN contains the Network Identifier only, the AMF shall match a PDU session for the received Network Identifier and for any value of the Operator Identifier. |
|||||
5.6.2.3 Type PolicyAssociationRequest
Table 5.6.2.3-1: Definition of type PolicyAssociationRequest
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|||||
|
notificationUri |
Uri |
M |
1 |
Identifies the recipient of Notifications sent by the PCF. |
||||||
|
altNotifIpv4Addrs |
array(Ipv4Addr) |
O |
1..N |
Alternate or backup IPv4 Address(es) where to send Notifications. |
||||||
|
altNotifIpv6Addrs |
array(Ipv6Addr) |
O |
1..N |
Alternate or backup IPv6 Address(es) where to send Notifications. |
||||||
|
altNotifFqdns |
array(Fqdn) |
O |
1..N |
Alternate or backup FQDN(s) where to send Notifications. |
||||||
|
supi |
Supi |
M |
1 |
Subscription Permanent Identifier. |
||||||
|
gpsi |
Gpsi |
C |
0..1 |
Generic Public Subscription Identifier. Shall be provided when available. |
||||||
|
accessType |
AccessType |
C |
0..1 |
The Access Type where the served UE is camping. Shall be provided when available. |
||||||
|
accessTypes |
array(AccessType) |
C |
1..N |
The Access Types where the served UE is camping. Shall be provided when available. |
MultipleAccessTypes |
|||||
|
pei |
Pei |
C |
0..1 |
The Permanent Equipment Identifier of the served UE. Shall be provided when available. |
||||||
|
userLoc |
UserLocation |
C |
0..1 |
The location of the served UE. Shall be provided when available. |
||||||
|
timeZone |
TimeZone |
C |
0..1 |
The time zone where the served UE is camping. Shall be provided when available. |
||||||
|
servingPlmn |
PlmnIdNid |
C |
0..1 |
The serving network (a PLMN or an SNPN) where the served UE is camping. For the SNPN the NID together with the PLMN ID identifies the SNPN. Shall be provided when available. |
||||||
|
ratType |
RatType |
C |
0..1 |
The 3GPP RAT Type where the served UE is camping. Shall be provided when available. |
||||||
|
ratTypes |
array(RatType) |
C |
1..N |
The 3GPP and non-3GPP RAT Types where the served UE is camping. Shall be provided when available. |
MultipleAccessTypes |
|||||
|
groupIds |
array(GroupId) |
C |
1..N |
List of Internal Group Identifiers of the served UE. Shall be provided when available. |
||||||
|
servAreaRes |
ServiceAreaRestriction |
C |
0..1 |
Service Area Restriction as part of the AMF Access and Mobility Policy. Shall be provided when available. |
||||||
|
wlServAreaRes |
WirelineServiceAreaRestriction |
O |
0..1 |
Wireline Service Area Restriction as part of the AMF Access and Mobility Policy as determined by the PCF |
WirelineWirelessConvergence |
|||||
|
rfsp |
RfspIndex |
C |
0..1 |
RFSP Index as part of the AMF Access and Mobility Policy. Shall be provided when available. |
||||||
|
ueAmbr |
Ambr |
C |
0..1 |
UE-AMBR as part of the AMF Access and Mobility Policy. Shall be provided when available. |
UE-AMBR_Authorization |
|||||
|
ueSliceMbrs |
array(UeSliceMbr) |
C |
1..N |
The subscribed UE-Slice-MBR for each subscribed S-NSSAI of the home PLMN mapping to a S-NSSAI of the serving PLMN. Shall be provided when available. (NOTE) |
UE-Slice-MBR_Authorization |
|||||
|
allowedSnssais |
array(Snssai) |
C |
1..N |
Represents the Allowed NSSAI in the 3GPP access and includes the S-NSSAIs values the UE can use in the serving PLMN. It shall be included if the feature "SliceSupport" or the feature "DNNReplacementControl" is supported in the AMF. |
SliceSupport, DNNReplacementControl |
|||||
|
targetSnssais |
array(Snssai) |
C |
1..N |
Represents the Target NSSAI. It shall be included if available and the feature "TargetNSSAI" is supported. |
TargetNSSAI |
|||||
|
mappingSnssais |
array(MappingOfSnssai) |
C |
1..N |
The mapping of each S-NSSAI of the Allowed NSSAI to the corresponding S-NSSAI of the HPLMN. It shall be included if available. If the feature "MultipleAccessTypes" is supported, this attribute contains also the mapping of the Allowed NSSAI in the non-3GPP access to the corresponding S-NSSAI of the HPLMN. |
DNNReplacementControl |
|||||
|
n3gAllowedSnssais |
array(Snssai) |
C |
1..N |
Represents the Allowed NSSAI in the non-3GPP access and includes the S-NSSAIs values the UE can use in the serving PLMN. It shall be included if the feature "MultipleAccessTypes" and, the feature "SliceSupport" or "DNNReplacementControl" are supported in the AMF and the UE is registered in the non-3GPP access. |
SliceSupport, MultipleAccessTypes, DNNReplacementControl |
|||||
|
guami |
Guami |
C |
0..1 |
The Globally Unique AMF Identifier (GUAMI) shall be provided by an AMF as service consumer. |
||||||
|
serviceName |
ServiceName |
O |
0..1 |
If the NF service consumer is an AMF, it should provide the name of a service produced by the AMF that makes use of information received within the Npcf_AMPolicyControl_UpdateNotify service operation. |
||||||
|
suppFeat |
SupportedFeatures |
M |
1 |
Indicates the features supported by the service consumer. |
||||||
|
traceReq |
TraceData |
C |
0..1 |
Trace control and configuration parameters information defined in 3GPP TS 32.422 [18] shall be included if trace is required to be activated. |
||||||
|
nwdafDatas |
array(NwdafData) |
O |
1..N |
List of NWDAF Instance IDs and their associated Analytics IDs consumed by the NF service consumer. |
EneNA |
|||||
|
NOTE: If the serving PLMN is not the HPLMN, then within the "ueSliceMbrs" attribute, there shall not be more than one array item with the same "servingSnssai" attribute’s value in this release of the specification. |
||||||||||
5.6.2.4 Type PolicyAssociationUpdateRequest
Table 5.6.2.4-1: Definition of type PolicyAssociationUpdateRequest
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
||||||
|
notificationUri |
Uri |
O |
0..1 |
Identifies the recipient of Notifications sent by the PCF. |
|||||||
|
altNotifIpv4Addrs |
array(Ipv4Addr) |
O |
1..N |
Alternate or backup IPv4 Address(es) where to send Notifications. |
|||||||
|
altNotifIpv6Addrs |
array(Ipv6Addr) |
O |
1..N |
Alternate or backup IPv6 Address(es) where to send Notifications. |
|||||||
|
altNotifFqdns |
array(Fqdn) |
O |
1..N |
Alternate or backup FQDN(s) where to send Notifications. |
|||||||
|
triggers |
array(RequestTrigger) |
C |
1..N |
Request Triggers that the NF service consumer observes. |
|||||||
|
servAreaRes |
ServiceAreaRestriction |
C |
0..1 |
Service Area Restriction as part of the AMF Access and Mobility Policy. Shall be provided for trigger "SERV_AREA_CH". |
|||||||
|
wlServAreaRes |
WirelineServiceAreaRestriction |
C |
0..1 |
Wireline Service Area Restriction as part of the AMF Access and Mobility Policy. Shall be provided for trigger "SERV_AREA_CH". |
WirelineWirelessConvergence |
||||||
|
rfsp |
RfspIndex |
C |
0..1 |
RFSP Index as part of the AMF Access and Mobility Policy. Shall be provided for trigger "RFSP_CH". |
|||||||
|
smfSelInfo |
SmfSelectionData |
C |
0..1 |
The UE requested S-NSSAI and UE requested DNN. Shall be provided for trigger "SMF_SELECT_CH". |
DNNReplacementControl |
||||||
|
ueAmbr |
Ambr |
C |
0..1 |
UE-AMBR as part of the AMF Access and Mobility Policy. Shall be provided for trigger "UE_AMBR_CH". |
UE-AMBR_Authorization |
||||||
|
ueSliceMbrs |
array(UeSliceMbr) |
C |
1..N |
The subscribed UE-Slice-MBR for each subscribed S-NSSAI of the home PLMN mapping to a S-NSSAI of the serving PLMN. Shall be provided for the "UE_SLICE_MBR_CH" policy control request trigger. (NOTE) |
UE-Slice-MBR_Authorization |
||||||
|
praStatuses |
map(PresenceInfo) |
C |
1..N |
If the Trigger "PRA_CH" is reported, the UE presence status for tracking area for which changes of the UE presence occurred shall be provided. The "praId" attribute within the PresenceInfo data type shall also be the key of the map. The "presenceState" attribute within the PresenceInfo data type shall be supplied. The "additionalPraId" attribute within the PresenceInfo data type shall not be supplied. The "praId" attribute within the PresenceInfo data type shall include the identifier of an individual presence reporting area. |
|||||||
|
userLoc |
UserLocation |
C |
0..1 |
The location of the served UE shall be provided for trigger "LOC_CH". |
|||||||
|
allowedSnssais |
array(Snssai) |
C |
1..N |
Represents the Allowed NSSAI in the 3GPP access and includes the S-NSSAIs values the UE can use in the serving PLMN. It shall be provided for trigger "ALLOWED_NSSAI_CH". |
SliceSupport, DNNReplacementControl |
||||||
|
targetSnssais |
array(Snssai) |
C |
1..N |
Represents the Target NSSAI. It shall be provided for the trigger "TARGET_NSSAI". |
TargetNSSAI |
||||||
|
mappingSnssais |
array(MappingOfSnssai) |
O |
1..N |
The mapping of each S-NSSAI of the Allowed NSSAI to the corresponding S-NSSAI of the HPLMN. It shall be provided for trigger "ALLOWED_NSSAI_CH" if available. If the feature "MultipleAccessTypes" is supported, this attribute contains also the mapping of the Allowed NSSAI in the non-3GPP access to the corresponding S-NSSAI of the HPLMN. |
DNNReplacementControl |
||||||
|
n3gAllowedSnssais |
array(Snssai) |
C |
1..N |
Represents the Allowed NSSAI in the non-3GPP access and includes the S-NSSAIs values the UE can use in the serving PLMN. It shall be provided for trigger "ALLOWED_NSSAI_CH" when the feature "MultipleAccessTypes" is supported. |
SliceSupport, MultipleAccessTypes, DNNReplacementControl |
||||||
|
accessTypes |
array(AccessType) |
C |
1..N |
The Access Types where the served UE is camping. Shall be provided for trigger "ACCESS_TYPE_CH". |
MultipleAccessTypes |
||||||
|
ratTypes |
array(RatType) |
C |
1..N |
The 3GPP RAT Type and non-3GPP RAT Type where the served UE is camping. Shall be provided for trigger "ACCESS_TYPE_CH". |
MultipleAccessTypes |
||||||
|
traceReq |
TraceData |
C |
0..1 |
Trace control and configuration parameters information defined in 3GPP TS 32.422 [18] shall be included if trace is required to be activated, modified or deactivated. For trace modification, it shall contain a complete replacement of trace data. For trace deactivation, it shall contain the Null value. |
|||||||
|
guami |
Guami |
C |
0..1 |
The Globally Unique AMF Identifier (GUAMI) shall be provided by an AMF as service consumer during the AMF relocation. |
|||||||
|
nwdafDatas |
array(NwdafData) |
O |
1..N |
List of NWDAF Instance IDs and their associated Analytics IDs consumed by the NF service consumer. |
EneNA |
||||||
|
suppFeat |
SupportedFeatures |
C |
0..1 |
Indicates the features supported by the NF service consumer. |
FeatureRenegotiation |
||||||
|
NOTE: If the serving PLMN is not the HPLMN, then within the "ueSliceMbrs" attribute, there shall not be more than one array item with the same "servingSnssai" attribute’s value in this release of the specification. |
|||||||||||
Editor’s Note: It is FFS whether other new attributes need to be added when the PolicyAssociationUpdateRequest data type is used to report the target AMF supported features.
5.6.2.5 Type PolicyUpdate
Table 5.6.2.5-1: Definition of type PolicyUpdate
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|||
|
resourceUri |
Uri |
M |
1 |
The resource URI of the individual AM policy related to the notification. (NOTE 3) |
||||
|
triggers |
array(RequestTrigger) |
O |
1..N |
Request Triggers that the PCF subscribes. Only values "LOC_CH", "ALLOWED_NSSAI_CH", "TARGET_NSSAI", "SMF_SELECT_CH", "PRA_CH" and "ACCESS_TYPE_CH" are permitted. |
(NOTE 1) (NOTE 2) |
|||
|
servAreaRes |
ServiceAreaRestriction |
O |
0..1 |
Service Area Restriction as part of the AMF Access and Mobility Policy as determined by the PCF. |
||||
|
wlServAreaRes |
WirelineServiceAreaRestriction |
O |
0..1 |
Wireline Service Area Restriction as part of the AMF Access and Mobility Policy as determined by the PCF |
WirelineWirelessConvergence |
|||
|
rfsp |
RfspIndex |
O |
0..1 |
RFSP Index as part of the AMF Access and Mobility Policy as determined by the PCF. |
||||
|
targetRfsp |
RfspIndex |
C |
0..1 |
RFSP Index associated with the Target NSSAI. It shall be present when the Target NSSAI was received in the request. |
TargetNSSAI |
|||
|
smfSelInfo |
SmfSelectionData |
C |
0..1 |
It may include updated conditions for SMF Selection information replacement. It shall include the PCF decision of the selected DNN when the "smfSelInfo" attribute containing the UE requested S-NSSAI and DNN was sent in the request. |
DNNReplacementControl |
|||
|
ueAmbr |
Ambr |
C |
0..1 |
UE-AMBR as part of the AMF Access and Mobility Policy. |
UE-AMBR_Authorization |
|||
|
ueSliceMbrs |
array(UeSliceMbr) |
O |
0..1 |
One or more UE-Slice-MBR(s) for S-NSSAI(s) of serving PLMN as part of the AMF Access and Mobility Policy as determined by the PCF. |
UE-Slice-MBR_Authorization |
|||
|
pras |
map(PresenceInfoRm) |
C |
1..N |
If the Trigger "PRA_CH" is provided or if that trigger was already set but the requested presence reporting areas need to be changed, the presence reporting area(s) for which reporting is requested shall be provided. The "praId" attribute within the PresenceInfo data type shall also be the key of the map. The "presenceState" attribute within the PresenceInfo data type shall not be supplied. The "praId" attribute within the PresenceInfo data type shall include the identifier of either a presence reporting area or a presence reporting area set. |
||||
|
pcfUeInfo |
PcfUeCallbackInfo |
O |
0..1 |
Contains the PCF for the UE information necessary for the PCF for the PDU session to send established/terminated event notifications to the PCF for the UE. |
AMInfluence |
|||
|
matchPdus |
array(PduSessionInfo) |
C |
1..N |
Indicates the matched PDU session(s) for which the PCF for the UE information in the "pcfUeInfo" attribute shall be forwarded to the SMF. It shall be present when the "pcfUeInfo" attribute is present and was not previously provisioned by the PCF for the UE. (NOTE 4) |
AMInfluence |
|||
|
asTimeDisParam |
AsTimeDistributionParam |
O |
0..1 |
Contains the 5G acess stratum time distribution parameters. |
5GAccessStratumTime |
|||
|
suppFeat |
SupportedFeatures |
C |
0..1 |
Indicates the negotiated supported features. |
FeatureRenegotiation |
|||
|
NOTE 1: The "ALLOWED_NSSAI_CH", "TARGET_NSSAI", "SMF_SELECT_CH" and "ACCESS_TYPE_CH" values in the "triggers" attribute apply under feature control as described in clause 4.2.3.2. NOTE 2: The "SMF_SELECT_CH" trigger may be met only for new PDU sessions, i.e. it shall not apply to ongoing PDU sessions. NOTE 3: When the PolicyUpdate data type is used in a policy update notify service operation, either the complete resource URI included in the "resourceUri" attribute or the "apiSpecificResourceUriPart" component (see clause 5.1) of the resource URI included in the "resourceUri" attribute may be used by the NF service consumer (e.g. AMF) for the identification of the Individual AM Policy Association resource related to the notification. NOTE 4: The DNN encoded within the PduSessionInfo element(s) of the "matchPdus" array contains a full DNN or only the DNN Network Identifier based on the DNN provided by the AF to the PCF in the AmInfluence API, as specified in 3GPP TS 29.522 [32]. When the DNN contains the Network Identifier only, the AMF shall match a PDU session for the received Network Identifier and for any value of the Operator Identifier. |
||||||||
Editor’s Note: It is FFS whether other new attributes need to be added when the PolicyUpdate data type is used to report the negotiated supported features.
5.6.2.6 Type TerminationNotification
Table 5.6.2.6-1: Definition of type TerminationNotification
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
resourceUri |
Uri |
M |
1 |
The resource URI of the individual AM policy related to the notification. (NOTE) |
|
|
cause |
PolicyAssociationReleaseCause |
M |
1 |
The cause why the PCF requests the termination of the policy association. |
|
|
NOTE: Either the complete resource URI included in the "resourceUri" attribute or the "apiSpecificResourceUriPart" component (see clause 5.1) of the resource URI included in the "resourceUri" attribute may be used by the NF service consumer (e.g. AMF) for the identification of the Individual AM Policy Association resource related to the notification. |
|||||
5.6.2.7 Type SmfSelectionData
Table 5.6.2.7-1: Definition of type SmfSelectionData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
unsuppDnn |
boolean |
O |
0..1 |
When it is set to "true", the NF service consumer shall request DNN replacement when the UE requested an unsupported DNN at PDU session establishment request. The default value is "false". |
|
|
candidates |
map(CandidateForReplacement) |
O |
1..N |
Contains the list of DNNs per S-NSSAI that are candidate for replacement. The "snssai" attribute within the CandidateForReplacement data type shall also be the key of the map. (NOTE 2) |
|
|
snssai |
Snssai |
C |
0..1 |
It shall be included in AM policy association update requests and represents the allowed S-NSSAI the UE includes in the PDU session establishment request. |
|
|
mappingSnssai |
Snssai |
O |
0..1 |
It may be included in AM policy association update requests and represents the home mapping of the allowed S-NSSAI the UE includes in the PDU session establishment request. |
|
|
dnn |
Dnn |
C |
0..1 |
It shall be included in AM policy association update requests and represents the UE requested DNN. It shall be included in AM policy association update response and represents the PCF selected DNN. The DNN shall contain the Network Identifier only. (NOTE 3) |
|
|
NOTE 1: Either one of the "unsuppDnn" attribute and "candidates" attribute, or both attributes shall be present when the "smfSelInfo" attribute is included in the PolicyAssociation type or PolicyUpdate type when included in the Npcf_AMPolicyControl_UpdateNotify request. NOTE 2: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571[11], clause 5.4.4.2. NOTE 3: The AMF shall match a PDU session for the received Network Identifier and replace it by the received selected Network Identifier for any Operator Identifier value. |
|||||
5.6.2.8 Type CandidateForReplacement
Table 5.6.2.8-1: Definition of type CandidateForReplacement
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
snssai |
Snssai |
M |
1 |
The S-NSSAI in the serving PLMN. It shall contain a S-NSSAI within the Allowed NSSAI. |
|
|
dnns |
array(Dnn) |
O |
1..N |
List of candidate DNNs for replacement for the S-NSSAI included in the "snssai" attribute. If omitted, any DNN for the provided S-NSSAI is candidate for replacement. The DNN shall contain the Network Identifier only. (NOTE) |
|
|
NOTE: The AMF shall match the PDU session that contain a candidate DNN Network Identifier for any Operator Identifier value. |
|||||
5.6.2.9 Type AmRequestedValueRep
Table 5.6.2.9-1: Definition of type AmRequestedValueRep
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
userLoc |
UserLocation |
O |
0..1 |
The location of the served UE is camping. |
|
|
praStatuses |
map(PresenceInfo) |
O |
1..N |
The UE presence statuses for tracking areas. The "praId" attribute within the PresenceInfo data type shall also be the key of the map. |
|
|
accessTypes |
array(AccessType) |
O |
1..N |
The Access Types where the served UE is camping. |
MultipleAccessTypes |
|
ratTypes |
array(RatType) |
O |
1..N |
The 3GPP RAT Type and non-3GPP RAT Type where the served UE is camping. |
MultipleAccessTypes |
|
allowedSnssais |
array(Snssai) |
O |
1..N |
The Allowed NSSAI in the 3GPP access and includes the S-NSSAIs values the UE can use in the serving PLMN. |
SliceSupport, DNNReplacementControl |
|
n3gAllowedSnssais |
array(Snssai) |
O |
1..N |
The Allowed NSSAI in the non-3GPP access and includes the S-NSSAIs values the UE can use in the serving PLMN when the UE is registered in the non-3GPP access. |
SliceSupport, MultipleAccessTypes, DNNReplacementControl |
5.6.2.10 Type: AsTimeDistributionParam
Table 5.6.2.10-1: Definition of type AsTimeDistributionParam
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
asTimeDistInd |
boolean |
O |
0..1 |
When this attribute is included and set to true, it indicates that the access stratum time distribution via Uu reference point is activated. When present it shall be set as follows: – true: activated. – false (default): deactivated. |
|
|
uuErrorBudget |
UintegerRm |
O |
0..1 |
Indicates the time synchronization error budget in terms of time units of nanoseconds. |
5.6.2.11 Type UeSliceMbr
Table 5.6.2.11-1: Definition of type UeSliceMbr
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
sliceMbr |
SliceMbr |
M |
1 |
Contains the MBR for uplink and the MBR for downlink. |
|
|
servingSnssai |
Snssai |
M |
1 |
Indicates the S-NSSAI of serving PLMN. |
|
|
mappedHomeSnssai |
Snssai |
C |
0..1 |
Indicates the mapped S-NSSAI of home PLMN. Shall only be provided in the request towards the PCF when serving PLMN is not the HPLMN. |
5.6.3 Simple data types and enumerations
5.6.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous sclauses.
5.6.3.2 Simple data types
The simple data types defined in table 5.6.3.2-1 shall be supported.
Table 5.6.3.2-1: Simple data types
|
Type Name |
Type Definition |
Description |
Applicability |
|
n/a |
5.6.3.3 Enumeration: RequestTrigger
The enumeration RequestTrigger represents the possible Policy Control Request Triggers. It shall comply with the provisions defined in table 5.6.3.3-1.
Table 5.6.3.3-1: Enumeration RequestTrigger
|
Enumeration value |
Description |
Applicability |
|
LOC_CH |
Location change (tracking area): the tracking area of the UE has changed. (NOTE 1) |
|
|
PRA_CH |
Change of UE presence in PRA: the NF service consumer reports the current presence status of the UE in a Presence Reporting Area, and notifies that the UE enters/leaves the Presence Reporting Area. |
|
|
SERV_AREA_CH (NOTE 2) |
Service Area Restriction change: the UDM notifies the NF service consumer that the subscribed service area restriction information has changed. |
|
|
RFSP_CH (NOTE 2) |
RFSP index change: the UDM notifies the NF service consumer that the subscribed RFSP index has changed. |
|
|
ALLOWED_NSSAI_CH |
Allowed NSSAI change: the NF service consumer notifies that the set of UE allowed S-NSSAIs has changed. (NOTE 1) |
SliceSupport, DNNReplacementControl |
|
UE_AMBR_CH (NOTE 2) |
UE-AMBR change: the UDM notifies the NF service consumer that the subscribed UE-AMBR has changed. |
UE-AMBR_Authorization |
|
SMF_SELECT_CH |
SMF selection information change: UE request for an unsupported DNN or UE request for a DNN within the list of DNN candidates for replacement per S-NSSAI. |
DNNReplacementControl |
|
ACCESS_TYPE_CH |
Access Type change: the NF service consumer notifies that the access type and the RAT type combinations available in the NF service consumer for a UE with simultaneous 3GPP and non-3GPP connectivity have changed. (NOTE 1) |
MultipleAccessTypes |
|
UE_SLICE_MBR_CH |
UE-Slice-MBR change: the NF service consumer notifies any changes in the subscribed UE-Slice-MBR for each subscribed S-NSSAI of the home PLMN mapping to a S-NSSAI of the serving PLMN. |
UE-Slice-MBR_Authorization |
|
NWDAF_DATA_CH (NOTE 2) |
Indicates that the NWDAF instance IDs used for the UE and/or associated Analytics IDs have changed. |
EneNA |
|
TARGET_NSSAI |
Generation of Target NSSAI: the NF service consumer notifies that the Target NSSAI was generated. |
TargetNSSAI |
|
NOTE 1: This includes reporting the current value at the time the trigger is provisioned during the update or update notification of the policy association. NOTE 2: The NF service consumer always reports to the PCF. |
||
5.6.3.4 Enumeration: PolicyAssociationReleaseCause
The enumeration PolicyAssociationReleaseCause represents the cause why the PCF requests the termination of the policy association. It shall comply with the provisions defined in table 5.6.3.4-1.
Table 5.6.3.4-1: Enumeration PolicyAssociationReleaseCause
|
Enumeration value |
Description |
Applicability |
|
UNSPECIFIED |
This value is used for unspecified reasons. |
|
|
UE_SUBSCRIPTION |
This value is used to indicate that the session needs to be terminated because the subscription of UE has changed (e.g. was removed). |
|
|
INSUFFICIENT_RES |
This value is used to indicate that the server is overloaded and needs to abort the session. |
5.7 Error handling
5.7.1 General
For the Npcf_AMPolicyControl API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [6]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [5] 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 [5].
In addition, the requirements in the following clauses are applicable for the Npcf_AMPolicyControl API.
5.7.2 Protocol Errors
No specific protocol errors for the Npcf_AMPolicyControl API service are specified.
5.7.3 Application Errors
The application errors defined for the Npcf_AMPolicyControl service are listed in Table 5.7.3-1 and Table 5.7.3-2.
Table 5.7.3-1: Application errors
|
Application Error |
HTTP status code |
Description |
|
USER_UNKNOWN |
400 Bad Request |
The HTTP request is rejected because the end user specified in the request is unknown to the PCF. |
|
ERROR_REQUEST_PARAMETERS |
400 Bad Request |
The HTTP request is rejected because the set of information needed by the PCF for AM Policy selection is incomplete or erroneous or not available for the decision to be made. |
|
PENDING_TRANSACTION |
400 Bad Request |
This error shall be used when the PendingTransaction feature is supported and the PCF receives an incoming request on a policy association while it has an ongoing transaction on the same policy association and cannot handle the request as described in clause 9.2 of 3GPP TS 29.513 [7]. |
|
POLICY_ASSOCIATION_NOT_FOUND |
404 Not Found |
The HTTP request is rejected because no policy association corresponding to the request exists in the PCF. |
|
NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. |
||
Table 5.7.3-2: Application errors when NF service consumer acts as a server to receive a notification
|
Application Error |
HTTP status code |
Description |
|
PENDING_TRANSACTION |
400 Bad Request |
This error shall be used when the PendingTransaction feature is supported and the NF service consumer receives an incoming request on a policy association while it has an ongoing transaction on the same policy association and cannot handle the request as described in clause 9.2 of 3GPP TS 29.513 [7]. (NOTE 1) |
|
NOTE 1: This application error is included in the response to the Policy Update Notification HTTP POST request. NOTE 2: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. |
||
5.8 Feature negotiation
The optional features in table 5.8-1 are defined for the Npcf_AMPolicyControl API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [5].
Table 5.8-1: Supported Features
|
Feature number |
Feature Name |
Description |
|
1 |
SliceSupport |
Indicates the support of AM policies differentiation based on the awareness of the allowed NSSAI. |
|
2 |
PendingTransaction |
This feature indicates support for the race condition handling as defined in 3GPP TS 29.513 [7]. |
|
3 |
UE-AMBR_Authorization |
Indicates the support of UE-AMBR control by the PCF in the serving network. |
|
4 |
DNNReplacementControl |
Indicates the support of DNN replacement control. |
|
5 |
MultipleAccessTypes |
Indicates the support of AM policies for the multiple access types where the served UE is camping. |
|
6 |
WirelineWirelessConvergence |
Indicates the support of Wireline and Wireless access convergence. |
|
7 |
ImmediateReport |
Indicates the support of the current applicable values report corresponding to the policy control request triggers for policy update notification. |
|
8 |
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]. |
|
9 |
UE-Slice-MBR_Authorization |
Indicates the support of UE-Slice-MBR control by the PCF in the serving network. |
|
10 |
AMInfluence |
Indicates the support of the alternative mechanism to support informing the PCF for the UE of PDU session(s) established/terminated events via the delivery of the PCF for the UE information necessary for the PCF for the PDU session to send notifications on PDU session(s) established/terminated events through the AMF and the SMF. |
|
11 |
EneNA |
This feature indicates the support of NWDAF data reporting. |
|
12 |
TargetNSSAI |
Indicates the support for RFSP Index associated with the Target NSSAI. |
|
13 |
5GAccessStratumTime |
This feature indicates the support of 5G acess stratum time distribution parameters provisioning. |
|
14 |
FeatureRenegotiation |
This feature indicates the support of feature renegotiation during the update of a policy association triggered by UE mobility with AMF change. |
5.9 Security
As indicated in 3GPP TS 33.501 [19] and 3GPP TS 29.500 [5], the access to the Npcf_AMPolicyControl API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [20]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server.
If OAuth2 is used, an NF service sonsumer, prior to consuming services offered by the Npcf_AMPolicyControl API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [13], clause 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 Npcf_AMPolicyControl service.
The Npcf_AMPolicyControl API defines a single scope "npcf-am-policy-control" for the entire service, and it does not define any additional scopes at resource or operation level.
Annex A (normative):
OpenAPI specification