...
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
| SliceProfiles | Y | 1..N | List of SliceProfile objects | A List of JSON object objects containing slice profile parameters. The contents are based on 3GPP TS 23.541 Release 16 contents, and will be in the form of attribute value pairs. Assumption: Slice profile contains sub-net type. If not, this should also be included. | |
| matchLevel | Y | 1 | JSON BLOB | Details of match of requirements in service profile, and recommendation rank (future enhancement, based on telemetry, capacity, etc.) |
SliceProfile Object
...
Attribute
...
Required?
...
Cardinality
...
Content
...
Values
...
Description
...
A JSON object containing slice profile parameters. The contents are based on 3GPP TS 23.541 Release 16 contents, and will be in the form of attribute value pairs.
Assumption: Slice profile contains sub-net type. If not, this should also be included.
3. Select NSSI API
...
Interface Definition
...
Description
...
Content-Type
...
application/json
...
Operation Type
...
POST
...
URI
...
https://{host}:{port}/api/oof/v1/selection/nssi
3.1. Request Header
...
Header
...
Required
...
Description
...
Accept
...
N
...
Determines the format of the body of the response. Valid value is “application/json”
...
Authorization
...
Y
...
Supplies Basic Authentication credentials for the request. If the Authorization header is missing, then an HTTP 400 Invalid Request response is returned. If the string supplied is invalid, then an HTTP 401 Unauthorized response is returned.
...
Content-Length
...
N
...
Number of bytes in the body of the request. Note that content length is limited to 1 MB.
...
Content-Type
...
Y
...
Determines the format of the request content. Only application/json is supported.
3.2. Request Body
...
Attribute
...
Required?
...
Cardinality
...
Content
...
Values
...
Description
...
nsstInfo Object
...
Attribute
...
Required?
...
Cardinality
...
Content
...
Values
...
Description
...
UUID
...
Y
...
1
...
UUID/String
...
UUID of NSST
...
3. Select NSSI API
Interface Definition | Description |
|---|---|
Content-Type | application/json |
Operation Type | POST |
URI | https://{host}:{port}/api/oof/v1/selection/nssi |
3.1. Request Header
Header | Required | Description |
|---|---|---|
Accept | N | Determines the format of the body of the response. Valid value is “application/json” |
Authorization | Y | Supplies Basic Authentication credentials for the request. If the Authorization header is missing, then an HTTP 400 Invalid Request response is returned. If the string supplied is invalid, then an HTTP 401 Unauthorized response is returned. |
Content-Length | N | Number of bytes in the body of the request. Note that content length is limited to 1 MB. |
Content-Type | Y | Determines the format of the request content. Only application/json is supported. |
3.2. Request Body
Attribute | Required? | Cardinality | Content | Values | Description |
|---|
| sliceProfile | Y | 1 |
UUID/String
A unique ID to track an ONAP transaction.
requestId
Y
1
UUID/String
A unique ID to track multiple requests associated with a transaction.
callbackUrl
Y
1
URL
The end point of a callback service where recommendations are posted.
| JSON Blob | A JSON object containing slice profile parameters. The contents are based on 3GPP TS 23.541 Release 16 contents, and will be in the form of attribute value pairs. | ||||
| NSSTInfo | Y | 1 | nsstInfo Object | The content of nsstInfo Object | |
| requestInfo | Y | 1 |
| requestInfo Object | The |
timeout
N
1
Integer
A tolerance window (in secs) for expecting solutions. Default is 600 secs.
...
| content of the requestInfo Object |
nsstInfo Object
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
UUID | Y | 1 | UUID/String | UUID of NSST | |
| invariantUUID | Y | 1 | UUID/String | Invariant UUID |
RequestInfo Object
Attribute | Required? | Cardinality | Content |
|---|
Values
Values | Description | ||||
|---|---|---|---|---|---|
transactionId | Y | 1 | UUID/String | A unique ID to track an ONAP transaction. | |
requestId | Y | 1 | UUID/String | A unique |
ID to track multiple requests associated with a transaction. | |||||
callbackUrl | Y | 1 | URL | The end point of a callback service where recommendations are posted. | |
| callbackHeader | N | 1 | JSON blob | The header information a client expecting in a async callback. | |
sourceId | Y | 1 |
String |
The unique ID |
statusMessage
of a client making an optimization call. | ||
| numSolutions | Y | 1 |
String
Reasoning if a requestStatus is failed.
requestStatus
Y
1
String
accepted, failed
The status of a request.
3.4. Asynchronous Response Header
...
Header Name
...
Required?
...
Description
...
Accept
...
N
...
Determines the format of the body of the response. Valid value is “application/json”
...
Authorization
...
Y
...
Supplies Basic Authentication credentials for the request. If the Authorization header is missing, then an HTTP 400 Invalid Request response is returned. If the string supplied is invalid, then an HTTP 401 Unauthorized response is returned.
...
Content-Type
...
Y
...
Determines the format of the request content. Only application/json is supported.
...
Content-Length
...
N
...
Number of bytes in the body of the request. Note that content length is limited to 1 MB.
3.5. Asynchronous Response Body
...
Attribute
...
Required?
...
Cardinality
...
Content
...
Values
...
Description
...
requestId
...
Y
...
1
...
UUID/String
...
A unique Id for an ONAP transaction.
...
transactionId
...
Y
...
1
...
UUID/String
...
A unique ID to track multiple requests associated with a transaction.
...
statusMessage
...
N
...
1
...
String
...
Reasoning if requestStatus is failed.
...
requestStatus
...
Y
...
1
...
String
...
completed, failed, pending
...
The status of a request.
...
NSSIsolutions
...
Y
...
1..N
...
List of NSSISolution Objects
...
Solutions related to a request.
...
| Integer | Expected number of solutions. numSolutions can also be specified using an optimization query policies, where the default configured value is 1. The value from a request gets higher precedence over the value defined in a policy. | ||||
timeout | N | 1 | Integer | A tolerance window (in secs) for expecting solutions. Default is 600 secs. | |
| addtnlArgs | N | 1 | JSON BLOB | Any additional parameters that have to be considered for NSSI selection |
3.3. Synchronous Response Body
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
requestId | Y | 1 | UUID/String | A unique Id for an ONAP transaction. | |
transactionId | Y | 1 | UUID/String | A unique ID to track multiple requests associated with a transaction. | |
statusMessage | N | 1 | String | Reasoning if a requestStatus is failed. | |
requestStatus | Y | 1 | String | accepted, failed | The status of a request. |
3.4. Asynchronous Response Header
Header Name | Required? | Description |
|---|---|---|
Accept | N | Determines the format of the body of the response. Valid value is “application/json” |
Authorization | Y | Supplies Basic Authentication credentials for the request. If the Authorization header is missing, then an HTTP 400 Invalid Request response is returned. If the string supplied is invalid, then an HTTP 401 Unauthorized response is returned. |
Content-Type | Y | Determines the format of the request content. Only application/json is supported. |
| Attribute | N | Attribute and respective value that a client has sent in the callbackHeader field of a request. |
Content-Length | N | Number of bytes in the body of the request. Note that content length is limited to 1 MB. |
3.5. Asynchronous Response Body
Attribute | Required? | Cardinality | Content | Values | Description |
|---|
requestId | Y | 1 |
UUID/ |
String | A unique Id for an ONAP transaction. | ||||
transactionId | Y | 1 | UUID/String | A unique ID to track multiple requests associated with a transaction. | |
statusMessage | N | 1 |
sharedNSSISolution Object
A list of matching NSSIs from existing NSSIs
String | Reasoning if requestStatus is failed. | ||||
requestStatus | Y | 1 | String | completed, failed, pending | The status of a request. |
solutions | Y | 0..N | List of sharedNSSISolution Objects | Solutions related to a request. |
sharedNSSISolution Object
Attribute
Required?
Cardinality
Content
Values
Description
Attribute | Required? | Cardinality | Content | Values | Description | ||||
|---|---|---|---|---|---|---|---|---|---|
| invariantUUID | Y | 1 | UUID/String | Invariant UUID | |||||
UUID | Y | 1 | UUID/String | UUID of NSSI | |||||
| NSSIName | Y | 1 | String | Name of NSSI | |||||
| NSSIId | Y | 1 | String | Id of NSSI | matchLevel | Y | 1 | JSON BLOB | Details of match of requirements in service profile, and recommendation rank (future enhancement, based on telemetry, capacity, etc.) |
newNSSISolution Object
| Y | 1 |
A JSON object containing slice profile parameters of the constituents. The contents are based on 3GPP TS 23.541 Release 16 contents, and will be in the form of attribute value pairs.
Assumption: Slice profile contains sub-net type. If not, this should also be included.| String | Id of NSSI | ||||
| matchLevel | Y | 1 | JSON BLOB | Details of match of requirements in service profile, and recommendation rank (future enhancement, based on telemetry, capacity, etc.) |
4. Terminate NxI (x=S, SS)
Interface Definition | Description |
|---|---|
Content-Type | application/json |
Operation Type | POST |
URI | https://{host}:{port}/api/oof/v1/terminate/nxi |
...