6 API Definitions
29.5373GPP5G SystemMulticast/Broadcast Policy Control servicesRelease 18Stage 3TS
6.1 Npcf_MBSPolicyControl Service API
6.1.1 Introduction
The Npcf_MBSPolicyControl Service shall use the Npcf_MBSPolicyControl API.
The API URI of the Npcf_MBSPolicyControl API shall be:
{apiRoot}/<apiName>/<apiVersion>
The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
– The <apiName> shall be "npcf-mbspolicycontrol".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 6.1.3.
6.1.2 Usage of HTTP
6.1.2.1 General
HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
The OpenAPI [6] specification of HTTP messages and content bodies for the Npcf_MBSPolicyControl API is contained in Annex A.2.
6.1.2.2 HTTP standard headers
6.1.2.2.1 General
See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
6.1.2.2.2 Content type
JSON, IETF RFC 8259 [12], 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 [4]. The use of the JSON format shall be signalled by the content type "application/json".
The "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].
6.1.2.3 HTTP custom headers
The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported.
6.1.3 Resources
6.1.3.1 Overview
This clause describes the structure for the resource URIs and the resources and methods used for the Npcf_MBSPolicyControl service.
Figure 6.1.3.1-1 depicts the resource URIs structure for the Npcf_MBSPolicyControl API.
Figure 6.1.3.1-1: Resource URI structure of the Npcf_MBSPolicyControl API
Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 6.1.3.1-1: Resources and methods overview
Resource purpose/name |
Resource URI (relative path after API URI) |
HTTP method or custom operation |
Description (service operation) |
MBS Policies |
/mbs-policies |
POST |
Request the creation of a new Individual MBS Policy resource. |
Individual MBS Policy |
/mbs-policies/{mbsPolicyId} |
GET |
Request the retrieval of an existing Individual MBS Policy Association resource. |
DELETE |
Request the deletion of an existing Individual MBS Policy resource. |
||
Update (POST) |
Request the update of an existing Individual MBS Policy resource. |
6.1.3.2 Resource: MBS Policies
6.1.3.2.1 Description
This resource represents the collection of "Individual MBS Policy" resources managed by the PCF.
6.1.3.2.2 Resource Definition
Resource URI: {apiRoot}/npcf-mbspolicycontrol/<apiVersion>/mbs-policies
This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.
Table 6.1.3.2.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See clause 6.1.1. |
6.1.3.2.3 Resource Standard Methods
6.1.3.2.3.1 POST
This method enables an NF service consumer (e.g. MB-SMF) to request the creation of an MBS Policy Association at the PCF.
This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1.
Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
n/a |
This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3.
Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
MbsPolicyCtxtData |
M |
1 |
Contains the parameters to request the creation of an MBS Policy Association. |
Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
MbsPolicyData |
M |
1 |
201 Created |
Successful case. An Individual MBS Policy resource is successfully created. |
n/a |
308 Permanent Redirect |
Permanent Redirection. Another PCF already serves the MBS Session. |
||
ProblemDetails |
O |
0..1 |
400 Bad Request |
(NOTE 2) |
ProblemDetails |
O |
0..1 |
403 Forbidden |
(NOTE 2) |
MbsExtProblemDetails |
O |
0..1 |
403 Forbidden |
(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 [4] also apply. NOTE 2: Failure cases are described in clause 6.1.7. |
Table 6.1.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-mbspolicycontrol/<apiVersion>/mbs-policies/{mbsPolicyId} |
Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
Contains the URI (i.e. "apiRoot") of the PCF currently handling the MBS Session and towards which the request is redirected. |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Contains the identifier of the PCF (service) instance towards which the request is redirected. |
6.1.3.2.4 Resource Custom Operations
There are no resource custom operations defined for this resource in this release of the specification.
6.1.3.3 Resource: Individual MBS Policy
6.1.3.3.1 Description
This resource represents an "Individual MBS Policy" resource managed by the PCF.
6.1.3.3.2 Resource Definition
Resource URI: {apiRoot}/npcf-mbspolicycontrol/<apiVersion>/mbs-policies/{mbsPolicyId}
This resource shall support the resource URI variables defined in table 6.1.3.3.2-1.
Table 6.1.3.3.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See clause 6.1.1. |
mbsPolicyId |
string |
Represents the unique identifier of the "Individual MBS Policy" resource. |
6.1.3.3.3 Resource Standard Methods
6.1.3.3.3.1 GET
This method enables an NF service consumer (e.g. MB-SMF) to retrieve an existing "Individual MBS Policy" resource at the PCF.
This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1.
Table 6.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
n/a |
This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3.
Table 6.1.3.3.3.1-2: Data structures supported by the GET Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 6.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
MbsPolicyData |
M |
1 |
200 OK |
Successful case. The requested Individual MBS Policy resource is successfully 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 PCF (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 PCF (service) instance. |
NOTE: The mandatory HTTP error status codes for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
Table 6.1.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 6.1.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. |
6.1.3.3.3.2 DELETE
This method enables an NF service consumer (e.g. MB-SMF) to request the deletion of an existing "Individual MBS Policy" resource at the PCF.
This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1.
Table 6.1.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
n/a |
This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3.
Table 6.1.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 6.1.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 |
Successful response. The Individual MBS Policy resource was 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 PCF (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 PCF (service) instance. |
ProblemDetails |
O |
0..1 |
404 Not Found |
(NOTE 2) |
NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: Failure cases are described in clause 6.1.7. |
Table 6.1.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 6.1.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. |
6.1.3.3.4 Resource Custom Operations
6.1.3.3.4.1 Overview
Table 6.1.3.3.4.1-1: Custom operations
Operation name |
Custom operaration URI |
Mapped HTTP method |
Description |
Update |
/mbs-policies/{mbsPolicyId}/update |
Update (POST) |
Request the update of an existing MBS Policy Association. |
6.1.3.3.4.2 Operation: Update
6.1.3.3.4.2.1 Description
This resource custom operation enables an NF service consumer (e.g. MB-SMF) to request the update of an existing MBS Policy Association at the PCF.
6.1.3.3.4.2.2 Operation Definition
This operation shall support the request data structures specified in table 6.1.3.3.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.3.4.2.2-2.
Table 6.1.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
MbsPolicyCtxtDataUpdate |
M |
1 |
Contains the parameters to request the update of the Individual MBS Policy resource. |
Table 6.1.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
MbsPolicyData |
M |
1 |
200 OK |
Successful case. The targeted Individual MBS Policy resource is successfully updated. |
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 PCF (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 PCF (service) instance. |
ProblemDetails |
O |
0..1 |
400 Bad Request |
(NOTE 2) |
ProblemDetails |
O |
0..1 |
403 Forbidden |
(NOTE 2) |
MbsExtProblemDetails |
O |
0..1 |
403 Forbidden |
(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 [4] also apply. NOTE 2: Failure cases are described in clause 6.1.7. |
Table 6.1.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 6.1.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. |
6.1.4 Custom Operations without associated resources
There are no custom operations without associated resources defined for this API in this release of the specification.
6.1.5 Notifications
There are no notifications defined for this API in this release of the specification.
6.1.6 Data Model
6.1.6.1 General
This clause specifies the application data model supported by the API.
Table 6.1.6.1-1 specifies the data types defined for the Npcf_MBSPolicyControl service based interface protocol.
Table 6.1.6.1-1: Npcf_MBSPolicyControl specific Data Types
Data type |
Clause defined |
Description |
Applicability |
MbsErrorReport |
6.1.6.2.10 |
Contains the reporting of MBS Policy decision level failure(s) and/or MBS PCC rule level failure(s). |
|
MbsFailureCode |
6.1.6.3.4 |
Represents the reason for the MBS Policy Decision(s) enforcement failure or the MBS PCC rule(s) installation failure. |
|
MbsMaxDataBurstVol |
6.1.6.3.2 |
Represents the maximum MBS data burst volume. |
|
MbsPccRule |
6.1.6.2.7 |
Represents the parameters constituting an MBS PCC rule. |
|
MbsPcrt |
6.1.6.3.3 |
Represents an MBS Policy Control Request Trigger. |
|
MbsPolicyCtxtData |
6.1.6.2.2 |
Contains the parameters used to request the creation of an Individual MBS Policy resource. |
|
MbsPolicyCtxtDataUpdate |
6.1.6.2.11 |
Contains the parameters to update an existing MBS Policy Association. |
|
MbsPolicyData |
6.1.6.2.4 |
Contains the MBS policy data of an Individual MBS Policy resource. |
|
MbsPolicyDecision |
6.1.6.2.3 |
Contains the parameters constituting an MBS Policy Decision. |
|
MbsPccRuleStatus |
6.1.6.3.5 |
Represents the MBS PCC rule status. |
|
MbsQosChar |
6.1.6.2.9 |
Represents the parameters constituting a set of explicitly signalled QoS Characteristics. |
|
MbsQosDec |
6.1.6.2.8 |
Represents the parameters constituting an MBS QoS Decision. |
|
MbsReport |
6.1.6.2.12 |
Includes the information about the MBS Policy Decision level failure(s) and/or the MBS PCC rule level failure(s). |
Table 6.1.6.1-2 specifies data types re-used by the Npcf_MBSPolicyControl 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_MBSPolicyControl service based interface.
Table 6.1.6.1-2: Npcf_MBSPolicyControl re-used Data Types
Data type |
Reference |
Comments |
Applicability |
5Qi |
3GPP TS 29.571 [15] |
Indicates the 5G QoS Identifier. |
|
5QiPriorityLevel |
3GPP TS 29.571 [15] |
Indicates the 5QI Priority Level. |
|
Arp |
3GPP TS 29.571 [15] |
Indicates the allocation and retention priority. |
|
AverWindow |
3GPP TS 29.571 [15] |
Indicates the Averaging Window. |
|
BitRate |
3GPP TS 29.571 [15] |
Indicates the Bit Rate. |
|
Dnn |
3GPP TS 29.571 [15] |
Identifies a DNN. |
|
FlowDescription |
3GPP TS 29.512 [18] |
Represents packet filter for an IP flow. |
|
MbsExtProblemDetails |
Clause 6.2.6.4.1 |
Identifies the MBS related extensions to the ProblemDetails data structure. |
|
MbsServiceInfo |
3GPP TS 29.571 [15] |
Represents MBS Service Information. |
|
MbsSessionId |
3GPP TS 29.571 [15] |
Represents an MBS Session Identifier. |
|
PacketDelBudget |
3GPP TS 29.571 [15] |
Indicates the Packet Delay Budget. |
|
PacketErrRate |
3GPP TS 29.571 [15] |
Indicates the Packet Error Rate. |
|
QosResourceType |
3GPP TS 29.571 [15] |
Indicates the QoS resource type. |
|
RedirectResponse |
3GPP TS 29.571 [15] |
Contains redirection related information. |
|
Snssai |
3GPP TS 29.571 [15] |
Identifies an S-NSSAI. |
|
SupportedFeatures |
3GPP TS 29.571 [15] |
Represents the list of supported features. It is used to negotiate the applicability of the optional features. |
|
Uinteger |
3GPP TS 29.571 [15] |
Represents an unsigned integer. |
6.1.6.2 Structured data types
6.1.6.2.1 Introduction
This clause defines the structures to be used in resource representations.
6.1.6.2.2 Type: MbsPolicyCtxtData
Table 6.1.6.2.2-1: Definition of type MbsPolicyCtxtData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
mbsSessionId |
MbsSessionId |
M |
1 |
Represents the identifier of the MBS Session. |
|
dnn |
Dnn |
O |
0..1 |
Represents the DNN of the MBS session. |
|
snssai |
Snssai |
O |
0..1 |
Represents the S-NSSAI of the MBS session. |
|
mbsServInfo |
MbsServiceInfo |
O |
0..1 |
Represents the MBS Service Information. |
|
suppFeat |
SupportedFeatures |
C |
0..1 |
Contains the list of the supported features among the ones defined in clause 6.1.8. This attribute shall be present when feature negotiation needs to take place. |
6.1.6.2.3 Type: MbsPolicyDecision
Table 6.1.6.2.3-1: Definition of type MbsPolicyDecision
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
mbsPccRules |
map(MbsPccRule) |
O |
1..N |
A map of MBS PCC rule(s) with the content being the MbsPccRule as described in clause 6.1.6.2.7. The key used in this map for each entry is the "mbsPccRuleId" attribute of the corresponding MbsPccRule instance. |
|
mbsQosDecs |
map(MbsQosDec) |
O |
1..N |
Map of MBS QoS Decision(s). The key used in this map for each entry is the "mbsQosId" attribute of the corresponding MbsQosDec instance. (NOTE) |
|
mbsQosChars |
map(MbsQosChar) |
O |
1..N |
Map of QoS characteristics for non-standard 5QIs and non-preconfigured 5QIs. The key of the map is the 5QI value within the "5qi" attribute of the corresponding MbsQosChar instance. (NOTE) |
|
authMbsSessAmbr |
BitRate |
O |
0..1 |
The Authorized MBS Session-AMBR. |
|
mbsPcrts |
array(MbsPcrt) |
O |
1..N |
The MBS Policy Control Request Triggers(s) that the PCF requests to subscribe to. |
|
NOTE: This attribute shall not be removed if it was provisioned. |
6.1.6.2.4 Type: MbsPolicyData
Table 6.1.6.2.4-1: Definition of type MbsPolicyData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
mbsPolicyCtxtData |
MbsPolicyCtxtData |
M |
1 |
Contains the parameters used to request the MBS policy creation. |
|
mbsPolicies |
MbsPolicyDecision |
C |
0..1 |
Contains the provisioned MBS Policy Decision containing the MBS policies authorized by the PCF. This attribute shall be present in the response to a request to create an MBS Policy Association or a request to retrieve the properties of an existing MBS Policy Association, and may be present in the response to a request to update an existing MBS Policy Association. |
|
suppFeat |
SupportedFeatures |
C |
0..1 |
Contains the list of negotiated supported features. This parameter shall be provided by the PCF in the response to a request in which the NF service consumer provided the list of features that it supports. |
6.1.6.2.5 Void
6.1.6.2.6 Void
6.1.6.2.7 Type: MbsPccRule
Table 6.1.6.2.7-1: Definition of type MbsPccRule
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
mbsPccRuleId |
string |
M |
1 |
Univocally identifies the MBS PCC rule within the related MBS session. |
|
mbsDlIpFlowInfo |
array(FlowDescription) |
C |
1..N |
Contains the MBS downlink IP flow packet filter(s) information. (NOTE 3) |
|
precedence |
Uinteger |
O |
0..1 |
Determines the order in which this MBS PCC rule is applied relative to other MBS PCC rules within the same MBS session. (NOTE 1) |
|
refMbsQosDec |
array(string) |
C |
1..N |
A reference to the MbsQosDec policy decision type. It is the mbsQosId described in clause 6.1.6.2.8. (NOTE 2, NOTE 3) |
|
NOTE 1: The "precedence" attribute is used to specify the precedence of the MBS PCC rule among all MBS PCC rules associated with the MBS session. It includes an integer value in the range of 0 to 255 (decimal). The higher the value of the "precedence" attribute, the lower the precedence of the MBS PCC rule to which it applies. NOTE 2: Arrays are only introduced for future compatibility. In this release of the specification, the maximum number of elements in the array is 1. NOTE 3: This attribute shall be present in the response to an MBS Policy Association Creation request and may be present in the response to an MBS Policy Association Update request. |
6.1.6.2.8 Type: MbsQosDec
Table 6.1.6.2.8-1: Definition of type MbsQosDec
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
mbsQosId |
string |
M |
1 |
Univocally identifies the MBS QoS Decision within the related MBS session. |
|
5qi |
5Qi |
O |
0..1 |
Identifier for the authorized QoS parameters for the MBS service data flow. (NOTE 2) |
|
priorityLevel |
5QiPriorityLevel |
O |
0..1 |
Indicates a priority in scheduling resources among MBS QoS flows. (NOTE 1) |
|
mbrDl |
BitRate |
O |
0..1 |
Indicates the maximum bandwidth in downlink. |
|
gbrDl |
BitRate |
O |
0..1 |
Indicates the guaranteed bandwidth in downlink. |
|
arp |
Arp |
O |
0..1 |
Indicates the allocation and retention priority. |
|
averWindow |
AverWindow |
O |
0..1 |
Represents the duration over which the guaranteed and maximum bitrates shall be calculated. (NOTE 1) |
|
mbsMaxDataBurstVol |
MbsMaxDataBurstVol |
O |
0..1 |
Denotes the largest amount of data that is required to be transferred within a period. (NOTE 1) |
|
NOTE 1: This attribute is applicable only when a value different from the standardized 5QI values, defined in table 5.7.4-1 3GPP TS 23.501 [2], is provided. NOTE 2: When the provided 5QI value is a dynamically assigned 5QI (i.e. from the non-standardized and non-preconfigured value range), the corresponding QoS parameters (e.g. Packet Delay Budget, Packet Error Rate, etc.) are provided in the corresponding MbsQosChar data structure. |
6.1.6.2.9 Type: MbsQosChar
Table 6.1.6.2.9-1: Definition of type MbsQosChar
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
5qi |
5Qi |
M |
1 |
Represents the identifier of the set of non-standardized and non-preconfigured MBS QoS parameters for an MBS service data flow. |
|
resourceType |
QosResourceType |
M |
1 |
Indicates whether the MBS QoS resource type is GBR, delay critical GBR or non-GBR. |
|
priorityLevel |
5QiPriorityLevel |
M |
1 |
Indicates the 5QI Priority Level within a range of 1 to 127 and encoded as an unsigned integer. |
|
packetDelayBudget |
PacketDelBudget |
M |
1 |
Indicates the packet delay budget expressed in milliseconds and encoded as an unsigned integer. |
|
packetErrorRate |
PacketErrRate |
M |
1 |
Indicates the packet error rate encoded as a string. Examples: – A Packer Error Rate of 4×10-6 shall be encoded as "4E-6". – A Packer Error Rate of 10-2 shall be encoded as"1E-2". |
|
averWindow |
AverWindow |
C |
0..1 |
Indicates the averaging window. This attribute shall be present only for a GBR QoS flow or a Delay Critical GBR QoS flow. |
|
mbsMaxDataBurstVol |
MbsMaxDataBurstVol |
M |
1 |
Indicates the maximum data burst volume, encoded as an unsigned integer. |
6.1.6.2.10 Type: MbsErrorReport
Table 6.1.6.2.11-1: Definition of type MbsErrorReport
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
mbsReports |
array(MbsReport) |
O |
1..N |
Contains the reporting of MBS Policy decision level failure(s) and/or MBS PCC rule level failure(s). |
6.1.6.2.11 Type: MbsPolicyCtxtDataUpdate
Table 6.1.6.2.11-1: Definition of type MbsPolicyCtxtDataUpdate
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
mbsServInfo |
MbsServiceInfo |
O |
0..1 |
Represents the updated MBS Service Information. |
|
mbsPcrts |
array(MbsPcrt) |
O |
1..N |
Represents the list of MBS Policy Control Request Triggers that are met. |
|
mbsErrorReport |
MbsErrorReport |
O |
0..1 |
Contains the reporting of MBS Policy decision level failure(s) and/or MBS PCC rule level failure(s). |
6.1.6.2.12 Type: MbsReport
Table 6.1.6.2.12-1: Definition of type MbsReport
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
mbsPccRuleIds |
array(string) |
C |
1..N |
Contains the identifier(s) of the affected MBS PCC rule(s). This attribute shall be present if the reported failure is related to the MBS PCC rule(s) installation. (NOTE) |
|
mbsPccRuleStatus |
MbsPccRuleStatus |
C |
0..1 |
Indicates the status of the MBS PCC rule(s) identified by the "mbsPccRuleIds" attribute. This attribute shall be present only if the "mbsPccRuleIds" attribute is present. |
|
failureCode |
MbsFailureCode |
C |
0..1 |
Indicates the reason of the failure of the MBS Policy Decision or the MBS PCC rule(s) identified by the "mbsPccRuleIds" attribute. This attribute shall be present when available. (NOTE) |
|
NOTE: If the reported failure is due to MBS Policy Decision failure, then the "mbsPccRuleIds" attribute shall not be present and the "failureCode" attribute indicates the appropriate failure cause illustrating the MBS Policy Decision failure that occurred. |
6.1.6.3 Simple data types and enumerations
6.1.6.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
6.1.6.3.2 Simple data types
The simple data types defined in table 6.1.6.3.2-1 shall be supported.
Table 6.1.6.3.2-1: Simple data types
Type Name |
Type Definition |
Description |
Applicability |
MbsMaxDataBurstVol |
Integer |
Represents MBS Maximum Data Burst Volume expressed in Bytes. Minimum = 1. Maximum = 2000000. |
6.1.6.3.3 Enumeration: MbsPcrt
The enumeration MbsPcrt represents the MBS Policy Control Request Triggers. It shall comply with the provisions defined in table 6.1.6.3.3-1.
Table 6.1.6.3.3-1: Enumeration MbsPcrt
Enumeration value |
Description |
Applicability |
MBS_SESSION_UPDATE |
Indicates the MBS Session Update policy control request trigger. This MBS Policy Control Request Trigger is implicitly subscribed by the PCF, i.e. pre-configured at the NF service consumer (MB-SMF). |
6.1.6.3.4 Enumeration: MbsFailureCode
The enumeration MbsFailureCode represents the reason behind the MBS Policy Decision failure. It shall comply with the provisions of table 6.1.6.3.4-1.
Table 6.1.6.3.4-1: Enumeration MbsFailureCode
Enumeration value |
Description |
Applicability |
NF_MALFUNCTION |
Indicates that the MBS PCC rule could not be successfully installed due to MB-SMF/MB-UPF malfunction. |
|
NF_RESOURCES_UNAVAILABLE |
Indicates that the MBS PCC rule could not be successfully installed due to resources unavailable at the MB-SMF/MB-UPF. |
|
RESOURCE_ALLOCATION_FAILURE |
Indicates that the MBS PCC rule could not be successfully installed or maintained since the associated MBS QoS flow establishment/modification failed or the associated MBS QoS flow was released. |
|
MBS_QOS_VALIDATION_FAILURE |
Indicate that MBS QoS validation has failed. |
|
NO_MBS_QOS_FLOW |
Indicates that there is no MBS QoS flow to which the MB-SMF can bind the MBS PCC rule(s). |
|
MBS_QOS_DECISION_ERROR |
Indicates failure in the provisioning of MBS QoS Decision data. |
|
MBS_POLICY_PARAM_ERROR |
Indicates that the information related to the provisioned MBS policy parameter(s) is incorrect, incomplete or inconsistent. |
6.1.6.3.5 Enumeration: MbsPccRuleStatus
The enumeration MbsPccRuleStatus represents the MBS PCC rule status. It shall comply with the provisions of table 6.1.6.3.5-1.
Table 6.1.6.3.5-1: Enumeration MbsPccRuleStatus
Enumeration value |
Description |
Applicability |
ACTIVE |
Indicates that the MBS PCC rule(s) are successfully installed. |
|
INACTIVE |
Indicates that the MBS PCC rule(s) are removed. |
6.1.6.4 Data types describing alternative data types or combinations of data types
There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification.
6.1.6.5 Binary data
6.1.6.5.1 Binary Data Types
Table 6.1.6.5.1-1: Binary Data Types
Name |
Clause defined |
Content type |
6.1.7 Error Handling
6.1.7.1 General
For the Npcf_MBSPolicyControl API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] 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 [4].
In addition, the requirements in the following clauses are applicable for the Npcf_MBSPolicyControl API.
6.1.7.2 Protocol Errors
No specific procedures for the Npcf_MBSPolicyControl service are specified.
6.1.7.3 Application Errors
The application errors defined for the Npcf_MBSPolicyControl service are listed in Table 6.1.7.3-1.
Table 6.1.7.3-1: Application errors
Application Error |
HTTP status code |
Description |
INVALID_MBS_SERVICE_INFO |
400 Bad Request |
The HTTP request is rejected because the provided MBS Service Information is invalid (e.g. invalid QoS reference), incorrect or insufficient for the PCF to perform MBS policy authorization. |
FILTER_RESTRICTIONS_NOT_RESPECTED |
400 Bad Request |
The HTTP request is rejected because the MBS IP flow(s) description provided within the MBS Service Information cannot be handled due to the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [19] not being respected. |
ERROR_INPUT_PARAMETERS |
400 Bad Request |
The HTTP request is rejected because the provided set of input parameters are incomplete, erroneous or missing necessary information for the PCF to perform MBS policy control. |
MBS_SERVICE_INFO_NOT_AUTHORIZED |
403 Forbidden |
The HTTP request is rejected because the provided MBS Service Information not authorized for the PCF to perform MBS policy authorization. |
MBS_POLICY_CONTEXT_DENIED |
403 Forbidden |
The HTTP request is rejected because the PCF does not accept the NF service consumer request due to operator policies and/or local configuration. |
MBS_POLICY_ASSOCIATION_NOT_FOUND |
404 Not Found |
The HTTP request is rejected because the targeted MBS Policy Association does not exist at the PCF. |
6.1.8 Feature negotiation
The optional features in table 6.1.8-1 are defined for the Npcf_MBSPolicyControl API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4].
Table 6.1.8-1: Supported Features
Feature number |
Feature Name |
Description |
6.1.9 Security
As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Npcf_MBSPolicyControl API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server.
If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Npcf_MBSPolicyControl API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], 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_MBSPolicyControl service.
The Npcf_MBSPolicyControl API defines a single scope "npcf-mbspolicycontrol" for the entire service, and it does not define any additional scopes at resource or operation level.
6.2 Npcf_MBSPolicyAuthorization Service API
6.2.1 Introduction
The Npcf_MBSPolicyAuthorization Service shall use the Npcf_MBSPolicyAuthorization API.
The API URI of the Npcf_MBSPolicyAuthorization API shall be:
{apiRoot}/<apiName>/<apiVersion>
The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
– The <apiName> shall be "npcf-mbspolicyauth".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 6.2.3.
6.2.2 Usage of HTTP
6.2.2.1 General
HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
The OpenAPI [6] specification of HTTP messages and content bodies for the Npcf_MBSPolicyAuthorization API is contained in Annex A.2.
6.2.2.2 HTTP standard headers
6.2.2.2.1 General
See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
6.2.2.2.2 Content type
JSON, IETF RFC 8259 [12], 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 [4]. The use of the JSON format shall be signalled by the content type "application/json".
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 [22].
The "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].
6.2.2.3 HTTP custom headers
The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported.
6.2.3 Resources
6.2.3.1 Overview
This clause describes the structure of the resource URIs and the resources and methods used for the Npcf_MBSPolicyAuthorization service.
Figure 6.2.3.1-1 depicts the resource URIs structure for the Npcf_MBSPolicyAuthorization API.
Figure 6.2.3.1-1: Resource URI structure of the Npcf_MBSPolicyAuthorization API
Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 6.2.3.1-1: Resources and methods overview
Resource purpose/name |
Resource URI (relative path after API URI) |
HTTP method or custom operation |
Description (service operation) |
MBS Application Session Contexts |
/contexts |
POST |
Create a new MBS Application Session Context. |
Individual MBS Application Session Context |
/contexts/{contextId} |
GET |
Retrieve an existing Individual MBS Application Session Context resource. |
PATCH |
Modify an existing Individual MBS Application Session Context resource. |
||
DELETE |
Delete an existing Individual MBS Application Session Context resource. |
6.2.3.2 Resource: MBS Application Session Contexts
6.2.3.2.1 Description
This resource represents the collection of "Individual MBS Application Session Context" resources managed by the PCF.
6.2.3.2.2 Resource Definition
Resource URI: {apiRoot}/npcf-mbspolicyauth/<apiVersion>/contexts
This resource shall support the resource URI variables defined in table 6.2.3.2.2-1.
Table 6.2.3.2.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See clause 6.2.1. |
6.2.3.2.3 Resource Standard Methods
6.2.3.2.3.1 POST
This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1.
Table 6.2.3.2.3.1-1: URI query parameters supported by the POST method on this resource
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
n/a |
This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3.
Table 6.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
MbsAppSessionCtxt |
M |
1 |
Contains the parameters to create an Individual MBS Application Session Context for MBS policy authorization. |
Table 6.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
MbsAppSessionCtxt |
M |
1 |
201 Created |
Successful case. An Individual MBS Application Session Context resource is successfully created and a representation of the created resource is returned in the response body. A Location header field containing the URI of the created resource is also included. |
ProblemDetails |
O |
0..1 |
400 Bad Request |
(NOTE 2) |
MbsExtProblemDetails |
O |
0..1 |
403 Forbidden |
(NOTE 2) |
NOTE 1: The mandatory HTTP error status codes for the HTTP POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: Failure cases are described in clause 6.2.7. |
Table 6.2.3.2.3.1-4: Headers supported by the POST method 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-mbspolicyauth/<apiVersion>/contexts/{contextId} |
6.2.3.2.4 Resource Custom Operations
There are no resource custom operations defined for this resource in this release of the specification.
6.2.3.3 Resource: Individual MBS Application Session Context
6.2.3.3.1 Description
This resource represents an "Individual MBS Application Session Context" resource managed by the PCF.
6.2.3.3.2 Resource Definition
Resource URI: {apiRoot}/npcf-mbspolicyauth/<apiVersion>/contexts/{contextId}
This resource shall support the resource URI variables defined in table 6.2.3.3.2-1.
Table 6.2.3.3.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See clause 6.2.1. |
contextId |
string |
Represents the unique identifier of the "Individual MBS Application Session Context" resource. |
6.2.3.3.3 Resource Standard Methods
6.2.3.3.3.1 GET
This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1.
Table 6.2.3.3.3.1-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
n/a |
This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3.
Table 6.2.3.3.3.1-2: Data structures supported by the GET Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 6.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
MbsAppSessionCtxt |
M |
1 |
200 OK |
Successful case. The requested Individual MBS Application Session Context resource is successfully returned. |
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 PCF (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 PCF (service) instance. |
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 [4] also apply. |
Table 6.2.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 6.2.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. |
6.2.3.3.3.2 PATCH
This method shall support the URI query parameters specified in table 6.2.3.3.3.2-1.
Table 6.2.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
n/a |
This method shall support the request data structures specified in table 6.2.3.3.3.2-2 and the response data structures and response codes specified in table 6.2.3.3.3.2-3.
Table 6.2.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource
Data type |
P |
Cardinality |
Description |
MbsAppSessionCtxtPatch |
M |
1 |
Contains the parameters to request the modification of an existing Individual MBS Application Session Context resource. |
Table 6.2.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
MbsAppSessionCtxt |
M |
1 |
200 OK |
Successful case. The corresponding Individual MBS Application Session Context 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 corresponding Individual MBS Application Session Context 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 PCF (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 PCF (service) instance. |
ProblemDetails |
O |
0..1 |
400 Bad Request |
(NOTE 2) |
MbsExtProblemDetails |
O |
0..1 |
403 Forbidden |
(NOTE 2) |
ProblemDetails |
O |
0..1 |
404 Not Found |
(NOTE 2) |
NOTE 1: The mandatory HTTP error status codes for the HTTP PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: Failure cases are described in clause 6.2.7. |
Table 6.2.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 6.2.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. |
6.2.3.3.3.3 DELETE
This method shall support the URI query parameters specified in table 6.2.3.3.3.3-1.
Table 6.2.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
n/a |
This method shall support the request data structures specified in table 6.2.3.3.3.3-2 and the response data structures and response codes specified in table 6.2.3.3.3.3-3.
Table 6.2.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 6.2.3.3.3.3-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 corresponding Individual MBS Application Session Context 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 PCF (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 PCF (service) instance. |
ProblemDetails |
O |
0..1 |
404 Not Found |
(NOTE 2) |
NOTE 1: The mandatory HTTP error status codes for the HTTP DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. NOTE 2: Failure cases are described in clause 6.2.7. |
Table 6.2.3.3.3.3-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 6.2.3.3.3.3-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. |
6.2.3.3.4 Resource Custom Operations
There are no resource custom operations defined for this resource in this release of the specification.
6.2.4 Custom Operations without associated resources
There are no custom operations without associated resources defined for this API in this release of the specification.
6.2.5 Notifications
There are no notifications defined for this API in this release of the specification.
6.2.6 Data Model
6.2.6.1 General
This clause specifies the application data model supported by the API.
Table 6.2.6.1-1 specifies the data types defined for the Npcf_MBSPolicyAuthorization service based interface protocol.
Table 6.2.6.1-1: Npcf_MBSPolicyAuthorization specific Data Types
Data type |
Clause defined |
Description |
Applicability |
AcceptableMbsServInfo |
6.2.6.2.4 |
Contains the MBS Service Information that can be accepted by the PCF. |
|
MbsExtProblemDetails |
6.2.6.4.1 |
Identifies the MBS related extensions to the ProblemDetails data structure. |
|
MbsAppSessionCtxt |
6.2.6.2.2 |
Represents the parameters of an MBS Application Session Context. |
|
MbsAppSessionCtxtPatch |
6.2.6.2.3 |
Represents the modifications to an existing MBS Application Session Context. |
Table 6.2.6.1-2 specifies data types re-used by the Npcf_MBSPolicyAuthorization 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_MBSPolicyAuthorization service based interface.
Table 6.2.6.1-2: Npcf_MBSPolicyAuthorization re-used Data Types
Data type |
Reference |
Comments |
Applicability |
BitRate |
3GPP TS 29.571 [15] |
Represents a bit rate. |
|
Dnn |
3GPP TS 29.571 [15] |
Identifies a DNN. |
|
MbsMediaComp |
3GPP TS 29.571 [15] |
Represents an MBS Media Component. |
|
MbsServiceInfo |
3GPP TS 29.571 [15] |
Represents MBS Service Information. |
|
MbsSessionId |
3GPP TS 29.571 [15] |
Represents an MBS Session Identifier. |
|
ProblemDetails |
3GPP TS 29.571 [15] |
Contains error related additional information. |
|
RedirectResponse |
3GPP TS 29.571 [15] |
Contains redirection related information. |
|
Snssai |
3GPP TS 29.571 [15] |
Identifies an S-NSSAI. |
|
SupportedFeatures |
3GPP TS 29.571 [15] |
Represents the list of supported features. It is used to negotiate the applicability of the optional features. |
6.2.6.2 Structured data types
6.2.6.2.1 Introduction
This clause defines the structures to be used in resource representations.
6.2.6.2.2 Type: MbsAppSessionCtxt
Table 6.2.6.2.2-1: Definition of type MbsAppSessionCtxt
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
mbsSessionId |
MbsSessionId |
M |
1 |
Represents the identifier of the corresponding MBS Session. |
|
mbsServInfo |
MbsServiceInfo |
C |
0..1 |
Represents the MBS Service Information. This attribute shall be provided, if available. |
|
dnn |
Dnn |
O |
0..1 |
Represents the DNN of the MBS session. |
|
snssai |
Snssai |
O |
0..1 |
Represents the S-NSSAI of the MBS session. |
|
contactPcfInd |
boolean |
O |
0..1 |
Indicates whether the PCF shall be contacted or not, i.e.: – "true" means that the PCF shall be contacted; and – "false" means that the PCF shall not be contacted. When this attribute is not present, the default value is "false". This attribute may only be present in the response to an MBS Application Session Context update request. |
|
suppFeat |
SupportedFeatures |
C |
0..1 |
Contains the list of the supported features (among the ones defined in clause 6.2.8). This parameter shall be provided if feature negotiation needs to take place. |
6.2.6.2.3 Type: MbsAppSessionCtxtPatch
Table 6.2.6.2.3-1: Definition of type MbsAppSessionCtxtPatch
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
mbsServInfo |
MbsServiceInfo |
O |
0..1 |
Represents the updated MBS Service Information. |
6.2.6.2.4 Type: AcceptableMbsServInfo
Table 6.2.6.2.4-1: Definition of type AcceptableMbsServInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
accMbsServInfo |
map(MbsMediaComp) |
C |
1..N |
Contains the maximum acceptable bandwidth per media component that can be accepted and authorized by the PCF. Each map entry encoded using the MbsMediaCom data structure shall only include the "mbsMedCompNum" attribute and the "maxReqMbsBwDl" attribute indicating the maximum acceptable bandwidth. The key of the map is the "medCompN" attribute of the corresponding MbsMediaCom data structure provided as a map entry. (NOTE) |
|
accMaxMbsBw |
BitRate |
C |
0..1 |
Contains the maximum acceptable bandwidth. (NOTE) |
|
NOTE: When the acceptable MBS bandwidth is per MBS media component, only the "accMbsServInfo" attribute shall be present. When the acceptable MBS bandwidth applies to all the MBS media components, only the "accMaxMbsBw" attribute shall be present. |
6.2.6.3 Simple data types and enumerations
6.2.6.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
6.2.6.3.2 Simple data types
The simple data types defined in table 6.2.6.3.2-1 shall be supported.
Table 6.2.6.3.2-1: Simple data types
Type Name |
Type Definition |
Description |
Applicability |
6.2.6.4 Data types describing alternative data types or combinations of data types
6.2.6.4.1 Type: MbsExtProblemDetails
Table 6.2.6.4.1-1: Definition of type MbsExtProblemDetails as a list of to be combined data types
Data type |
Cardinality |
Description |
Applicability |
ProblemDetails |
1 |
Contains the details of the encountered problem, as defined in 3GPP TS 29.571 [15]. |
|
AcceptableMbsServInfo |
0..1 |
Contains the MBS Service Information that can be accepted by the PCF. |
6.2.6.5 Binary data
6.2.6.5.1 Binary Data Types
Table 6.2.6.5.1-1: Binary Data Types
Name |
Clause defined |
Content type |
6.2.7 Error Handling
6.2.7.1 General
For the Npcf_MBSPolicyAuthorization API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] 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 [4].
In addition, the requirements in the following clauses are applicable for the Npcf_MBSPolicyAuthorization API.
6.2.7.2 Protocol Errors
No specific procedures for the Npcf_MBSPolicyAuthorization service are specified.
6.2.7.3 Application Errors
The application errors defined for the Npcf_MBSPolicyAuthorization service are listed in table 6.2.7.3-1.
Table 6.2.7.3-1: Application errors
Application Error |
HTTP status code |
Description |
INVALID_MBS_SERVICE_INFO |
400 Bad Request |
The provided MBS Service Information is invalid (e.g. invalid QoS reference), incorrect or insufficient for the PCF to perform MBS policy authorization. |
FILTER_RESTRICTIONS_NOT_RESPECTED |
400 Bad Request |
The MBS IP flow(s) description provided within the MBS Service Information cannot be handled due to the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [19] not being respected. |
MBS_SERVICE_INFO_NOT_AUTHORIZED |
403 Forbidden |
The provided MBS Service Information is rejected. |
MBS_SESSION_POL_AUTH_CTXT_NOT_FOUND |
404 Not Found |
The targeted Individual MBS Application Session Context does not exist. |
6.2.8 Feature negotiation
The optional features in table 6.2.8-1 are defined for the Npcf_MBSPolicyAuthorization API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4].
Table 6.2.8-1: Supported Features
Feature number |
Feature Name |
Description |
6.2.9 Security
As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Npcf_MBSPolicyAuthorization API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server.
If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Npcf_MBSPolicyAuthorization API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], 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_MBSPolicyAuthorization service.
The Npcf_MBSPolicyAuthorization API defines a single scope "npcf-mbspolicyauth" for the entire service, and it does not define any additional scopes at resource or operation level.
Annex A (normative):
OpenAPI specification