NODEB-RNIB APIs
Document status | DRAFT |
|---|---|
Document owner | |
Owner Details | +972-54-2891166, mailto:ab600d@intl.att.com |
RNIB Queries Request Overview
The purpose of this document is to describe the RNIB Queries the E2M supplies: Input and Output.
Error Handling
We defined few custom errors that implement error interface
InternalError - defined as:
type InternalError struct{
err error
}
func NewInternalError(error error) error {
return &InternalError{err:error}
}
func (e InternalError) Error() string {
return e.err.Error()
}
ResourceNotFoundError - defined as:
type ResourceNotFoundError struct{
message string
}
func NewResourceNotFoundError(msg string) error {
return &ResourceNotFoundError{message:msg}
}
func NewResourceNotFoundErrorf(fmtMsg string, a ...interface{}) error {
return &ResourceNotFoundError{message:fmt.Sprintf(fmtMsg, a...)}
}
func (e ResourceNotFoundError) Error() string {
return e.message
}
ValidationError - defined as:
type ValidationError struct{
message string
}
func NewValidationError(msg string) error {
return &ValidationError{message:msg}
}
func NewValidationErrorf(fmtMsg string, a ...interface{}) error {
return &ValidationError{message: fmt.Sprintf(fmtMsg, a...)}
}
func (e ValidationError) Error() string {
return e.message
}
List RNIB Queries (Short)
# | API + Input | Output |
|---|---|---|
1 | GetNodeb (Inventory Name) | NodebInfo |
2 | GetNodebByGlobalNbId(“GNB”:<GlobalGNB-ID> or “ENB”:<GlobalENB-ID>)) | NodebInfo |
3 | GetListgNBIDs() | NbIdentity |
4 | GetListeNBIDs() | NbIdentity |
5 | GetCountGnbList() | Int |
6 | GetCellList(inventoryName) [] Cells | Cells |
7 | GetCell(inventoryName, pci) | Cell |
8 | GetCellById(cellType, cellId) | Cell |
9 | GetRanLoadInformation (inventoryName) | RanLoadInformation |
10 | GetListNodebIds() | NbIdentity |
RNIB Shared Object
# | API + Input | Output |
|---|---|---|
1 | getListGnbIds() | GnbListJsonResponse |
List of RNIB Queries (Long)
Query-1 GetNodeb(Inventory Name)
Description | This API returns the entire data of given NodeB (eNB or gNB) by its inventory name. The inventory name is a unique key that is used by the operator's inventory systems |
Supported Languages | GoLang |
API Signature
Query-2 GetNodebByGlobalNbId(“GNB”:<GlobalGNB-ID> or “ENB”:<GlobalENB-ID>))
Description | This API returns the entire data of given NodeB (eNB or gNB) by its ID. |
Supported Languages | GoLang |
API Signature
Query-3 GetListgNBIDs()
Description | This API returns the list of the gNBs that are stored in the RNIB. The call returns both the inventory name and the gNB ID |
Supported Languages | GoLang |