...
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. |
solutions | Y | 1..N | List of Solution Object | Solutions related to a request. |
...
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
| existingNSI | Y | 1 | Boolean | True/False | |
sharedNSIsolutionsharedNSIsolutionList | N | 1..N | sharedNSISolution ObjectList of shareNSISolution Objects | A list of matching NSIs from existing NSIs | |
| newNSISolutionListnewNSISolution | N | 1..N | List of newNSISolution ObjectsObject | Details of the constituents of the new NSIs that can be instantiated to meet the request |
...
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
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 slice profile, and percentage of fit (future enhancement, based on telemetry, capacity, etc.) |
4. Deallocate NxI (x=S, SS)
Interface Definition | Description |
|---|---|
Content-Type | application/json |
Operation Type | POST |
URI | https://{host}:{port}/api/oof/v1/terminate/nxi |
4.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. |
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. |
...