...
The body is empty in case 200 OK. No other response expected. If no answer - there is a problem....
2. Get NodeB Request(Changed) |
Resource
| Resource for this interface /v#/nodeb |
Description | For fetching nodeb data from Redis, the client should send GET request |
HTTP Method | GET |
Supported Representation Formats | Request: Request Format ie application/json, none, etc Response: Response Format ie application/json, none, etc |
Successful HTTP Response Code | 200 OK |
...
| # | Parameter | Data Type | Required? | Value Rules | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | servedNrCells | Array of Object |
| Refer to served NR Cells object | ||||||
| 2 | ranFunctions | Array of Object |
| Refer to served RAN function object |
Served NR Cells
Contains information of the GNB cell
...
| # | Parameter | Data Type | Required? | Value Rules |
|---|---|---|---|---|
| 1 | nrFreqInfo | Object | Refer to nr Freq Info Object | |
| 2 | transmissionBandwidth | Object | Refer to transmission Bandwidth Object |
RAN Function
Contains information of the Function this RAN supports - Please refer to O-RAN Working Group 3, E2 Application Protocol (E2AP)
...
| # | Parameter | Data Type | Required? | Value Rules |
|---|---|---|---|---|
| 1 | ieCriticality | ENUM | Refer to Criticality ENUM | |
| 2 | ieId | Integer | ||
| 3 | typeOfError | ENUM | Refer to TypeOfError ENUM |
3. Update GNBRequest (New)Request |
Resource
| Resource for this interface /v#/nodeb |
Description | For storing nodeb data to Redis, the client should send PUT request |
HTTP Method | PUT |
Supported Representation Formats | Request: Request Format ie application/json, none, etc Response: Response Format ie application/json, none, etc |
Successful HTTP Response Code | 200 OK |
...
There is no Body in case 204 No Content, and with 202 Accepted with error details in case failure such as Routing Manager (511)
5. Get All NodeBStatesRequest(Changed, Stretch Goal) |
Resource
| Resource for this interface /v#/nodeb/statesids |
Description | E2 Manager is requested to get list of all RANs in its RNIB DB Note: In previous Release it was called Get All nodeb and its signature was different. |
HTTP Method | GET |
Supported Representation Formats | Request: Request Format ie application/json, none, etc Response: Response Format ie application/json, none, etc |
Successful HTTP Response Code | 200 OK |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<serverBaseURL>/v#/nodeb/statesids |
Request Data Details
Listed below are the key elements included in the request.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://localhost:3800/v1/nodeb/states ids accept: application/json |
Response Data Details
...
| # | Parameter | Data Type | Required? | Value Rules | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | inventoryName | String |
| Name of the RAN | ||||||
| 2 | globalNbId | Object |
| ID of the RAN - Refer globalNbId object | ||||||
| 3 | healthCheckTimestampSent | Long |
| The Unix epoch (The number of nanoseconds that have elapsed since January 1, 1970) when the Health Check (RIC Service Query) was sent | ||||||
| 4 | healthCheckTimestampReceived | Long |
| Timestamp (Unix epoch) when the Health Check (RIC Service Update) was received |
globalNbId
Contains information of the eNodeb
globalNbId
Contains information of the eNodeb
| # | Parameter | Data Type | Required? | Value Rules |
|---|---|---|---|---|
| 1 | nbId | String | yes | ID of the RAN |
| # | Parameter | Data Type | Required? | Value Rules |
| 1 | nbId | String | yes | ID of the RAN. Different ID for eNB or gNB. In case eNB it is according the eNB Type. |
| 2 | plmnId | Object | yes | ID of the PLMN (Public Land Mobile Network) |
There is no Body in case 204 No Content, and with 202 Accepted with error details in case failure such as Routing Manager (511)
) |
Resource
Resource for this interface
/v#/nodeb/states/<ran name>
Description
E2 Manager is requested to get specific RAN - Health check
HTTP Method
GET
Supported Representation Formats
Request: Request Format ie application/json, none, etc
Response: Response Format ie application/json, none, etc
Successful HTTP Response Code
200 OK
GET http://<serverBaseURL>/v#/nodeb/states/<ran name>
Request Data Details
Listed below are the key elements included in the request.
...
#
...
Parameter
...
Location
...
Data Type
...
Required?
...
Description and Value Rules
...
accept
...
Header
...
String
...
YES
...
Refer to - Standard API Request Headers
...
GET http://localhost:3800/v1/nodeb/states/<ran name>accept: application/json
Response Data Details
In case 200 OK, this is the payload
...
#
...
Parameter
...
Location
...
Data Type
...
Required?
...
Value Rules
...
content-type
...
Header
...
String
...
YES
...
ran
...
Body
...
Object
...
YES
...
See nodebIdentity
...
7. RAN Health Check Request (New, Stretch Goal)
...
Resource
...
Resource for this interface
/v#/nodeb/health
...
Description
...
E2 Manager is requested to Check connectivity with RANs (List) or all
...
HTTP Method
...
PUT
...
Supported Representation Formats
...
Request: Request Format ie application/json, none, etc
Response: Response Format ie application/json, none, etc
...
Successful HTTP Response Code
...
202 Accepted
| Code Block | ||||
|---|---|---|---|---|
| ||||
PUT http://<serverBaseURL>/v#/nodeb/health |
Request Data Details
Listed below are the key elements included in the request.
...
Location
...
accept
...
Header
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to - Standard API Request Headers
...
content-type
...
Header
...
String
...
See above - Standard API Request Headers
...
RANs
...
Body
...
Array of strings
...
| Status | ||||
|---|---|---|---|---|
|
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
PUT http://localhost:3800/v1/nodeb/health
accept: application/json
|
Response Data Details
...
|
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
PUT http://<serverBaseURL>/v#/nodeb/<ran name>/reset (See remark above about changing the Endpoint) |
Request Data Details
Listed below are the key elements included in the request.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
PUT http://localhost:3800/v1/nodeb/NYC213123/reset
accept: application/json
{
"cause": “misc:om-intervention”
}
|
Response Data Details
There is no Body in case 204 No Content, and with error details in case failure
...
|
Request Data Details
Listed below are the key elements included in the request.
...
|
Response Data Details
In case 200 OK, this is the payload
...