...
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
| invariantUUID | Y | 1 | UUID/String | Invariant UUID | |
UUID | Y | 1 | UUID/String | UUID of NST | |
| NSTName | Y | 1 | String | Name of NST | |
| matchLevel | Y | 1 | JSON BLOB | Details of match of requirements in service profile |
2. Select NSI API
Interface Definition | Description |
|---|---|
Content-Type | application/json |
Operation Type | POST |
URI | https://{host}:{port}/api/oof/v1/selection/nsi |
2.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. |
2.2. Request Body
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
| serviceProfile | Y | 1 | serviceProfile Object | The content of the serviceProfile Object | |
| NSTInfo | Y | 1 | nstInfo Object | The content of nstInfo Object | |
| NSSTInfoList | Y | 1..N | nsstInfo Object | All the constituent NSSTs of the NST | |
| subnetCapabilityList | Y | 1..N | subnetCapabilityObject | Subnet capabilities | |
| requestInfo | Y | 1 | requestInfo Object | The content of the requestInfo Object |
serviceProfile Object
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
serviceProfileParametersProfileParameters | Y | 1 | JSON BLOB | A JSON object containing service profile parameters (in case of NSI selection) or slice profile parameters (in case of NSSI selection). The contents are based on 3GPP TS 23.541 Release 16 contents, and will be in the form of attribute value pairs. |
subnetCapability Object
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
| domainType | Y | 1 | String | AN/TN-FH/TN-MH/TN-BH/CN | Sub-net type |
capabilityDetails | Y | 1 | JSON BLOB | A JSON object containing capability parameters |
nstInfo Object
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
UUID | Y | 1 | UUID/String | UUID of NST/NSST | |
| invariantUUID | Y | 1 | UUID/String | Invariant UUID |
...
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 |
2.3. Synchronous Response Body
...
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
sharedNSIsolutionList | N | 1..N | List of shareNSISolution Objects | A list of matching NSIs from existing NSIs | |
| newNSISolutionList | N | 1..N | List of newNSISolution Objects | Details of the constituents of the new NSIs that can be instantiated to meet the request |
...