1. Inter domain route API
| Interface Definition | Description |
|---|---|
Content-Type | application/json |
Operation Type | POST |
URI | https://{host}:{port}/api/oof/mdons/route/v1 |
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 |
|---|---|---|---|---|---|
| routeInfo | Y | 1 | Route Info Object | The content of the Route Info Object | |
| requestInfo | Y | 1 | requestInfo Object | The content of the requestInfo Object |
Route Info Object
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
routeRequest | Y | 1 | Route Request Object | The content of the Route request object |
Route Request Object
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
srcDetails | Y | 1 | node Object | Src node details | |
| dstDetails | Y | 1 | node Object | Dst node details | |
| serviceRate | Y | 1 | String | Service rate |
Node object
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
interfaceId | Y | 1 | String | Interface identifier | |
| nodeId | Y | 1 | String | Node identifier | |
| controllerId | Y | 1 | String | Controller identifier |
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 | N | 1 | String | Type of request | |
| numSolutions | N | 1 | Integer | number of solutions expected | |
| optimizers | N | 1...N | List of String | Optimizer to use | |
timeout | N | 1 | Integer | A tolerance window (in secs) for expecting solutions. Default is 600 secs. |
1.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 | The status of a request. | |
| solutions | Y | Solution object | Route Solution |
Solution Object
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
routeInfo | Y | 1 | Response Route info object |
Response Route Info Object
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
serviceRoute | Y | 0...N | List of controllers object | ||
| linkList | Y | 0...N | List of String |
Controller object
Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
| srcInterfaceId | Y | 1 | String | ||
| dstInterfaceId | Y | 1 | String | ||
| controllerId | Y | 1 | String |