5.3 Resources
29.5123GPP5G SystemRelease 18Session Management Policy Control ServiceStage 3TS
5.3.1 Resource Structure
Figure 5.3.1-1: Resource URI structure of the Npcf_SMPolicyControl 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 |
|
SM Policies |
/sm-policies |
POST |
Create a new Individual SM Policies resource for a SUPI or a PEI and PDU Session ID supplied by the NF service consumer. |
|
Individual SM Policy |
/sm-policies/{smPolicyId} |
GET |
Read an Individual SM Policies resource. |
|
/sm-policies/{smPolicyId}/delete |
delete (POST) |
Delete an Individual SM Policies resource. |
|
|
/sm-policies/{smPolicyId}/update |
update (POST) |
Update an Individual SM Policies resource when a policy control request event is met or an error of policy enforcement occurs. |
5.3.2 Resource: SM Policies
5.3.2.1 Description
This resource represents the collection of the individual SM Policies created in the PCF.
5.3.2.2 Resource definition
Resource URI: {apiRoot}/npcf-smpolicycontrol/v1/sm-policies
This resource shall support the resource URI variables defined in table 5.3.2.2-1.
Table 5.3.2.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 5.1 |
5.3.2.3 Resource Standard Methods
5.3.2.3.1 POST
This method shall support the URI query parameters specified in table 5.3.2.3.1-1.
Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3.
Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
SmPolicyContextData |
M |
1 |
Parameters to create an individual SM policies resources. |
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 |
|
SmPolicyDecision |
M |
1 |
201 Created |
An individual SM Policy resources for the SUPI and PDU session id are created successfully. |
|
ProblemDetails |
O |
0..1 |
400 Bad Request |
(NOTE 2) |
|
ProblemDetails |
O |
0..1 |
403 Forbidden |
(NOTE 2) |
|
n/a |
308 Permanent Redirect |
The URI of the PCF within the existing PCF binding information stored in the BSF for the indicated combination is returned in the non-roaming or home-routed scenario. (NOTE 3) |
||
|
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] shall also apply. NOTE 2: Failure cases are described in clause 5.7. NOTE 3：Only applicable to the "SamePcf" feature as defined in clause 5.8. |
||||
Table 5.3.2.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/npcf-smpolicycontrol/v1/sm-policies/{smPolicyId} |
Table 5.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 of the PCF within the existing PCF binding information stored in the BSF for the indicated combination. |
5.3.2.4 Resource Custom Operations
None.
5.3.3 Resource: Individual SM Policy
5.3.3.1 Description
The individual SM Policy resource represents an individual SM Policy created in the PCF and associated with the SUPI and PDU session ID.
5.3.3.2 Resource definition
Resource URI: {apiRoot}/npcf-smpolicycontrol/v1/sm-policies/{smPolicyId}
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 |
|
smPolicyId |
string |
Unique identifier of the individual SM Policy resource. |
5.3.3.3 Resource Standard Methods
5.3.3.3.1 GET
This method shall support the URI query parameters specified in table 5.3.3.3.1-1.
Table 5.3.3.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 5.3.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 GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 5.3.3.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
SmPolicyControl |
M |
1 |
200 OK |
An individual SM Policy resources for the SUPI and PDU session id are returned successfully. |
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during Individual SM policy retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance. Applicable if the feature "ES3XX" is supported. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection, during Individual SM policy retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance. Applicable if the feature "ES3XX" is supported. |
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] 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 PCF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |
Table 5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative PCF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |
5.3.3.4 Resource Custom Operations
5.3.3.4.1 Overview
Table 5.3.3.4.1-1: Custom operations
|
Operation Name |
Custom operation URI |
Mapped HTTP method |
Description |
|
delete |
/sm-policies/{smPolicyId}/delete |
delete (POST) |
Delete an individual SM Policy resource. |
|
update |
/sm-policies/{smPolicyId}/update |
update (POST) |
Update an individual SM Policy resource. |
5.3.3.4.2 Operation: delete
5.3.3.4.2.1 Description
5.3.3.4.2.2 Operation Definition
This custom operation deletes an individual SM Policy resource in the PCF.
This operation shall support the request data structures specified in table 5.3.3.4.2.2-1 and the response data structure and response codes specified in table 5.3.3.4.2.2-2.
Table 5.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
SmPolicyDeleteData |
O |
0..1 |
Parameters to be sent by the NF service consumer when the individual SM policy is deleted. |
Table 5.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
This case represents a successful deletion of the individual SM policy resource. |
||
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during Individual SM policy deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance. Applicable if the feature "ES3XX" is supported. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection, during Individual SM policy deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance. Applicable if the feature "ES3XX" is supported. |
|
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply. |
||||
Table 5.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative PCF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |
Table 5.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative PCF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |
5.3.3.4.3 Operation: update
5.3.3.4.3.1 Description
5.3.3.4.3.2 Operation Definition
This custom operation updates an individual SM Policy resource in the PCF.
This operation shall support the request data structures specified in table 5.3.3.4.3.2-1 and the response data structure and response codes specified in table 5.3.3.4.3.2-2.
Table 5.3.3.4.3.2-1: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
SmPolicyUpdateContextData |
M |
1 |
Parameters to be sent by the NF service consumer when the individual SM policy is updated. It indicates the occurred changes. |
Table 5.3.3.4.3.2-2: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
SmPolicyDecision |
M |
1 |
200 OK |
An individual SM Policy resources is updated successfully. Response body includes the policy decision changes. |
|
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during Individual SM policy modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance. Applicable if the feature "ES3XX" is supported. |
|
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection, during Individual SM policy modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance. Applicable if the feature "ES3XX" is supported. |
|
ProblemDetails |
O |
0..1 |
400 Bad Request |
(NOTE 2) |
|
ProblemDetails |
O |
0..1 |
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] shall also apply. NOTE 2: Failure cases are described in clause 5.7. |
||||
Table 5.3.3.4.3.2-3: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative PCF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |
Table 5.3.3.4.3.2-4: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI 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 |