5 Nbsf_Management Service API
29.5213GPP5G SystemBinding Support Management ServiceRelease 18Stage 3TS
5.1 Introduction
The Nbsf_Management Service shall use the Nbsf_Management API.
The API URI of the Nbsf_Management API shall be:
{apiRoot}/<apiName>/<apiVersion>
The request URIs used in HTTP requests from the NF service consumer towards the BSF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in 3GPP TS 29.501 [7].
– The <apiName> shall be "nbsf-management".
– 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 [6].
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6].
The OpenAPI [11] specification of HTTP messages and content bodies for the Nbsf_Management 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 [6] 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 [6]. The use of the JSON format shall be signalled by the content type "application/json".
"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13].
JSON object used in the HTTP PATCH request shall be encoded according to "JSON Merge Patch" and shall be signalled by the content type "application/merge-patch+json", as defined in IETF RFC 7396 [20].
5.2.3 HTTP custom headers
5.2.3.1 General
The Nbsf_Management Service API shall support the mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6].
In this release of the specification, no specific custom headers are defined for the Nbsf_Management Service API.
5.3 Resources
5.3.1 Resource Structure
This clause describes the structure for the Resource URIs, the resources and methods used for the service.
The structure of the Resource URI of the Nbsf_Management service is shown in figure 5.3.1-1.
Figure 5.3.1-1: Resource URI structure of the Nbsf_Management 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 |
PCF for a PDU Session Bindings |
/pcfBindings (NOTE) |
POST |
Register a new PCF for a PDU Session binding information of a given UE address in the BSF. |
GET |
Retrieve the PCF for a PDU Session binding information i.e. PCF address information of a given tuple (UE address, SUPI; GPSI, DNN, S-NSSAI). |
||
Individual PCF for a PDU Session Binding |
/pcfBindings (NOTE) |
DELETE |
Deregister an existing PCF for a PDU Session binding information from the BSF. |
PATCH |
Update an existing PCF for a PDU Session binding information in the BSF. |
||
PCF for a UE Bindings |
/pcf-ue-bindings |
POST |
Register a new PCF for a UE binding information of a given UE identity in the BSF. |
GET |
Retrieve the PCF for a UE binding information i.e. PCF address information of a UE. |
||
Individual PCF for a UE Binding |
pcf-ue-bindings |
DELETE |
Deregister an existing PCF for a UE binding information from the BSF. |
PATCH |
Update an existing PCF for a UE binding information in the BSF. |
||
PCF for an MBS Session Bindings |
/pcf-mbs-bindings |
POST |
Register a new PCF for an MBS Session Binding. |
GET |
Retrieve PCF for an MBS Session Binding information. |
||
Individual PCF for an MBS Session Binding |
/pcf-mbs-bindings/{bindingId} |
PATCH |
Modify an existing PCF for an MBS Session Binding. |
DELETE |
Deregister an existing PCF for an MBS Session Binding. |
||
Binding Subscriptions |
/subscriptions |
POST |
Create a new Individual Binding Subscription resource. |
Individual Binding Subscription |
/subscriptions |
PUT |
Modify an existing Individual Binding Subscription resource. |
DELETE |
Delete an Individual Binding Subscription resource and cancel the related subscription. |
||
NOTE: The path segment does not follow the related naming convention defined in 3GPP TS 29.501 [7]. The path segment is kept though as defined in the current specification for backward compatibility considerations. |
5.3.2 Resource: PCF for a PDU Session Bindings
5.3.2.1 Description
This resource represents a collection of the different PCF for a PDU Session binding information of given UE address(es) registered in the BSF.
5.3.2.2 Resource definition
Resource URI: {apiRoot}/nbsf-management/<apiVersion>/pcfBindings
The <apiVersion> shall be set as described in clause 5.1.
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 |
PcfBinding |
M |
1 |
Register a new Individual PCF for a PDU Session binding information. |
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 |
PcfBinding |
M |
1 |
201 Created |
The creation of an individual PCF for a PDU Session binding. |
ExtProblemDetails |
O |
0..1 |
403 Forbidden |
The existing PCF binding information stored in the BSF for the indicated combination is returned. |
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. |
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}/nbsf-management/<apiVersion>/pcfBindings/{bindingId} |
5.3.2.3.2 GET
This method shall support the URI query parameters specified in table 5.3.2.3.2-1.
Table 5.3.2.3.2-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
P |
Cardinality |
Description |
ipv4Addr |
Ipv4Addr |
C |
0..1 |
The IPv4 Address of the served UE. (NOTE 1) (NOTE 3) (NOTE 4) |
ipv6Prefix |
Ipv6Prefix |
C |
0..1 |
The IPv6 Address of the served UE. (NOTE 1) (NOTE 3) (NOTE 4) The NF service consumer shall append ‘/128’ to the IPv6 address in the attribute value. E.g. ‘2001:db8:85a3::8a2e:370:7334/128’. |
macAddr48 |
MacAddr48 |
C |
0..1 |
The MAC Address of the served UE. (NOTE 1) |
dnn |
Dnn |
O |
0..1 |
Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 6) |
supi |
Supi |
O |
0..1 |
Subscription Permanent Identifier |
gpsi |
Gpsi |
O |
0..1 |
Generic Public Subscription Identifier |
snssai |
Snssai |
O |
0..1 |
The identification of slice. (NOTE 2) |
ipDomain |
string |
O |
0..1 |
The IPv4 address domain identifier. (NOTE 2) |
supp-feat |
SupportedFeatures |
O |
0..1 |
To filter irrelevant responses related to unsupported features. (NOTE 5) |
NOTE 1: One and only one of query parameter ipv4Addr, ipv6Prefix or macAddr48 shall be present. NOTE 2: The query parameters snssai and/or ipDomain, if applicable (IPv4 address overlapping), shall be present with query parameter ipv4Addr. NOTE 3: 5G-RG and FN-RG replaces UE for wireline access support. See 3GPP TS 23.316 [19]. NOTE 4: The ipv4Addr and ipv6Prefix query parameters may include the IP address of devices in networks behind the UE (see clause 5.6.14 of 3GPP TS 23.501 [2]). NOTE 5: This query parameter may be present when there are supported features that apply to the retrieval of the "Individual PCF for a PDU Session Binding" resource as defined in clause 4.2.4.2. Otherwise, it shall be omitted. NOTE 6: The BSF uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. |
This method shall support the request data structures specified in table 5.3.2.3.2-2 and the response data structures and response codes specified in table 5.3.2.3.2-3.
Table 5.3.2.3.2-2: Data structures supported by the GET Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 5.3.2.3.2-3: Data structures supported by the GET Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
PcfBinding |
M |
1 |
200 OK |
The individual PCF for a PDU Session binding information resource matching the query parameter(s) is returned. |
n/a |
204 No Content |
There is no PCF for a PDU Session binding information matching the query parameter(s). |
||
ProblemDetails |
O |
0..1 |
400 Bad Request |
More than one binding information is found. (NOTE 2) |
NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. NOTE 2: Failure cases are described in clause 5.7. |
5.3.3 Resource: Individual PCF for a PDU Session Binding
5.3.3.1 Description
This resource represents an individual PCF for a PDU Session binding information of a given UE address(es) registered in the BSF.
5.3.3.2 Resource definition
Resource URI: {apiRoot}/nbsf-management/<apiVersion>/pcfBindings/{bindingId}
The <apiVersion> shall be set as described in clause 5.1.
This resource shall support the resource URI variables defined in table 5.3.3.2-1.
Table 5.3.3.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See clause 5.1 |
bindingId |
string |
Represents the individual PCF for a PDU Session Binding. To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501 [7]. |
5.3.3.3 Resource Standard Methods
5.3.3.3.1 DELETE
This method shall support the URI query parameters specified in table 5.3.3.3.1-1.
Table 5.3.3.3.1-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.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3.
Table 5.3.3.3.1-2: Data structures supported by the DELETE Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 5.3.3.3.1-3: Data structures supported by the DELETE Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
n/a |
204 No Content |
Successful case: The Individual PCF for a PDU Session binding information resource is deleted. |
||
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during Individual PCF for a PDU Session Binding deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. Applicable if the feature "ES3XX" is supported. |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection, during Individual PCF for a PDU Session Binding deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. Applicable if the feature "ES3XX" is supported. |
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall 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 BSF (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 BSF (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 PATCH
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 PATCH 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 PATCH Request Body on this resource
Data type |
P |
Cardinality |
Description |
PcfBindingPatch |
M |
1 |
Update an individual PCF binding information. |
Table 5.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
PcfBinding |
M |
1 |
200 OK |
Successful case: The Individual PCF for a PDU Session binding information resource is updated. |
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during Individual PCF for a PDU Session Binding modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. Applicable if the feature "ES3XX" is supported. |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection, during Individual PCF for a PDU Session Binding modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. Applicable if the feature "ES3XX" is supported. |
NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall 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 BSF (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 BSF (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.4 Resource: Binding Subscriptions
5.3.4.1 Description
The Binding Subscriptions resource represents the collection of subscriptions to events in the Nbsf_Management service.
5.3.4.2 Resource definition
Resource URI: {apiRoot}/nbsf-management/<apiVersion>/subscriptions
The <apiVersion> shall be set as described in clause 5.1.
This resource shall support the resource URI variables defined in table 5.3.4.2-1.
Table 5.3.4.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See clause 5.1 |
5.3.4.3 Resource Standard Methods
5.3.4.3.1 POST
This method shall support the URI query parameters specified in table 5.3.4.3.1-1.
Table 5.3.4.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.4.3.1-2 and the response data structures and response codes specified in table 5.3.4.3.1-3.
Table 5.3.4.3.1-2: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
BsfSubscription |
M |
1 |
Create a new Individual binding Subscription resource. |
Table 5.3.4.3.1-3: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
BsfSubscriptionResp |
M |
1 |
201 Created |
The creation of an Individual Binding Subscription resource is confirmed. |
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. |
Table 5.3.4.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}/nbsf-management/<apiVersion>/subscriptions/{subId} |
5.3.4.4 Resource Custom Operations
None.
5.3.5 Resource: Individual Binding Subscription
5.3.5.1 Description
The Individual Binding Subscription resource represents a single subscription to the event notification in the service.
5.3.5.2 Resource definition
Resource URI: {apiRoot}/nbsf-management/<apiVersion>/subscriptions/{subId}
The <apiVersion> shall be set as described in clause 5.1.
This resource shall support the resource URI variables defined in table 5.3.5.2-1.
Table 5.3.5.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See clause 5.1 |
subId |
string |
Identifies a subscription to event notification. |
5.3.5.3 Resource Standard Methods
5.3.5.3.1 PUT
This method shall support the URI query parameters specified in table 5.3.5.3.1-1.
Table 5.3.5.3.1-1: URI query parameters supported by the PUT 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.5.3.1-2 and the response data structures and response codes specified in table 5.3.5.3.1-3.
Table 5.3.5.3.1-2: Data structures supported by the PUT Request Body on this resource
Data type |
P |
Cardinality |
Description |
BsfSubscription |
M |
1 |
Modify the existing Individual Binding Subscription resource matching the subId according to the representation in the BsfSubscription. |
Table 5.3.5.3.1-3: Data structures supported by the PUT Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
||||
BsfSubscriptionResp |
M |
1 |
200 OK |
Successful case: The Individual Binding Subscription resource matching the subId was modified and a representation is returned. |
||||
n/a |
204 No Content |
Successful case: The Individual Binding Subscription resource matching the subId was modified. |
||||||
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during Individual Binding Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. |
||||
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection, during Individual Binding Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. |
||||
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. |
Table 5.3.5.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 BSF (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.5.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 BSF (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.5.3.2 DELETE
This method shall support the URI query parameters specified in table 5.3.5.3.2-1.
Table 5.3.5.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.5.3.2-2 and the response data structures and response codes specified in table 5.3.5.3.2-3.
Table 5.3.5.3.2-2: Data structures supported by the DELETE Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 5.3.5.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 |
Successful case: The Individual Binding Subscription resource matching the subId was deleted. |
|||
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during Individual Binding Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection, during Individual Binding Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. |
|
NOTE: The manadatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. |
Table 5.3.5.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 BSF (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.5.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 BSF (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.5.4 Resource Custom Operations
None.
5.3.6 Void
5.3.7 Resource: PCF for a UE Bindings
5.3.7.1 Description
This resource represents a collection of the different PCF for a UE binding information of given UE identifier (i.e., SUPI) registered in the BSF.
5.3.7.2 Resource definition
Resource URI: {apiRoot}/nbsf-management/<apiVersion>/pcf-ue-bindings
The <apiVersion> shall be set as described in clause 5.1.
This resource shall support the resource URI variables defined in table 5.3.7.2-1.
Table 5.3.7.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See clause 5.1 |
5.3.7.3 Resource Standard Methods
5.3.7.3.1 POST
This method shall support the URI query parameters specified in table 5.3.7.3.1-1.
Table 5.3.7.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.7.3.1-2 and the response data structures and response codes specified in table 5.3.7.3.1-3.
Table 5.3.7.3.1-2: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
PcfForUeBinding |
M |
1 |
Register a new Individual PCF for a UE Binding information. |
Table 5.3.7.3.1-3: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
PcfForUeBinding |
M |
1 |
201 Created |
The creation of an individual PCF for a UE Binding. |
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. |
Table 5.3.7.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}/nbsf-management/<apiVersion>/pcf-ue-bindings/{bindingId} |
5.3.7.3.2 GET
This method shall support the URI query parameters specified in table 5.3.7.3.2-1.
Table 5.3.7.3.2-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
P |
Cardinality |
Description |
supi |
Supi |
O |
0..1 |
Subscription Permanent Identifier. (NOTE 1) |
gpsi |
Gpsi |
O |
0..1 |
Generic Public Subscription Identifier. (NOTE 1) |
supp-feat |
SupportedFeatures |
O |
0..1 |
To filter irrelevant responses related to unsupported features. (NOTE 2) |
NOTE 1: At least one parameter shall be present. NOTE 2: This query parameter may be present when there are supported features that apply to the retrieval of the "Individual PCF for a UE Binding" resource as defined in clause 4.2.4.3. Otherwise, it shall be omitted. |
This method shall support the request data structures specified in table 5.3.7.3.2-2 and the response data structures and response codes specified in table 5.3.7.3.2-3.
Table 5.3.7.3.2-2: Data structures supported by the GET Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 5.3.7.3.2-3: Data structures supported by the GET Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
array(PcfForUeBinding) |
M |
0..N |
200 OK |
The individual PCF for a UE binding resource(s) matching the query parameter(s) are returned. |
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. |
5.3.8 Resource: Individual PCF for a UE Binding
5.3.8.1 Description
This resource represents an individual PCF for a UE binding information of given UE identifier (i.e SUPI) registered in the BSF.
5.3.8.2 Resource definition
Resource URI: {apiRoot}/nbsf-management/<apiVersion>/pcf-ue-bindings/{bindingId}
The <apiVersion> shall be set as described in clause 5.1.
This resource shall support the resource URI variables defined in table 5.3.8.2-1.
Table 5.3.8.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See clause 5.1 |
bindingId |
string |
Represents the individual PCF for a UE Binding. To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501 [7]. |
5.3.8.3 Resource Standard Methods
5.3.8.3.1 DELETE
This method shall support the URI query parameters specified in table 5.3.8.3.1-1.
Table 5.3.8.3.1-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.8.3.1-2 and the response data structures and response codes specified in table 5.3.8.3.1-3.
Table 5.3.8.3.1-2: Data structures supported by the DELETE Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 5.3.8.3.1-3: Data structures supported by the DELETE Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
n/a |
204 No Content |
Successful case: The Individual PCF for a UE Binding information resource is deleted. |
||
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during Individual PCF for a UE Binding deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection, during Individual PCF for a UE Binding deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. |
NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. |
Table 5.3.8.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 BSF (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.8.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 BSF (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.8.3.2 PATCH
This method shall support the URI query parameters specified in table 5.3.8.3.2-1.
Table 5.3.8.3.2-1: URI query parameters supported by the PATCH 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.8.3.2-2 and the response data structures and response codes specified in table 5.3.8.3.2-3.
Table 5.3.8.3.2-2: Data structures supported by the PATCH Request Body on this resource
Data type |
P |
Cardinality |
Description |
PcfForUeBindingPatch |
M |
1 |
Update an individual PCF for a UE binding information. |
Table 5.3.8.3.2-3: Data structures supported by the PATCH Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
PcfForUeBinding |
M |
1 |
200 OK |
Successful case: The Individual PCF for a UE binding information resource is updated. |
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during Individual PCF for a UE Binding modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection, during Individual PCF for a UE Binding modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. |
NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. |
Table 5.3.8.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 BSF (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.8.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 BSF (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.9 Resource: PCF for an MBS Session Bindings
5.3.9.1 Description
This resource represents the collection of PCF for an MBS Session Bindings registered at the BSF.
5.3.9.2 Resource definition
Resource URI: {apiRoot}/nbsf-management/<apiVersion>/pcf-mbs-bindings
The <apiVersion> shall be set as described in clause 5.1.
This resource shall support the resource URI variables defined in table 5.3.9.2-1.
Table 5.3.9.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See subclause 5.1 |
5.3.9.3 Resource Standard Methods
5.3.9.3.1 POST
This method shall support the URI query parameters specified in table 5.3.9.3.1-1.
Table 5.3.9.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.9.3.1-2 and the response data structures and response codes specified in table 5.3.9.3.1-3.
Table 5.3.9.3.1-2: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
PcfMbsBinding |
M |
1 |
Contains the parameters to request to register a new PCF for an MBS Session Binding. |
Table 5.3.9.3.1-3: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
PcfMbsBinding |
M |
1 |
201 Created |
Successful case. A new "Individual PCF for an MBS Session Binding" resource is created and the corresponding URI is returned in an HTTP Location header. |
MbsExtProblemDetails |
O |
0..1 |
403 Forbidden |
The existing PCF binding information stored in the BSF for the MBS session is returned. |
NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. |
Table 5.3.9.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: |
5.3.9.3.2 GET
This method shall support the URI query parameters specified in table 5.3.9.3.2-1.
Table 5.3.9.3.2-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
P |
Cardinality |
Description |
mbs-session-id |
MbsSessionId |
M |
1 |
Contains the identifier of the MBS Session to which the requested MBS Session binding is related. |
supp-feat |
SupportedFeatures |
O |
0..1 |
Contains the list of features supported by the NF service consumer and used to filter irrelevant responses related to unsupported features. |
This method shall support the request data structures specified in table 5.3.9.3.2-2 and the response data structures and response codes specified in table 5.3.9.3.2-3.
Table 5.3.9.3.2-2: Data structures supported by the GET Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 5.3.9.3.2-3: Data structures supported by the GET Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
array(PcfMbsBinding) |
M |
0..N |
200 OK |
Successful case. The "Individual PCF for an MBS Session Binding" resource(s) matching the provided query parameter(s) are returned. |
NOTE: The mandatory HTTP error status codes for the HTTP GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. |
5.3.9.4 Resource Custom Operations
None.
5.3.10 Resource: Individual PCF for an MBS Session Binding
5.3.10.1 Description
This resource represents an "Individual PCF for an MBS Session Binding" registered at the BSF.
5.3.10.2 Resource definition
Resource URI: {apiRoot}/nbsf-management/<apiVersion>/pcf-mbs-bindings/{bindingId}
The <apiVersion> shall be set as described in clause 5.1.
This resource shall support the resource URI variables defined in table 5.3.10.2-1.
Table 5.3.10.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See subclause 5.1 |
bindingId |
string |
Represents the identifier of the "Individual PCF for an MBS Session Binding" reosurce. To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501 [7]. |
5.3.10.3 Resource Standard Methods
5.3.10.3.1 PATCH
This method shall support the URI query parameters specified in table 5.3.10.3.1-1.
Table 5.3.10.3.1-1: URI query parameters supported by the PATCH 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.10.3.1-2 and the response data structures and response codes specified in table 5.3.10.3.1-3.
Table 5.3.10.3.1-2: Data structures supported by the PATCH Request Body on this resource
Data type |
P |
Cardinality |
Description |
PcfMbsBindingPatch |
M |
1 |
Contains the requested modifications to the PCF for an MBS Session Binding. |
Table 5.3.10.3.1-3: Data structures supported by the PATCH Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
PcfMbsBinding |
M |
1 |
200 OK |
Successful case: The "Individual PCF for an MBS Session Binding" resource is successfully modified and a representation of the updated resource is returned in the response body. |
n/a |
204 No Content |
Successful case: The "Individual PCF for an MBS Session Binding" resource is successfully modified and no content is returned in the response body. |
||
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. |
NOTE: The mandatory HTTP error status codes for the HTTP PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. |
Table 5.3.10.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 BSF (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.10.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 BSF (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.10.3.2 DELETE
This method shall support the URI query parameters specified in table 5.3.10.3.2-1.
Table 5.3.10.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.10.3.2-2 and the response data structures and response codes specified in table 5.3.10.3.2-3.
Table 5.3.10.3.2-2: Data structures supported by the DELETE Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 5.3.10.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 |
Successful case: The "Individual PCF for an MBS Session Binding" resource is successfully deleted. |
||
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. |
NOTE: The mandatory HTTP error status codes for the HTTP DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. |
Table 5.3.10.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 BSF (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.10.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 BSF (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.10.4 Resource Custom Operations
None.
5.4 Custom Operations without associated resources
None in this release of this specification.
5.5 Notifications
5.5.1 General
Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7].
Table 5.5.1-1: Notifications overview
Notification |
Callback URI |
HTTP method or custom operation |
Description (service operation) |
BSF Notification |
{notifUri} |
POST |
Provides information about observed BSF events. |
5.5.2 BSF Notification
5.5.2.1 Description
The BSF Notification is used by the BSF to report one or several observed events to an NF service consumer that has subscribed to such Notifications via the Individual Binding Subscription Resource.
5.5.2.2 Target URI
The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 5.5.2.2-1.
Table 5.5.2.2-1: Callback URI variables
Name |
Data type |
Definition |
notifUri |
Uri |
The Notification Uri as assigned within the Individual Binding Subscription Resource and described within the BsfSubscription type (see table 5.6.2.7-1). |
5.5.2.3 Standard Methods
5.5.2.3.1 POST
This method shall support the URI query parameters specified in table 5.5.2.3.1-1.
Table 5.5.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.5.2.3.1-2 and the response data structures and response codes specified in table 5.5.2.3.1-3.
Table 5.5.2.3.1-2: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
BsfNotification |
M |
1 |
Provides Information about observed events |
Table 5.5.2.3.1-3: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
||||
n/a |
204 No Content |
The receipt of the Notification is acknowledged. |
||||||
RedirectResponse |
O |
0..1 |
307 temporary redirect |
Temporary redirection, during the 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. |
||||
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection, during the 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. |
||||
ProblemDetails |
O |
0..1 |
404 Not Found |
The NF service consumer can use this response when the notification cannot be sent to another 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 [6] also apply. |
Table 5.5.2.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 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 |
Table 5.5.2.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 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.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 Nbsf_Management service based interface protocol.
Table 5.6.1-1: Nbsf_Management specific Data Types
Data type |
Section defined |
Description |
Applicability |
|||
BindingLevel |
5.6.3.3 |
Contains the binding level. |
||||
BindingResp |
5.6.2.6 |
Contains the binding information. |
SamePcf |
|||
BsfEvent |
5.6.3.5 |
Contains the event notified by the BSF. |
||||
BsfEventNotification |
5.6.2.9 |
Contains an event notification. |
||||
BsfNotification |
5.6.2.8 |
Contains the notification to the events. |
||||
BsfSubscription |
5.6.2.7 |
Contains the event subscription data. |
||||
BsfSubscriptionResp |
5.6.4.1 |
Contains the response to the subscription request. It consists of the resource representation within BsfSubscription data type and, if available, the matched observed event within the BsfNotification data type. |
||||
ExtProblemDetails |
5.6.2.5 |
Contains the FQDN or IP endpoints of the existing PCF and cause value if there is an existing PCF binding information for the indicated combination. |
SamePcf |
|||
ParameterCombination |
5.6.2.4 |
The combination used by the BSF to check whether there is an existing PCF binding information. |
SamePcf |
|||
PcfBinding |
5.6.2.2 |
Identifies an Individual PCF for a PDU session binding. |
||||
PcfBindingPatch |
5.6.2.3 |
Identifies an Individual PCF for a PDU session binding used for Patch method. |
BindingUpdate |
|||
PcfMbsBinding |
5.6.2.15 |
Represents an Individual PCF for an MBS Session binding. |
||||
PcfMbsBindingPatch |
5.6.2.16 |
Represents the requested modifications to an Individual PCF for an MBS Session binding. |
||||
PcfForPduSessionInfo |
5.6.2.13 |
The information of the PCF for a PDU session. |
||||
PcfForUeBinding |
5.6.2.10 |
Identifies an Individual PCF for a UE binding. |
||||
PcfForUeBindingPatch |
5.6.2.11 |
Identifies the updates to an Individual PCF for a UE binding. |
||||
PcfForUeInfo |
5.6.2.14 |
The information of the PCF for a UE. |
||||
SnssaiDnnPair |
5.6.2.12 |
Represents a S-NSSAI and DNN pair. |
Table 5.6.1-2 specifies data types re-used by the Nbsf_Management 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 Nbsf_Management service based interface.
Table 5.6.1-2: Nbsf_Management re-used Data Types
Data type |
Reference |
Comments |
Applicability |
DateTime |
3GPP TS 29.571 [10] |
||
DiameterIdentity |
3GPP TS 29.571 [10] |
||
Dnn |
3GPP TS 29.571 [10] |
||
Fqdn |
3GPP TS 29.571 [10] |
||
Gpsi |
3GPP TS 29.571 [10] |
||
IpEndPoint |
3GPP TS 29.510 [12] |
||
Ipv4Addr |
3GPP TS 29.571 [10] |
||
Ipv4AddrMask |
3GPP TS 29.571 [10] |
String identifying an IPv4 address mask. |
|
Ipv4AddrRm |
3GPP TS 29.571 [10] |
||
Ipv6Prefix |
3GPP TS 29.571 [10] |
||
Ipv6PrefixRm |
3GPP TS 29.571 [10] |
||
MacAddr48 |
3GPP TS 29.571 [10] |
||
MacAddr48Rm |
3GPP TS 29.571 [10] |
||
MbsSessionId |
3GPP TS 29.571 [10] |
Represents the identifier of an MBS Session. |
|
NfInstanceId |
3GPP TS 29.571 [10] |
||
NfSetId |
3GPP TS 29.571 [10] |
||
ProblemDetails |
3GPP TS 29.571 [10] |
Used in error responses to provide more detailed information about an error. |
|
RedirectResponse |
3GPP TS 29.571 [10] |
Contains redirection related information. |
ES3XX |
Snssai |
3GPP TS 29.571 [10] |
||
Supi |
3GPP TS 29.571 [10] |
||
SupportedFeatures |
3GPP TS 29.571 [10] |
Used to negotiate the applicability of the optional features defined in table 5.8-1. |
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 PcfBinding
Table 5.6.2.2-1: Definition of type PcfBinding
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
supi |
Supi |
O |
0..1 |
Subscription Permanent Identifier |
|
gpsi |
Gpsi |
O |
0..1 |
Generic Public Subscription Identifier |
|
ipv4Addr |
Ipv4Addr |
C |
0..1 |
The IPv4 Address of the served UE. (NOTE 4) (NOTE 8) |
|
ipv6Prefix |
Ipv6Prefix |
C |
0..1 |
The IPv6 Address Prefix of the served UE. (NOTE 4) (NOTE 5) (NOTE 8) |
|
addIpv6Prefixes |
array(Ipv6Prefix) |
O |
1..N |
The additional IPv6 Address Prefixes of the served UE. (NOTE 4) (NOTE 5) (NOTE 8) (NOTE 10) |
MultiUeAddr |
ipDomain |
string |
O |
0..1 |
IPv4 address domain identifier. (NOTE 1) (NOTE 8) |
|
macAddr48 |
MacAddr48 |
C |
0..1 |
The MAC Address of the served UE. (NOTE 8) |
|
addMacAddrs |
array(MacAddr48) |
O |
1..N |
The additional MAC Addresses of the served UE. (NOTE 8) (NOTE 10) |
MultiUeAddr |
dnn |
Dnn |
M |
1 |
DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 11) |
|
pcfFqdn |
Fqdn |
C |
0..1 |
FQDN of the PCF hosting the Npcf_PolicyAuthorization service. (NOTE 2) (NOTE 9) |
|
pcfIpEndPoints |
array(IpEndPoint) |
C |
1..N |
IP end points of the PCF hosting the Npcf_PolicyAuthorization service. (NOTE 2) (NOTE 9) |
|
pcfDiamHost |
DiameterIdentity |
C |
0..1 |
The diameter host for an individual PCF. (NOTE 3) (NOTE 9) |
|
pcfDiamRealm |
DiameterIdentity |
C |
0..1 |
The diameter realm for an individual PCF. (NOTE 3) (NOTE 9) |
|
pcfSmFqdn |
Fqdn |
O |
0..1 |
FQDN of the PCF hosting the Npcf_SMPolicyControl service. (NOTE 7) (NOTE 10) |
SamePcf |
pcfSmIpEndPoints |
array(IpEndPoint) |
O |
1..N |
IP end points of the PCF hosting the Npcf_SMPolicyControl service. (NOTE 7) (NOTE 10) |
SamePcf |
snssai |
Snssai |
M |
1 |
The identification of slice. |
|
suppFeat |
SupportedFeatures |
C |
0..1 |
Used to negotiate the supported optional features as described in clause 5.8. Shall be present in the HTTP POST request/response; or in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. |
|
pcfId |
NfInstanceId |
O |
0..1 |
PCF instance identifier |
|
pcfSetId |
NfSetId |
O |
0..1 |
The PCF set Id |
|
recoveryTime |
DateTime |
O |
0..1 |
Recovery time of the PCF |
|
paraCom |
ParameterCombination |
O |
0..1 |
If it is included, the BSF shall check whether there is an existing PCF binding information for the indicated combination. (NOTE 6) (NOTE 10) |
SamePcf |
bindLevel |
BindingLevel |
O |
0..1 |
Contains the level of binding. |
|
ipv4FrameRouteList |
array(Ipv4AddrMask) |
O |
1..N |
List of Framed Route information of IPv4. |
|
ipv6FrameRouteList |
array(Ipv6Prefix) |
O |
1..N |
List of Framed Route information of IPv6. |
|
NOTE 1: The ipDomain attribute may only be provided if the ipv4Addr attribute is present. NOTE 2: When the "ExtendedSamePcf" feature is not supported, at least one of "pcfFqdn" or "pcfIpEndPoints" shall be included if the PCF supports the Npcf_PolicyAuthorization service. When the "ExtendedSamePcf" feature is supported these attributes may be provided if available. NOTE 3: When the "ExtendedSamePcf" feature is not supported, both pcfDiamHost and pcfDiamRealm are provided if the PCF supports Rx interface. When the "ExtendedSamePcf" feature is supported these attributes may provided if available. NOTE 4: 5G-RG and FN-RG replaces UE for wireline access support. See 3GPP TS 23.316 [19]. NOTE 5: IPv6 prefix(es) shorter than /64 or full IPv6 address(es_ with a /128 prefix may be encoded as the "ipv6Prefix" and "addIpv6Prefixes" attributes, according to 3GPP TS 23.316 [19], clause 8.3.1. NOTE 6: If the BSF finds that there is an existing Individual PCF for a PDU Session Binding resource for the indicated combination containing Npcf_SMPolicyControl service addressing information, the BSF shall not check other Individual PCF for a PDU Session Binding resources and shall reject the ongoing registration, and return the FQDN or IP endpoints of the Npcf_SMPolicyControl service of the matching Individual PCF for a PDU Session Binding resource to the requesting PCF. NOTE 7: At least one of the "pcfSmFqdn" attribute or the "pcfSmIpEndPoints" attribute shall be included in the binding information, if the binding refers to an SM Policy association and if the "SamePcf" feature is supported and the PCF determines that the same PCF shall be selected for the SM Policy associations with the same SUPI/DNN/S-NSSAI parameter combination in the non-roaming or home-routed scenario based on operator’s policies and configuration. NOTE 8: When the "ExtendedSamePcf" feature is not supported the address information of the served UE shall be provided, i.e., either the "ipv4Addr", the "ipv6Prefix" and/or "addIpv6Prefixes" attributes or the "macAddr48" and/or "addMacAddrs" attributes shall be provided as specified in clause 4.2.2.2. NOTE 9: When the "ExtendedSamePcf" feature is not supported the address information of the Npcf_PolicyAuthorization service and/or Rx interface shall be provided, i.e., both "pcfDiamHost" and "pcfDiamRealm" and/or at least one of the "pcfFqdn" or "pcfEndPoints" shall be provided as specified in clause 4.2.2.2. NOTE 10: This attribute does not apply when the NF service consumer is an AF/NEF. NOTE 11: The BSF uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. |
5.6.2.3 Type PcfBindingPatch
Table 5.6.2.3-1: Definition of type PcfBindingPatch
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
ipv4Addr |
Ipv4AddrRm |
O |
0..1 |
The IPv4 Address of the served UE. (NOTE 2) |
|
ipDomain |
string |
O |
0..1 |
IPv4 address domain identifier. (NOTE 1) |
|
ipv6Prefix |
Ipv6PrefixRm |
O |
0..1 |
The IPv6 Address Prefix of the served UE. (NOTE 2) (NOTE 3) |
|
addIpv6Prefixes |
array(Ipv6Prefix) |
O |
1..N |
The additional IPv6 Address Prefixes of the served UE. (NOTE 2) (NOTE 3) |
MultiUeAddr |
macAddr48 |
MacAddr48Rm |
O |
0..1 |
The MAC Address of the served UE. |
|
addMacAddrs |
array(MacAddr48) |
O |
1..N |
The additional MAC Addresses of the served UE. |
MultiUeAddr |
pcfId |
NfInstanceId |
O |
0..1 |
PCF instance identifier |
|
pcfFqdn |
Fqdn |
O |
0..1 |
FQDN of the PCF hosting the Npcf_PolicyAuthorization service. |
|
pcfIpEndPoints |
array(IpEndPoint) |
O |
1..N |
IP end points of the PCF hosting the Npcf_PolicyAuthorization service. |
|
pcfDiamHost |
DiameterIdentity |
O |
0..1 |
The diameter host for an individual PCF. |
|
pcfDiamRealm |
DiameterIdentity |
O |
0..1 |
The diameter realm for an individual PCF. |
|
NOTE 1: If applicable, the consumer (e.g. PCF) shall also request to remove the ipDomain attribute if the ipv4Addr attribute is requested to be removed. NOTE 2: 5G-RG and FN-RG replaces UE for wireline access support. See 3GPP TS 23.316 [19]. NOTE 3: IPv6 prefix(es) shorter than /64 or full IPv6 address(es) with a /128 prefix can be encoded as the "ipv6Prefix" and "addIpv6Prefixes" attributes, according to 3GPP TS 23.316 [19], clause 8.3.1. |
5.6.2.4 Type ParameterCombination
Table 5.6.2.4-1: Definition of type ParameterCombination
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
supi |
Supi |
O |
0..1 |
Subscription Permanent Identifier |
|
dnn |
Dnn |
O |
0..1 |
DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 3) |
|
snssai |
Snssai |
O |
0..1 |
The identification of slice. |
|
NOTE 1: At least one of the attributes in this table shall be included. NOTE 2: The applicable parameter combinations in a given deployment shall be disjoint combinations. E.g., if a deployment requires a parameter combination that includes a SUPI value for a DNN/S-NSSAI combination, subsequent parameter combinations of that DNN/S-NSSAI combination shall also include the corresponding SUPI attribute. NOTE 3: The BSF uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. |
5.6.2.5 Type ExtProblemDetails
Table 5.6.2.5-1: Definition of type ExtProblemDetails as a list of to be combined data types
Data Type |
P |
Cardinality |
Description |
Applicability |
ProblemDetails |
O |
0..1 |
Problem Details |
|
BindingResp |
O |
0..1 |
PCF Binding Information |
5.6.2.6 Type BindingResp
Table 5.6.2.6-1: Definition of type BindingResp
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
pcfSmFqdn |
Fqdn |
O |
0..1 |
FQDN of the PCF hosting the Npcf_SMPolicyControl service. (NOTE) |
|
pcfSmIpEndPoints |
array(IpEndPoint) |
O |
1..N |
IP end points of the PCF hosting the Npcf_SMPolicyControl service. (NOTE) |
|
NOTE: Either the "pcfSmFqdn" attribute or the "pcfSmIpEndPoints" attribute shall be included. |
5.6.2.7 Type BsfSubscription
Table 5.6.2.7-1: Definition of type BsfSubscription
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
---|---|---|---|---|---|
events |
array(BsfEvent) |
M |
1..N |
Subscribed Events. |
|
notifUri |
Uri |
M |
1 |
Notification URI. |
|
notifCorreId |
string |
M |
1 |
It is used to set the value of Notification Correlation ID in the corresponding notification. |
|
supi |
Supi |
M |
1 |
Subscription Permanent Identifier. |
|
gpsi |
Gpsi |
O |
0..1 |
Identifies a GPSI. |
|
snssaiDnnPairs |
SnssaiDnnPair |
C |
0..1 |
Represents the S-NSSAI and DNN pair for which the binding event report(s) shall apply. (NOTE) |
|
addSnssaiDnnPairs |
array(SnssaiDnnPair) |
C |
1..N |
Represents the additional S-NSSAI and DNN pairs for which the binding event report(s) shall apply. (NOTE) |
AddSnssaiDnnPair |
suppFeat |
SupportedFeatures |
C |
0..1 |
List of Supported features used as described in clause 5.8. This parameter shall be supplied by NF service consumer and BSF in the POST request that request the creation of an Individual Binding Subscription resource and the related reply, respectively. |
|
NOTE: If the NF service consumer needs to subscribe to notifications for more than one S-NSSAI and DNN pairs and the "AddSnssaiDnnPair" feature is supported, the NF service consumer shall include one S-NSSAI and DNN pair in the "snssaiDnnPairs" attribute and the remaining S-NSSAI and DNN pairs in the "addSnssaiDnnPairs" attribute. |
5.6.2.8 Type BsfNotification
Table 5.6.2.8-1: Definition of type BsfNotification
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
notifCorreId |
string |
M |
1 |
Notification correlation ID used to identify the subscription to which the notification relates. It shall be set to the same value as the "notifCorreId" attribute of BsfSubscription data type. |
|
eventNotifs |
array(BsfEventNotification) |
M |
1..N |
Notifications about Individual Events. |
5.6.2.9 Type BsfEventNotification
Table 5.6.2.9-1: Definition of type BsfEventNotification
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
event |
BsfEvent |
M |
1 |
Event that is notified. |
|
pcfForUeInfo |
PcfForUeInfo |
C |
0..1 |
The binding information of the PCF for a UE. It shall be included if the BSF is subscribed to the notification of "PCF_UE_BINDING_REGISTRATION" and "PCF_UE_BINDING_DEREGISTRATION" event and the registration or deregistration of PCF for a UE is detected. |
|
pcfForPduSessInfos |
array(PcfForPduSessionInfo) |
C |
1..N |
The binding information of the PCF for a PDU session. It shall be included if the BSF is subscribed to the notification of PCF_PDU_SESSION_BINDING_REGISTRATION event and the registration of the PCF for the PDU session is detected, and the BSF is subscribed to the notification of PCF_PDU_SESSION_BINDING_DEREGISTRATION and the deregistration of the PCF for the PDU session is detected. |
|
matchSnssaiDnns |
array(SnssaiDnnPair) |
C |
1..N |
Matching S-NSSAI and DNN pairs. It shall be included if the BSF is subscribed to the notification of SNSSAI_DNN_BINDING_REGISTRATION and a PCF registration for the first PDU session for the DNN and SNSSAI combination is detected, and the BSF is subscribed to the notification of SNSSAI_DNN_BINDING_DEREGISTRATION and a PCF deregistration for the last PDU session for the DNN and SNSSAI combination is detected . |
5.6.2.10 Type PcfForUeBinding
Table 5.6.2.10-1: Definition of type PcfForUeBinding
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
supi |
Supi |
M |
1 |
Subscription Permanent Identifier |
|
gpsi |
Gpsi |
O |
0..1 |
Generic Public Subscription Identifier |
|
pcfForUeFqdn |
Fqdn |
C |
0..1 |
FQDN of the PCF hosting the Npcf_AMPolicyAuthorization service, if available. (NOTE) |
|
pcfForUeIpEndPoints |
array(IpEndPoint) |
C |
1..N |
IP end points of the PCF hosting the Npcf_AMPolicyAuthorization service, if available. (NOTE) |
|
pcfId |
NfInstanceId |
O |
0..1 |
PCF instance identifier |
|
pcfSetId |
NfSetId |
O |
0..1 |
The PCF set Id |
|
bindLevel |
BindingLevel |
O |
0..1 |
Contains the level of binding. |
|
suppFeat |
SupportedFeatures |
C |
0..1 |
Used to negotiate the supported optional features as described in clause 5.8. Shall be present in the HTTP POST request/response or in the HTTP GET response if the "supp-feat" query parameter is included in the HTTP GET request. |
|
NOTE: At least one of the "pcfForUeFqdn" attribute or "pcfForUeIpEndPoints" attribute shall be provided. |
5.6.2.11 Type PcfForUeBindingPatch
Table 5.6.2.11-1: Definition of type PcfForUeBindingPatch
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
pcfForUeFqdn |
Fqdn |
O |
0..1 |
FQDN of the PCF hosting the Npcf_AMPolicyAuthorization service, if available. |
|
pcfForUeIpEndPoints |
array(IpEndPoint) |
O |
1..N |
IP end points of the PCF hosting the Npcf_AMPolicyAuthorization service, if available. |
|
pcfId |
NfInstanceId |
O |
0..1 |
PCF instance identifier |
5.6.2.12 Type SnssaiDnnPair
Table 5.6.2.12-1: Definition of type SnssaiDnnPair
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
snssai |
Snssai |
M |
1 |
S-NSSAI |
|
dnn |
Dnn |
M |
1 |
Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. .(NOTE) |
|
NOTE: The BSF uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. |
5.6.2.13 Type PcfForUeInfo
Table 5.6.2.13-1: Definition of type PcfForUeInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
pcfId |
NfInstanceId |
O |
0..1 |
PCF instance identifier. |
|
pcfSetId |
NfSetId |
O |
0..1 |
The PCF set ID. |
|
bindLevel |
BindingLevel |
O |
0..1 |
Contains the level of binding. |
|
pcfFqdn |
Fqdn |
O |
0..1 |
FQDN of the PCF hosting the Npcf_AMPolicyAuthorization service. |
|
pcfIpEndPoints |
array(IpEndPoint) |
O |
1..N |
IP end points of the PCF hosting the Npcf_AMPolicyAuthorization service. |
|
NOTE: Either the "pcfFqdn" attribute or the "pcfIpEndPoints" attribute shall be included. |
5.6.2.14 Type PcfForPduSessionInfo
Table 5.6.2.14-1: Definition of type PcfForPduSessionInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
snssai |
Snssai |
M |
1 |
S-NSSAI |
|
dnn |
Dnn |
M |
1 |
Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 3) |
|
pcfId |
NfInstanceId |
O |
0..1 |
PCF instance identifier. |
|
pcfSetId |
NfSetId |
O |
0..1 |
The PCF set ID. |
|
bindLevel |
BindingLevel |
O |
0..1 |
Contains the level of binding. |
|
ipv4Addr |
Ipv4Addr |
O |
0..1 |
The IPv4 Address of the served UE. |
|
ipDomain |
string |
O |
0..1 |
IPv4 address domain identifier. (NOTE 2) |
|
ipv6Prefixes |
array(Ipv6Prefix) |
O |
1..N |
The IPv6 Address Prefixes of the served UE. |
|
macAddrs |
array(MacAddr48) |
O |
1..N |
The MAC Addresses of the served UE. |
|
pcfFqdn |
Fqdn |
O |
0..1 |
FQDN of the PCF hosting the Npcf_PolicyAuthorization service. |
|
pcfIpEndPoints |
array(IpEndPoint) |
O |
1..N |
IP end points of the PCF hosting the Npcf_PolicyAuthorization service. |
|
NOTE 1: Either the "pcfFqdn" attribute or the "pcfIpEndPoints" attribute shall be included. NOTE 2: The "ipDomain" attribute may only be provided if the "ipv4Addr" attribute is present. NOTE 3: The BSF uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. |
5.6.2.15 Type PcfMbsBinding
Table 5.6.2.15-1: Definition of type PcfMbsBinding
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
mbsSessionId |
MbsSessionId |
M |
1 |
Contains the identifier of the MBS Session to which the MBS Session binding is related. |
|
pcfFqdn |
Fqdn |
C |
0..1 |
Contains the FQDN of the PCF handling the MBS Session. This attribute shall be provided, if available. (NOTE) |
|
pcfIpEndPoints |
array(IpEndPoint) |
C |
1..N |
Contains the IP end points of the PCF handling the MBS Session. This attribute shall be provided, if available. (NOTE) |
|
pcfId |
NfInstanceId |
O |
0..1 |
Contains the identifier of the PCF instance handling the concerned MBS Session. |
|
pcfSetId |
NfSetId |
O |
0..1 |
Contains the identifier of the PCF set to which the PCF instance handling the MBS Session belongs. |
|
bindLevel |
BindingLevel |
O |
0..1 |
Contains the level of binding of the PCF handling the MBS Session. |
|
recoveryTime |
DateTime |
O |
0..1 |
Contains the recovery timestamp of the NF service consumer (e.g. PCF handling the MBS Session). This attribute may be present only in the HTTP POST request. |
|
suppFeat |
SupportedFeatures |
C |
0..1 |
Contains the supported features and is used to negotiate the supported optional features as described in clause 5.8. This attribute may be present in the HTTP POST request. It shall be present in the HTTP POST response, if it is included in the corresponding HTTP POST request, or in the HTTP GET response, if the "supp-feat" query parameter is included in the corresponding HTTP GET request. |
|
NOTE: At least one of the "pcfFqdn" attribute or the "pcfIpEndPoints" attribute shall be present. |
5.6.2.16 Type PcfMbsBindingPatch
Table 5.6.2.16-1: Definition of type PcfMbsBindingPatch
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
pcfFqdn |
Fqdn |
O |
0..1 |
Contains the FQDN of the PCF handling the MBS Session. This attribute shall be provided, if available. |
|
pcfIpEndPoints |
array(IpEndPoint) |
O |
1..N |
Contains the IP end points of the PCF handling the MBS Session. This attribute shall be provided, if available. |
|
pcfId |
NfInstanceId |
O |
0..1 |
Contains the identifier of the PCF instance handling the concerned MBS Session. |
5.6.2.17 Type MbsExtProblemDetails
Table 5.6.2.17-1: Definition of type MbsExtProblemDetails as a list of to be combined data types
Data Type |
P |
Cardinality |
Description |
Applicability |
ProblemDetails |
O |
0..1 |
Problem Details |
|
MbsBindingResp |
O |
0..1 |
PCF Binding Information for the MBS Session |
5.6.2.18 Type MbsBindingResp
Table 5.6.2.18-1: Definition of type MbsBindingResp
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
pcfFqdn |
Fqdn |
O |
0..1 |
FQDN of the PCF handling the MBS Session. (NOTE) |
|
pcfIpEndPoints |
array(IpEndPoint) |
O |
1..N |
IP end points of the PCF handling the MBS Session. (NOTE) |
|
NOTE: Either the "pcfFqdn" attribute or the "pcfIpEndPoints" attribute shall be included. |
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 clauses.
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 |
5.6.3.3 Enumeration: BindingLevel
Table 5.6.3.3-1: Enumeration BindingLevel
Enumeration value |
Description |
Applicability |
NF_SET |
Indicates the NF set level of binding. |
|
NF_INSTANCE |
Indicates the NF instance level of binding. |
5.6.3.4 Void
5.6.3.5 Enumeration: BsfEvent
Table 5.6.3.5-1: Enumeration BsfEvent
Enumeration value |
Description |
Applicability |
PCF_PDU_SESSION_BINDING_REGISTRATION |
Indicates the binding of a PCF for a PDU session is registered. |
|
PCF_PDU_SESSION_BINDING_DEREGISTRATION |
Indicates the binding of a PCF for a PDU session is deregistered. |
|
PCF_UE_BINDING_REGISTRATION |
Indicates the binding of a PCF for a UE is registered. |
|
PCF_UE_BINDING_DEREGISTRATION |
Indicates the binding of a PCF for a UE is deregistered. |
|
SNSSAI_DNN_BINDING_REGISTRATION |
Indicates the binding of a PCF for a PDU session corresponding to the first PDU session for a DNN and S-NSSAI combination is registered. |
|
SNSSAI_DNN_BINDING_DEREGISTRATION |
Indicates the binding of a PCF for a PDU session corresponding to the last PDU session for a DNN and S-NSSAI combination is deregistered. |
5.6.4 Data types describing alternative data types or combinations of data types
5.6.4.1 Type: BsfSubscriptionResp
Table 5.6.4.1-1: Definition of type BsfSubscriptionResp as a list of non-exclusive alternatives
Data type |
Cardinality |
Description |
Applicability |
BsfNotification |
0..1 |
It represents the notification of a match event during the creation or modification of the Individual Binding Subscription resource. |
|
BsfSubscription |
1 |
It represents the Individual PCFBinding Subscription resource. |
5.7 Error handling
5.7.1 General
HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [6].
For the Nbsf_Management Service API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [7]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [6].
In addition, the requirements in the following clauses shall apply.
5.7.2 Protocol Errors
In this Release of the specification, there are no additional protocol errors applicable for the Nbsf_Management Service API.
5.7.3 Application Errors
The application errors defined for the Nbsf_Management Service API are listed in table 5.7.3-1.
Table 5.7.3-1: Application errors
Application Error |
HTTP status code |
Description |
MULTIPLE_BINDING_INFO_FOUND |
400 Bad Request |
Indicates that the BSF found more than one binding resource so it cannot provide the selected PCF to the consumer. (NOTE 1) |
EXISTING_BINDING_INFO_FOUND |
403 Forbidden |
Indicates that the BSF found an existing PCF binding information for the indicated combination or for the applicable MBS Session. (NOTE 2) |
NOTE 1: This application error is included in the responses to the GET request. NOTE 2: This application error is included in the responses to the POST request. NOTE 3: 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 Nbsf_Management Service API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6].
Table 5.8-1: Supported Features
Feature number |
Feature Name |
Description |
1 |
MultiUeAddr |
This feature indicates the support of multiple UE addresses (IPv6 prefixes or MAC addresses) in the same binding information. |
2 |
BindingUpdate |
The consumer can use this feature for updating the session binding information. |
3 |
SamePcf |
This feature indicates the support of same PCF selection for the indicated combination. |
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 [6] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. |
5 |
ExtendedSamePcf |
This feature extends the support of same PCF selection for the indicated combination. This feature requires the support of SamePcf feature. |
6 |
AddSnssaiDnnPair |
This feature indicates the support of additional S-NSSAI and DNN pair(s) for which the binding event report(s) apply. |
NOTE: The "SamePcf" feature is applicable to the deployments where the N5 and/or Rx interface apply and the UE address is available in the PCF at the creation of the SM Policy Association. The "ExtendedSamePcf" feature is applicable for any PCF deployment, regardless of UE address availability at the creation of SM Policy association and/or N5 and/or Rx applicability. |
5.9 Security
As indicated in 3GPP TS 33.501 [15] and 3GPP TS 29.500 [6], the access to the Nbsf_Management API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [16]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [12]) plays the role of the authorization server.
If OAuth2 is used, a n NF Service Consumer, prior to consuming services offered by the Nbsf_Management API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [12], 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 Nbsf_Management service.
The Nbsf_Management API defines a single scope "nbsf-management" for the entire service, and it does not define any additional scopes at resource or operation level.
Annex A (normative):
OpenAPI specification