...
RESTful Web Services Interface Specification
| # | API | Resource After base URI | HTTP Verb |
|---|---|---|---|
| /v#/nodeb/x2-setup | POST | |
| /v#/nodeb/endc-setup | POST | |
| 1 | Health Check Request | /v#/health | GET |
| 2 | Get nodeb data Request | /v#/nodeb/<ranName> | GET |
| 3 | Update GNB Request | /v#/nodeb/<ranName>/update | PUT |
| 4 | Reset nodeb Request | /v#/nodeb/<ranName>/reset * | PUT |
| 5 | Shut Down Request | /v#/nodeb/shutdown | PUT |
| 5 | Get All nodeb States Request (Changed, Stretch Goal) | /v#/nodeb/states | GET |
| 6 | Get NodeB State Request (New, Stretch Goal) | /v#/nodeb/states/<ranName> | GET |
| 7 | RAN Health Check Request (New, Stretch Goal) | /v#/nodeb/health | PUT |
| 8 | Get All E2T Request | /v#/e2t/list | GET |
Note: Due to router problem we change the Endpoint of Reset nodeb to /v1/nodeb-reset/<ranName>.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://localhost:3800/v1/e2t/list
accept: application/json
[
{
"e2tAddress": "e2t.att.com:38000",
"ranNames": ["test1","test2"]
},
{
"e2tAddress": "e2t.att.com:38001",
"ranNames": ["test1","test2","test3"]
}
]
|
9. E2M Set Parameter (New) |
Resource
| Resource for this interface /v#/nodeb/parameters |
Description | E2 Manager is requested to set some Parameter |
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 |
|
Request Data Details
Listed below are the key elements included in the request.
# | Parameter | Location | Data Type | Required? | Description and Value Rules |
|---|---|---|---|---|---|
| 1 | accept | Header | String | YES | Refer to - Standard API Request Headers |
| 2 | content-type | Header | String | See above - Standard API Request Headers | |
| 3 | Parameter | Body | Array of Parameter Object | NO | At least one Parameter Object |
parameter
Contains information of the eNodeb
# | Parameter | Data Type | Required? | Value Rules |
|---|---|---|---|---|
| 1 | key | String | yes | Depends on the Key |
| 2 | value | String | yes |
In R5 the following Parameters are supported
| Key | Value | Description |
|---|---|---|
| greenRed | "Green", "Red" | Green meaning - Future Setup from RAN will be supported Red meaning - Future Setup from RAN will be rejected |
|
Response Data Details
200 OK or error - Return the entire parameter.