...
| Interface Definition | Description |
|---|---|
Content-Type | application/json |
Operation Type | POST |
URI | https://{host}:{port}/api/oof/v1/selectnst |
1.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. |
1.2. Request Body
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
| serviceProfile | Y | 1 | serviceProfile Object | The content of the serviceProfile Object | |
| requestInfo | Y | 1 | requestInfo Object | The content of the requestInfo Object |
serviceProfile Object
Attribute | Required? | Cardinality | Content | Values | Description |
|---|
serviceProfileParameters | 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.
sourceId
Y
1
String
The unique ID of a client making an optimization call.
requestType
Y
1
String
create, update, delete
The type of a request
numSolutions
N
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.
optimizers
Y
1..N
List of Strings
placement
A list of optimization services.
timeout
N
1
Integer
JSON BLOB | A JSON object conaining service profile parameters. The contents are based on 3GPP TS 23.541 Release 16 contents. |
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 | 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 |
requestType
Y
1
String
create, update, delete
The type of a request
numSolutions
N
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.
optimizers
Y
1..N
List of Strings
placement
. | |||||
timeout | N | 1 | Integer | A tolerance window (in secs) for expecting solutions. Default is 600 secs. |