hash
stringlengths 32
32
| doc_id
stringlengths 5
12
| section
stringlengths 5
1.47k
| content
stringlengths 0
6.67M
|
|---|---|---|---|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.2.2 HTTP standard headers
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.2.2.1 General
|
See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
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".
"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 9457 [13].
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.2.3 HTTP custom headers
|
The Naf_VFLInference service API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4].
In this release of the specification, no specific custom headers are defined for the Naf_VFLInference service API.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3 Resources
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.1 Resource Structure
|
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 6.2.3.1-1 depicts the resource URIs structure for the Naf_VFLInference API.
Figure 6.2.3.1-1: Resource URI structure of the Naf_VFLInference 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 name
Resource URI
HTTP method or custom operation
Description
VFL Inference Subscriptions
/subscriptions
POST
Creates a new Individual VFL Inference Subscription resource.
Individual VFL Inference Subscription
/subscriptions/{subscriptionId}
GET
Retrieve an existing Individual VFL Inference Subscription identified by subresource {subscriptionId}.
PUT
Updates an existing Individual VFL Inference Subscription identified by subresource {subscriptionId}.
PATCH
Modifies an existing Individual VFL Inference Subscription identified by subresource {subscriptionId}.
DELETE
Deletes an Individual VFL Inference Subscription identified by subresource {subscriptionId}.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.2 Resource: VFL Inference Subscriptions
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.2.1 Description
|
The VFL Inference Subscriptions resource represents all VFL Inference subscriptions to the Naf_VFLInference service at a given AF. The resource allows an NF service consumer to create a new Individual VFL Inference Subscription resource.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.2.2 Resource definition
|
Resource URI: {apiRoot}/naf-vflinference/<apiVersion>/subscriptions
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
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.2.3 Resource Standard Methods
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
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
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
VflInferSub
M
1
Creates a new Individual VFL Inference Subscription resource.
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
VflInferSub
M
1
201 Created
The creation of an Individual VFL Inference Subscription resource is confirmed and a representation of that resource is returned.
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.
Table 6.2.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}/naf-vflinference/<apiVersion>/subscriptions/{subscriptionId}
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.2.4 Resource Custom Operations
|
None in this release of the specification.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.3 Resource: Individual VFL Inference Subscription
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.3.1 Description
|
The Individual VFL Inference Subscription resource represents a single VFL inference subscription to the Naf_VFLInference service at a given AF.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.3.2 Resource definition
|
Resource URI: {apiRoot}/naf-vflinference/<apiVersion>/subscriptions/{subscriptionId}
The <apiVersion> shall be set as described in clause 6.2.1.
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.
subscriptionId
string
Identifies a VFL inference subscription to the Naf_VFLInference service.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.3.3 Resource Standard Methods
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.3.3.1 GET
|
The GET method allows an NF service consumer to retrieve an existing "Individual VFL Inference Subscription" resource managed by the AF.
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.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.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource
Data type
P
Cardinality
Response
codes
Description
VflInferSub
M
1
200 OK
Successful case. The requested "Individual VFL Inference Subscription" resource is returned.
RedirectResponse
O
0..1
307 Temporary Redirect
Temporary redirection.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(NOTE 2)
NOTE 1: 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] shall also apply.
NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]).
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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.3.3.2 PUT
|
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 PUT method on this resource
Name
Data type
P
Cardinality
Description
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 PUT Request Body on this resource
Data type
P
Cardinality
Description
VflInferSub
M
1
Parameters to replace a subscription to VFL Subscription resource.
Table 6.2.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource
Data type
P
Cardinality
Response codes
Description
VflInferSub
M
1
200 OK
The Individual VFL Subscription resource was modified successfully, and a representation of that resource is returned.
n/a
204 No Content
The Individual VFL Subscription resource was modified successfully.
RedirectResponse
O
0..1
307 Temporary Redirect
Temporary redirection.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(NOTE 2)
NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.
NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]).
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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Contains the 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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Contains the identifier of the target NF (service) instance towards which the request is redirected
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.3.3.3 PATCH
|
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 PATCH method on this resource
Name
Data type
P
Cardinality
Description
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 PATCH Request Body on this resource
Data type
P
Cardinality
Description
VflInferSubPatch
M
1
Partial update of parameters to a subscription to VFL Inference Subscription resource.
Table 6.2.3.3.3.3-3: Data structures supported by the PATCH Response Body on this resource
Data type
P
Cardinality
Response codes
Description
VflInferSub
M
1
200 OK
The Individual VFL Inference Subscription resource was partial modified successfully and a representation of that resource is returned.
n/a
204 No Content
The Individual VFL Inference Subscription resource was partial modified successfully.
RedirectResponse
O
0..1
307 Temporary Redirect
Temporary redirection.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(NOTE 2)
NOTE 1: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.
NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]).
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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Contains the 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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Contains the identifier of the target NF (service) instance towards which the request is redirected
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.3.3.4 DELETE
|
This method shall support the URI query parameters specified in table 6.2.3.3.3.4-1.
Table 6.2.3.3.3.4-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 6.2.3.3.3.4-2 and the response data structures and response codes specified in table 6.2.3.3.3.4-3.
Table 6.2.3.3.3.4-2: Data structures supported by the DELETE Request Body on this resource
Data type
P
Cardinality
Description
Table 6.2.3.3.3.4-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 VFL Subscription resource matching the subscriptionId was deleted.
RedirectResponse
O
0..1
307 Temporary Redirect
Temporary redirection.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(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: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]).
Table 6.2.3.3.3.4-4: Headers supported by the 307 Response Code on this resource
Name
Data type
P
Cardinality
Description
Location
string
M
1
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Contains the identifier of the target NF (service) instance towards which the request is redirected.
Table 6.2.3.3.3.4-5: Headers supported by the 308 Response Code on this resource
Name
Data type
P
Cardinality
Description
Location
string
M
1
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Contains the identifier of the target NF (service) instance towards which the request is redirected.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.3.3.4 Resource Custom Operations
|
None in this release of the specification.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.4 Custom Operations without associated resources
|
None in this release of the specification.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.5 Notifications
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.5.1 General
|
Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5].
Table 6.2.5.1-1: Notifications overview
Notification
Callback URI
HTTP method or custom operation
Description (service operation)
Event Notification
{notifUri}
POST
Report one or several observed Events.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.5.2 VFL Inference Event Notification
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.5.2.1 Description
|
The VFL Inference Event Notification is used by the AF to report one or several observed VFL Inference Events to a NF service consumer that has subscribed to such Notifications via the Individual VFL Inference Subscription Resource.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.5.2.2 Operation Definition
|
Callback URI: {notifUri}
The operation shall support the callback URI variables defined in table 6.2.5.2.2-1, the request data structures specified in table 6.2.5.2.2-2 and the response data structure and response codes specified in table 6.2.5.2.2-3.
Table 6.2.5.2.2-1: Callback URI variables
Name
Data type
Definition
notifUri
Uri
The Notification Uri as assigned within the Individual VFL Inference Subscription.
Table 6.2.5.2.2-2: Data structures supported by the POST Request Body on this resource
Data type
P
Cardinality
Description
VflInferNotif
M
1
Provides Information about observed events.
Table 6.2.5.2.2-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.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(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: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]).
Table 6.2.5.2.2-4: Headers supported by the 307 Response Code on this resource
Name
Data type
P
Cardinality
Description
Location
string
M
1
Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Contains the identifier of the target NF (service) instance towards which the notification request is redirected.
Table 6.2.5.2.2-5: Headers supported by the 308 Response Code on this resource
Name
Data type
P
Cardinality
Description
Location
string
M
1
Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Contains the identifier of the target NF (service) instance towards which the notification request is redirected
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.6 Data Model
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
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 Naf_VFLInference service-based interface protocol.
Table 6.2.6.1-1: Naf_VFLInference specific Data Types
Data type
Section defined
Description
Applicability
VflInferSub
6.2.6.2.2
Represents a VFL inference subscription.
VflInferSubPatch
6.2.6.2.3
Represents parameters to request the modification of a VFL inference subscription.
Table 6.2.6.1-2 specifies data types re-used by the Naf_VFLInference 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 Naf_VFLInference service-based interface.
Table 6.2.6.1-2: Naf_VFL re-used Data Types
Data type
Reference
Comments
Applicability
ReportingInformation
3GPP TS 29.523 [17]
Represents the type of reporting a subscription requires.
RedirectResponse
3GPP TS 29.571 [16]
Contains redirection related information.
SupportedFeatures
3GPP TS 29.571 [16]
Represents the list of supported features.
Uri
3GPP TS 29.571 [16]
Represents a URI.
VflInferAnaSub
3GPP TS 29.520 [18]
Represents the VFL inference subscription information for the subscribed analytics ID.
VflInferNotif
3GPP TS 29.520 [18]
Represents notification of a VFL inference subscription.
VflInferReq
3GPP TS 29.520 [18]
Represents requirements for VFL inference.
VflInferResult
3GPP TS 29.520 [18]
Represents intermediate VFL inference result per target.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.6.2 Structured data types
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.6.2.1 Introduction
|
This clause defines the structures to be used in resource representations.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.6.2.2 Type VflInferSub
|
Table 6.2.6.2.2-1: Definition of type VflInferSub
Attribute name
Data type
P
Cardinality
Description
Applicability
notifCorrId
string
M
1
The value of Notification Correlation ID in the corresponding notification.
notifUri
Uri
M
1
URI at which the NF service consumer requests to receive notifications.
reportingReqs
ReportingInformation
O
0..1
Reporting requirement information of the VFL inference subscription.
suppFeats
SupportedFeatures
C
0..1
List of Supported features used as described in clause 6.2.8.
It shall be supplied by NF service consumer in the POST requests that request the creation of a VFL Subscriptions resource and shall be supplied by the AF in the reply of corresponding request.
vflInferAnaSubs
array(VflInferAnaSub)
M
1..N
Contains the VFL inference subscription information for the subscribed analytics ID(s).
(NOTE)
vflInferReq
VflInferReq
O
0..1
Represents required conditions to apply VFL inference.
vflInferResults
array(VflInferResult)
O
1..N
Represents intermediate VFL inference results.
(NOTE)
NOTE: The "intGroupIds" and "supis" attributes of the data type are not applicable for the AF services if the AF is an untrusted AF. The "exterGroupIds" and "gpsis" attributes of the data type are not applicable for the AF services if the AF is a trusted AF.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.6.2.3 Type VflInferSubPatch
|
Table 6.2.6.2.3-1: Definition of type VflInferSubPatch
Attribute name
Data type
P
Cardinality
Description
Applicability
notifUri
Uri
O
0..1
URI at which the NF service consumer requests to receive notifications.
notifCorrId
string
O
0..1
The value of Notification Correlation ID in the corresponding notification.
reportingReqs
ReportingInformation
O
0..1
Reporting requirements of the VFL inference subscription.
vflInferAnaSubs
array(VflInferAnaSub)
O
1..N
Contains the VFL inference subscription information for the subscribed analytics ID(s).
(NOTE)
vflInferReq
VflInferReq
O
0..1
Represents required conditions to apply VFL inference.
NOTE: The "intGroupIds" and "supis" attributes of the data type are not applicable for the AF services if the AF is an untrusted AF. The "exterGroupIds" and "gpsis" attributes of the data type are not applicable for the AF services if the AF is a trusted AF.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.6.3 Simple data types and enumerations
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
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.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.6.3.2 Simple data types
|
The simple data types defined in table 5.1.6.3.2-1 shall be supported.
Table 6.2.6.3.2-1: Simple data types
Type Name
Type Definition
Description
Applicability
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.7 Error handling
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.7.1 General
|
For the Naf_VFLInference 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 Naf_VFLInference API.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.7.2 Protocol Errors
|
No specific procedures for the Naf_VFLInference service are specified.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.7.3 Application Errors
|
The application errors defined for the Naf_VFLInference API are listed in table 6.2.7.3-1.
Table 6.2.7.3-1: Application errors
Application Error
HTTP status code
Description
OVERLOAD
403 Forbidden
Indicates the AF is overloaded.
NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.8 Feature negotiation
|
The optional features in table 6.2.8-1 are defined for the Naf_VFLInference 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
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.9 Security
|
As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Naf_VFLInference 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 Naf_VFLInference 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 Naf_VFLInference service.
The Naf_VFLInference API defines a single scope "naf-vflinference" for the entire service, and it does not define any additional scopes at resource or operation level.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.2.10 HTTP redirection
|
An HTTP request may be redirected to a different AF service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]).
An SCP that reselects a different AF producer instance will return the NF Instance ID of the new AF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4].
If an AF redirects a service request to a different AF using an HTTP 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the HTTP 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4].
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3 Naf_Training Service API
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.1 Introduction
|
The Naf_Training shall use the Naf_Training API.
The API URI of the Naf_Training 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 "naf-train".
- The <apiVersion> shall be "v1".
- The <apiSpecificResourceUriPart> shall be set as described in clauses 6.3.3 and 6.3.4.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.2 Usage of HTTP
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.2.1 General
|
HTTP/2, IETF RFC 9113 [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 Naf_Training API is contained in Annex A.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.2.2 HTTP standard headers
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.2.2.1 General
|
See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.2.2.2 Content type
|
If the AF is untrusted, support of HTTP/1.1 (IETF RFC 9112 [19], IETF RFC 9110 [20] and IETF RFC 9111[21] over TLS is mandatory and support of HTTP/2 (IETF RFC 9113 [11]) over TLS is recommended. TLS shall be used as specified in clause 12.3 and clause 13.1 of 3GPP TS 33.501 [8].
If the AF is trusted, HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5.2 of 3GPP TS 29.500 [4].
HTTP/2, IETF RFC 9113 [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 Naf_Training API is contained in Annex A.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.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.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3 Resources
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.1 Overview
|
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 6.3.3.1-1 depicts the resource URIs structure for the Naf_Training API.
Figure 6.3.3.1-1: Resource URI structure of the Naf_Training API
Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 6.3.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)
Training Subscriptions
/subscriptions
POST
Create a new Training Subscription.
Individual Training Subscription
/subscriptions/{subscriptionId}
GET
Retrieve an existing "Individual Training Subscription" resource.
PUT
Request the update of an existing "Individual Training Subscription" resource.
PATCH
Request the modification of an existing "Individual Training Subscription" resource.
DELETE
Request the deletion of an existing "Individual Training Subscription" resource.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.2 Resource: Training Subscriptions
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.2.1 Description
|
This resource represents the collection of Training Subscription(s) managed by the AF.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.2.2 Resource Definition
|
Resource URI: {apiRoot}/naf-train/<apiVersion>/subscriptions
This resource shall support the resource URI variables defined in table 6.3.3.2.2-1.
Table 6.3.3.2.2-1: Resource URI variables for this resource
Name
Data type
Definition
apiRoot
string
See clause 6.3.1.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.2.3 Resource Standard Methods
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.2.3.1 POST
|
6.3The HTTP POST method allows a service consumer to request the creation of a Training Subscription at the AF.
This method shall support the URI query parameters specified in table 6.3.3.2.3.1-1.
Table 6.3.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.3.3.2.3.1-2 and the response data structures and response codes specified in table 6.3.3.2.3.1-3.
Table 6.3.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
Data type
P
Cardinality
Description
TrainEventsSubsc
M
1
Represents the parameters to request the creation of a Training Subscription.
Table 6.3.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
Data type
P
Cardinality
Response
codes
Description
TrainEventsSubsc
M
1
201 Created
Successful case. The Training Subscription is successfully created and a representation of the created "Individual Training Subscription " resource shall be returned.
An HTTP "Location" header that contains the URI of the created resource shall also be included.
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 [4] shall also apply.
Table 6.3.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}/naf-train/<apiVersion>/subscriptions/{subscriptionId}
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.2.4 Resource Custom Operations
|
There are no resource custom operations defined for this resource in this release of the specification.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.3 Resource: Individual Training Subscription
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.3.1 Description
|
This resource represents a Training Subscription managed by the AF.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.3.2 Resource Definition
|
Resource URI: {apiRoot}/naf-train/<apiVersion>/subscriptions/{subscriptionId}
This resource shall support the resource URI variables defined in table 6.3.3.3.2-1.
Table 6.3.3.3.2-1: Resource URI variables for this resource
Name
Data type
Definition
apiRoot
string
See clause 6.3.1.
subscriptionId
string
Represents the unique identifier of the "Individual Training Subscription" resource.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.3.3 Resource Standard Methods
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.3.3.1 GET
|
The GET method allows an NF service consumer to retrieve an existing "Individual Training Subscription" resource managed by the AF.
This method shall support the URI query parameters specified in table 6.3.3.3.3.1-1.
Table 6.3.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.3.3.3.3.1-2 and the response data structures and response codes specified in table 6.3.3.3.3.1-3.
Table 6.3.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.3.3.3.3.1-3: Data structures supported by the GET Response Body on this resource
Data type
P
Cardinality
Response
codes
Description
TrainEventsSubsc
M
1
200 OK
Successful case. The requested "Individual Training Subscription" resource is returned.
RedirectResponse
O
0..1
307 Temporary Redirect
Temporary redirection.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(NOTE 2)
NOTE 1: 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] shall also apply.
NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.30.9.1 of 3GPP TS 29.500 [4]).
Table 6.3.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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.30.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
Table 6.3.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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.30.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.3.3.2 PUT
|
The PUT method allows an NF service consumer to request the update of an existing "Individual Training Subscription" resource managed by the AF.
This method shall support the URI query parameters specified in table 6.3.3.3.3.2-1.
Table 6.3.3.3.3.2-1: URI query parameters supported by the PUT 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.3.3.3.3.2-2 and the response data structures and response codes specified in table 6.3.3.3.3.2-3.
Table 6.3.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource
Data type
P
Cardinality
Description
TrainEventsSubsc
M
1
Contains the updated representation of the "Individual Training Subscription" resource.
Table 6.3.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource
Data type
P
Cardinality
Response
codes
Description
TrainEventsSubsc
M
1
200 OK
Successful case. The "Individual Training Subscription" resource is successfully updated and a representation of the updated resource is returned in the response body.
n/a
204 No Content
Successful case. The "Individual Training Subscription" resource is successfully updated and no content is returned in the response body.
RedirectResponse
O
0..1
307 Temporary Redirect
Temporary redirection.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(NOTE 2)
NOTE 1: The mandatory HTTP error status codes for the HTTP PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply.
NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.30.9.1 of 3GPP TS 29.500 [4]).
Table 6.3.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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
Table 6.3.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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.3.3.3 PATCH
|
The PATCH method allows an NF service consumer to request the modification of an existing "Individual Training Subscription" resource managed by the AF.
This method shall support the URI query parameters specified in table 6.3.3.3.3.3-1.
Table 6.3.3.3.3.3-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.3.3.3.3.3-2 and the response data structures and response codes specified in table 6.3.3.3.3.3-3.
Table 6.3.3.3.3.3-2: Data structures supported by the PATCH Request Body on this resource
Data type
P
Cardinality
Description
TrainEventsSubscPatch
M
1
Contains the parameters to request the modification of the "Individual Training Subscription" resource.
Table 6.3.3.3.3.3-3: Data structures supported by the PATCH Response Body on this resource
Data type
P
Cardinality
Response
codes
Description
TrainEventsSubsc
M
1
200 OK
Successful case. The "Individual Training Subscription" 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 Training Subscription" resource is successfully modified and no content is returned in the response body.
RedirectResponse
O
0..1
307 Temporary Redirect
Temporary redirection.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(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] shall also apply.
NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]).
Table 6.3.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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
Table 6.3.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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.3.3.3.4 DELETE
|
The DELETE method allows an NF service consumer to request the deletion of an existing "Individual Training Subscription" resource managed by the AF.
This method shall support the URI query parameters specified in table 6.3.3.3.3.4-1.
Table 6.3.3.3.3.4-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.3.3.3.3.4-2 and the response data structures and response codes specified in table 6.3.3.3.3.4-3.
Table 6.3.3.3.3.4-2: Data structures supported by the DELETE Request Body on this resource
Data type
P
Cardinality
Description
n/a
Table 6.3.3.3.3.4-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 Training Subscription" resource is successfully deleted.
RedirectResponse
O
0..1
307 Temporary Redirect
Temporary redirection.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(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] shall also apply.
NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]).
Table 6.3.3.3.3.4-4: Headers supported by the 307 Response Code on this resource
Name
Data type
P
Cardinality
Description
Location
string
M
1
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
Table 6.3.3.3.3.4-5: Headers supported by the 308 Response Code on this resource
Name
Data type
P
Cardinality
Description
Location
string
M
1
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.4 Custom Operations without associated resources
|
There are no custom operations without associated resources defined for this API in this release of the specification.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.5 Notifications
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.5.1 General
|
Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5].
Table 6.3.5.1-1: Notifications overview
Notification
Callback URI
HTTP method or custom operation
Description
(service operation)
Training Notification
{notifUri}
POST
Enables the AF to notify a previously subscribed NF service consumer on Training report(s).
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.5.2 Training Notification
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.5.2.1 Description
|
The Training Notification is used by the AF to notify a previously subscribed NF service consumer on Training report(s).
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.5.2.2 Target URI
|
The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 6.3.5.2.2-1.
Table 6.3.5.2.2-1: Callback URI variables
Name
Definition
notifUri
Represents the callback URI encoded as a string formatted as a URI.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.5.2.3 Standard Methods
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.5.2.3.1 POST
|
This method shall support the request data structures specified in table 6.3.5.2.3.1-1 and the response data structures and response codes specified in table 6.3.5.2.3.1-2.
Table 6.3.5.2.3.1-1: Data structures supported by the POST Request Body
Data type
P
Cardinality
Description
TrainEventsNotif
M
1
Represents the Training Notification.
Table 6.3.5.2.3.1-2: Data structures supported by the POST Response Body
Data type
P
Cardinality
Response codes
Description
n/a
204 No Content
Successful case. The Training Notification is successfully received.
RedirectResponse
O
0..1
307 Temporary Redirect
Temporary redirection.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(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: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]).
Table 6.3.5.2.3.1-3: Headers supported by the 307 Response Code on this resource
Name
Data type
P
Cardinality
Description
Location
string
M
1
Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target NF service consumer (service) instance towards which the notification request is redirected.
Table 6.3.5.2.3.1-4: Headers supported by the 308 Response Code on this resource
Name
Data type
P
Cardinality
Description
Location
string
M
1
Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target NF service consumer (service) instance towards which the notification request is redirected.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6 Data Model
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6.1 General
|
This clause specifies the application data model supported by the API.
Table 6.3.6.1-1 specifies the data types defined for the Naf_Training service-based interface protocol.
Table 6.3.6.1-1: Naf_Training API specific Data Types
Data type
Clause defined
Description
Applicability
EventNotif
6.3.6.2.7
Represents notification on event training.
EventSubsc
6.3.6.2.4
Represents an event training subscription.
MlModelMonitorInfo
6.3.6.2.5
Represents the ML model monitoring information.
TrainEventsNotif
6.3.6.2.6
Represents notification on training event(s) that occurred.
TrainEventsSubsc
6.3.6.2.2
Represents event(s) training subscription.
TrainEventsSubscPatch
6.3.6.2.3
Represents the requested modifications to an event training subscription.
Table 6.1.6.1-2 specifies data types re-used by the Naf_Training 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 Naf_Training service-based interface.
Table 6.3.6.1-2: Naf_Training API re-used Data Types
Data type
Reference
Comments
Applicability
Accuracy
3GPP TS 29.520 [18]
Represents accuracy levels of interest for ML models.
DateTime
3GPP TS 29.571 [16]
Identifies the time.
EventFilter
3GPP TS 29.520 [18]
Represents the event filters used to identify the subscribed analytics.
InferenceDataForModelTrain
3GPP TS 29.520 [18]
Represents the inference data for model training.
InputDataInfo
3GPP TS 29.520 [18]
Represents the metrics of the input data.
MLModelMetric
3GPP TS 29.520 [18]
Represents the ML Model Metric.
NetworkAreaInfo
3GPP TS 29.554 [23]
Identifies the network area.
NwdafEvent
3GPP TS 29.520 [18]
Represents the NWDAF event.
ReportingInformation
3GPP TS 29.523 [17]
Represents the event reporting requirements.
SupportedFeatures
3GPP TS 29.571 [16]
Represents the list of supported feature(s) and used to negotiate the applicability of the optional features.
TargetUeInformation
3GPP TS 29.520 [18]
Identifies the target UE information.
TimeWindow
3GPP TS 29.122 [22]
Represents a time window.
Uinteger
3GPP TS 29.571 [16]
Represents an unsigned integer.
Uri
3GPP TS 29.571 [16]
Represents a URI.
VflTermCause
3GPP TS 29.520 [18]
Identifies the VFL termination cause.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6.2 Structured data types
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6.2.1 Introduction
|
This clause defines the structures to be used in resource representations.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6.2.2 Type: TrainEventsSubsc
|
Table 6.3.6.2.2-1: Definition of type TrainEventsSubsc
Attribute name
Data type
P
Cardinality
Description
Applicability
trainEventSubs
map(EventSubsc)
M
1..N
Contains the subscribed training events.
The key of the map shall be set to the value of the "event" attribute in the EventSubsc data structure.
notifUri
Uri
M
1
Contains the URI via which the training related notifications shall be delivered.
notifCorreId
string
M
1
The value of Notification Correlation ID in the corresponding notification.
reportingReqs
ReportingInformation
O
0..1
Contains reporting requirement information of the subscription.
If omitted, the default values within the ReportingInformation data type apply.
eventNotifs
array(EventNotif)
C
1..N
Contains the training related even(s) report(s).
This attribute may be present only if immediate reporting was requested via the "eventReq" attribute.
suppFeat
SupportedFeatures
C
0..1
Contains the list of supported features among the ones defined in clause 6.3.8.
This attribute shall be present only when feature negotiation is required.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6.2.3 Type: TrainEventsSubscPatch
|
Table 6.3.6.2.3-1: Definition of type TrainEventsSubscPatch
Attribute name
Data type
P
Cardinality
Description
Applicability
trainEventSubs
map(EventSubsc)
O
1..N
Contains the updated subscribed training events.
The key of the map shall be set to the value of the "event" attribute in the EventSubsc data structure.
notifUri
Uri
O
0..1
Contains the updated URI via which the training related notifications shall be delivered.
notifCorreId
string
O
0..1
The value of Notification Correlation ID in the corresponding notification.
reportingReqs
ReportingInformation
O
0..1
Contains the reporting requirement information of the subscription.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6.2.4 Type: EventSubsc
|
Table 6.3.6.2.4-1: Definition of type EventSubsc
Attribute name
Data type
P
Cardinality
Description
Applicability
event
NwdafEvent
M
1
Event that is subscribed.
useCaseCxt
string
O
0..1
Indicates the context of usage of the analytics.
The value and format of this parameter are not standardized.
trainFilter
EventFilter
O
0..1
Identifies the training filter information for the monitored event.
tgtUe
TargetUeInformation
O
0..1
Identifies target UE information
repRatio
Uinteger
O
0..1
Minimum percentage of UEs whose data is used for training an ML model when the target of ML model reporting is a group of UEs.
Minimum = 0. Maximum = 100.
targetPeriod
TimeWindow
O
0..1
Indicates the time interval for which the ML model for the analytics is requested.
inferInputData
InputDataInfo
O
0..1
Indicates the Inference Input Data information.
timeModelNeeded
DateTime
O
0..1
Indicating the latest time when the consumer expects to receive the ML Model(s).
modelMonInfo
MlModelMonitorInfo
O
0..1
Contains the ML Model Monitoring Information.
accuLevel
Accuracy
O
0..1
Contains the accuracy level of interest.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6.2.5 Type: MlModelMonitorInfo
|
Table 6.3.6.2.5-1: Definition of type MlModelMonitorInfo
Attribute name
Data type
P
Cardinality
Description
Applicability
modelMetric
MLModelMetric
O
0..1
Indicates the ML model metric.
accuThreshold
Uinteger
O
0..1
Accuracy reporting threshold. Indicates the accuracy threshold of the ML Model requested by the consumer
Minimum = 0. Maximum = 100.
storedData
InferenceDataForModelTrain
O
0..1
Indicates the inference data stored in the ADRF.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6.2.6 Type: TrainEventsNotif
|
Table 6.3.6.2.6-1: Definition of type TrainEventsNotif
Attribute name
Data type
P
Cardinality
Description
Applicability
notifCorreId
string
M
1
Contains the notification correlation identifier.
eventNotifs
array(EventNotif)
M
1..N
Contains the Training related event(s) notification(s).
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6.2.7 Type: EventNotif
|
Table 6.3.6.2.7-1: Definition of type EventNotif
Attribute name
Data type
P
Cardinality
Description
Applicability
event
NwdafEvent
M
1
Contains the identifier of the analytics to which the training notifications is related.
trainingInd
boolean
O
0..1
Set to "true" to indicate that the ML model training is ongoing.
Set to "false" to indicate that the ML model training is done.
Default value is "false" if omitted.
(NOTE)
validityPeriod
TimeWindow
O
0..1
Indicates the time period when the provided ML model applies.
(NOTE)
spatialValidity
NetworkAreaInfo
O
0..1
Indicates the area where the provided ML model applies.
(NOTE)
repRatio
Uinteger
O
0..1
Minimum percentage of UEs whose data is used for training an ML model when the target of ML model reporting is a group of UEs.
Minimum = 0. Maximum = 100.
(NOTE)
accMLModel
Uinteger
O
0..1
Indicates the accuracy value of the ML model.
Minimum = 0. Maximum = 100.
(NOTE)
termCause
VflTermCause
O
0..1
Contains the termination cause.
(NOTE)
NOTE: If the "termCause" attribute is present, this attribute shall not be present.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6.3 Simple data types and enumerations
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6.3.1 Introduction
|
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6.3.2 Simple data types
|
The simple data types defined in table 6.3.6.3.2-1 shall be supported.
Table 6.3.6.3.2-1: Simple data types
Type Name
Type Definition
Description
Applicability
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.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.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6.5 Binary data
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.6.5.1 Binary Data Types
|
Table 6.1.6.5.1-1: Binary Data Types
Name
Clause defined
Content type
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.7 Error Handling
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.7.1 General
|
For the Naf_Training 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 Naf_Training API.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.7.2 Protocol Errors
|
No specific procedures for the Naf_Training service are specified.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.7.3 Application Errors
|
The application errors defined for the Naf_Training service are listed in Table 6.1.7.3-1.
Table 6.3.7.3-1: Application errors
Application Error
HTTP status code
Description
Applicability
OVERLOAD
403 Forbidden
Indicates the AF is overloaded.
NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.8 Feature negotiation
|
The optional features in table 6.1.8-1 are defined for the Naf_Training API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4].
Table 6.3.8-1: Supported Features
Feature number
Feature Name
Description
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.9 Security
|
As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Naf_Training 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 Naf_Training API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in clause 5.4.2.2 of 3GPP TS 29.510 [10].
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 Naf_Training service.
The Naf_Training API defines a single scope "naf-train" for the entire service, and it does not define any additional scopes at resource or operation level.
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.3.10 HTTP redirection
|
An HTTP request may be redirected to a different AF service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]).
An SCP that reselects a different AF producer instance will return the NF Instance ID of the new AF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4].
If an AF redirects a service request to a different AF using an HTTP "307 Temporary Redirect" or "308 Permanent Redirect" status code, the identity of the new AF towards which the service request is redirected shall be indicated in the "3gpp-Sbi-Target-Nf-Id" header of the HTTP "307 Temporary Redirect" or "308 Permanent Redirect" response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4].
|
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.4 Naf_Inference Service API
| |
acdaeadefeb6c305deefa350bb6aac72
|
29.530
|
6.4.1 Introduction
|
The Naf_Inference service shall use the Naf_Inference API.
The API URI of the Naf_Inference 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 "naf-inference".
- The <apiVersion> shall be "v1".
- The <apiSpecificResourceUriPart> shall be set as described in clause 6.4.3.
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.