...
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
UUID | Y | 1 | UUID/String | UUID of NST | |
| invariantUUID | Y | 1 | UUID/String | Invariant UUID |
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 | 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 | Y | 1 | JSON blob | The header information a client expecting in a async callback. | |
sourceId | Y | 1 | String | The unique ID of a client making an optimization call. | |
| numSolutions | Y | 1 | Integer | Expected number of solutions. numSolution 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 NSI selection |
...
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. |
NSSISolution Object
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
| existingNSSI | Y | 1 | Boolean | True/False | Note: In case of Core and Transport, if no existing NSSI matches, this field will be "false", and no other info will be present. From this, NSSMF has to infer that a new NSSI has to be created, for which it shall invoke the appropriate procedures. |
sharedNSSIsolution | N | 1 | sharedNSSISolution Object | A list of matching NSSIs from existing NSSIs | |
| newNSSISolution | N | 1 | newNSSISolution Object | Details of the constituents of the new NSSIs that can be instantiated to meet the request. This shall be returned only in the case of RAN NSSI selection for deployment option 1. |
sharedNSSISolution Object
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
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
| SliceProfileList | Y | 1..N | JSON BLOB | 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. | |
| 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)
...
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. |
4.2. Request Body
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
| type | Y | 1 | Integer | 1=NSI 2=NSSI | |
| invariantUUID | Y | 1 | UUID/String | Invariant UUID | |
UUID | Y | 1 | UUID/String | UUID of NSI/NSSI | |
| NxIId | Y | 1 | String | Id of NSI/NSSI | |
| requestInfo | Y | 1 | requestInfo Object | The content of the requestInfo Object |
RequestInfo Object
Attribute | Required? | Cardinality | Content | 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 | N | 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 of a client making an optimization call. | |
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 |
4.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. |
| terminateResponse | Y | 1 | Boolean | 0 = Do not terminate 1= Terminate |
5. HTTP Response Code
HTTP Code | Response Phrase | Description |
|---|---|---|
201 | Created | An optimization solution is found. |
202 | Accepted | An optimization request is accepted. |
400 | Bad request | Bad request. |
401 | Unauthorized | Request body is not compliant with the API definition. |
404 | Not found | The server cannot find the requested URI. |
405 | Method not found | The requested method is not supported by a server. |
500 | Internal server error | The server encountered an internal server error or timed out. |
| 520 | Solver error | Requested number of solutions cannot be found. |
...