7.7 Network slice capability Enablement APIs
29.5493GPPApplication Programming Interface (API) specificationRelease 18Service Enabler Architecture Layer for Verticals (SEAL)Stage 3TS
7.7.1 SS_NetworkSliceAdaptation API
7.7.1.1 API URI
The request URI used in each HTTP request from the VAL server towards the NSCE server shall have the structure as defined in clause 6.5 with the following clarifications:
– The <apiName> shall be "ss-nsa".
– The <apiVersion> shall be "v1".
– The <custOpName> shall be set as described in clause 7.7.1.3.
7.7.1.2 Resources
There are no resources defined for this API in this release of the specification.
7.7.1.3 Custom Operations without associated resources
7.7.1.3.1 Overview
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 7.7.1.3.1-1 depicts the resource URIs structure for the SS_NetworkSliceAdaptation API.
Figure 7.7.1.3.1-1: Custom operation URI structure of the SS_NetworkSliceAdaptation API
Table 7.7.1.3.1-1 provides an overview of the custom operation and applicable HTTP methods.
Table 7.7.1.3.1-1: Custom operations without associated resources
|
Operation name |
Custom operation URI |
Mapped HTTP method |
Description |
|
Request |
/request |
POST |
Request the network slice adaptation. |
7.7.1.3.2 Operation: Request
7.7.1.3.2.1 Description
The custom operation allows a VAL server to request network slice adaptation to the NSCE server.
7.7.1.3.2.2 Operation Definition
This operation shall support the request and response data structures and response code specified in table 7.7.1.3.2.2-1 and table 7.7.1.3.2.2-2.
Table 7.7.1.3.2.2-1: Data structures supported by the POST Request Body for this operation
|
Data type |
P |
Cardinality |
Description |
|
NwSliceAdptInfo |
M |
1 |
Parameters to request network slice adaptation. |
Table 7.7.1.3.2.2-2: Data structures supported by the POST Response Body for this operation
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
The success of the network slice adaptation with the underlying network. |
||
|
n/a |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative URI representing an alternative NSCE server to which the request should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. |
||
|
n/a |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative URI representing an alternative NSCE server to which the request should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. |
||
|
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] also apply. |
||||
Table 7.7.1.3.2.2-3: Headers supported by 307 Response Code for this operation
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI representing an alternative NSCE server to which the request should be redirected. |
Table 7.7.1.3.2.2-4: Headers supported by 308 Response Code for this operation
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI representing an alternative NSCE server to which the request should be redirected. |
7.7.1.4 Notifications
None.
7.7.1.5 Data Model
7.7.1.5.1 General
This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API.
Table 7.7.1.5.1-1 specifies the data types defined specifically for the SS_NetworkSliceAdaptation API service.
Table 7.7.1.5.1-1: SS_NetworkSliceAdaptation API specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
|
NwSliceAdptInfo |
7.7.1.5.2.3 |
Represents the information associated with requested network slice adaptation with the underlying network. |
Table 7.7.6.1.4.1-2 specifies data types re-used by the NetworkSliceAdaptation API service.
Table 7.7.1.5.1-2: Re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
Dnn |
3GPP TS 29.571 [21] |
Used to Identify a DNN. |
|
|
Snssai |
3GPP TS 29.571 [21] |
Used to Identify the S-NSSAI. |
|
|
SupportedFeatures |
3GPP TS 29.571 [21] |
Used to negotiate the applicability of the optional features. |
|
|
NOTE: Properties marked with a feature as defined in clause 5.14.6 are applicable as described in clause 5.2.7 of 3GPP TS 29.122 [4]. If no feature is indicated, the related property applies for all the features. |
|||
7.7.1.5.2 Structured Data Types
7.7.1.5.2.1 Introduction
7.7.1.5.2.2 Type: NwSliceAdptInfo
Table 7.7.1.5.2.2-1: Definition of type NwSliceAdptInfo
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
valServiceId |
string |
M |
1 |
The VAL service ID of the VAL application for which the network slice adaptation may corresponds to. |
|
|
valTgtUeIds |
array(string) |
M |
1..N |
List of the VAL UE IDs within the VAL service for which the slice adaptation request corresponds. |
|
|
snssai |
Snssai |
O |
0..1 |
Indication of the new S-NSSAI which is requested. |
|
|
dnn |
Dnn |
O |
0..1 |
Indication of the new DNN which is requested. |
|
|
suppFeat |
SupportedFeatures |
O |
0..1 |
This parameter shall be supplied by VAL server in the POST request that requests the network slice adaptation and shall be supplied in the reply of corresponding request. |
|
|
NOTE: Properties marked with a feature as defined in clause 7.7.1.7 are applicable as described in clause 5.2.7 of 3GPP TS 29.122 [3]. If no feature is indicated, the related property applies for all the features. |
|||||
7.7.1.5.3 Simple data types and enumerations
None.
7.7.1.6 Error Handling
7.7.1.6.1 General
HTTP error handling shall be supported as specified in clause 6.7.
In addition, the requirements in the following clauses shall apply.
7.7.1.6.2 Protocol Errors
In this Release of the specification, there are no additional protocol errors applicable for the SS_NetworkSliceAdaptation API.
7.7.1.6.3 Application Errors
The application errors defined for SS_NetworkSliceAdaptation API are listed in table 7.7.1.6.3-1.
Table 7.7.1.6.3-1: Application errors
|
Application Error |
HTTP status code |
Description |
Applicability |
7.7.1.7 Feature Negotiation
General feature negotiation procedures are defined in clause 6.8.
Table 7.7.1.7-1: Supported Features
|
Feature number |
Feature Name |
Description |