OMC/build.ems
1
0
Fork 0
Code Issues Activity

guide

Browse Source
This commit is contained in:
simonzhangsz
2023-09-12 11:52:03 +08:00
parent f8d1c8751f
commit 7f8108ae77
5 changed files with 78 additions and 160 deletions
Download Patch File Download Diff File Expand all files Collapse all files

202
docs/05-5GC OMC restful intefaces.md
View File

@@ -13,7 +13,6 @@
```Tips
** elementTypeValue=smf/amf/..查询的网元网元类型
```
* Method:
GET
@@ -1474,7 +1473,7 @@ Example:
// SmfUEInfo SMF在线用户信息
type SubData struct {
IMSI string `json:"imsi"` // SIM卡号
MSISDN string `json:"msisdn""`
MSISDN string `json:"msisdn""`
Amf string `json:"amf"` // Amf
Status string `json:"status"` // 状态
Ki string `json:"ki"` // ki
@@ -1504,11 +1503,10 @@ Example:
#### 10.3.1 查询SMF在线用户数
* Uri
```uri
/api/rest/ueManagement/v1/elementType/SMF/objectType/ueNum?neId={neId}
/api/rest/ueManagement/v1/elementType/smf/objectType/ueNum?neId={neId}
```
* Relations
@@ -1542,19 +1540,20 @@ Example:
#### 10.3.2 查询SMF在线用户
说明：为了避免在线用户太多，SMF可做限制，如返回不超过100条
* Uri
```uri
/api/rest/ueManagement/v1/elementType/SMF/objectType/ueInfo?imsi={imsi}&msisdn={msisdn}&neId={neId}
/api/rest/ueManagement/v1/elementType/smf/objectType/ueInfo?imsi={imsi}&msisdn={msisdn}&neId={neId}
```
* Relations
OMC -> SMF
* Params
* OMC-FE -> OMC-BE, neId={neId}, 指定IMS的neId
* OMC -> IMS, imsi={imsi} 或者 msisdn={msisdn}
* OMC-FE -> OMC-BE, neId={neId}, 指定SMF的neId
* OMC -> SMF, imsi={imsi} 或者 msisdn={msisdn}，可选，如果都不指定，则查询全部ueInfo
* Method
GET
@@ -1565,50 +1564,80 @@ Example:
```json
// SmfUEInfo SMF在线用户信息
type SmfUEInfo struct {
IMSI string `json:"imsi"`
MSISDN string `json:"msisdn"`
IPv4 []string `json:"ipv4"`
Dnn []string `json:"dnn"`
Tai []string `json:"tai"`
PduSessionID []int `json:"pduSessionID"`
IPv6 []string `json:"ipv6"`
SstSD []string `json:"sstSD"`
UpfN3IP []string `json:"upfN3IP"`
RanN3IP []string `json:"ranN3IP"`
Activetime []string `json:"activeTime"`
type SmfUEInfo []struct {
IMSI string `json:"imsi"`
MSISDN string `json:"msisdn"`
PduSessionInfo []struct {
PduSessionID int `json:"pduSessionID"`
IPv4 string `json:"ipv4"`
IPv6 string `json:"ipv6"`
Dnn string `json:"dnn"`
Tai string `json:"tai"`
SstSD string `json:"sstSD"`
UpfN3IP string `json:"upfN3IP"`
RanN3IP string `json:"ranN3IP"`
Activetime string `json:"activeTime"`
} `json:"pduSessionInfo"`
}
```
```json
{
"data":
{
"imsi": "460000100000010",
"msisdn": "12307550010",
"...": "..."
}
"data": [
{
"imsi": "460000100000010",
"msisdn": "12307550010",
"pduSessionInfo": [
{
"pduSessionID": "1",
"ipv4": "172.16.5.5",
"...": "..."
},
{
"pduSessionID": "2",
"ipv4": "172.16.5.6",
"...": "..."
}
]
},
{
"imsi": "460000100000238",
"msisdn": "12307550238",
"pduSessionInfo": [
{
"pduSessionID": "3",
"ipv4": "172.16.5.7",
"...": "..."
},
{
"pduSessionID": "4",
"ipv4": "172.16.5.8",
"...": "..."
}
]
}
]
}
```
### 10.4 IMS在线用户信息
#### 10.4.1 查询IMS所有在线用户信息
#### 10.4.1 查询IMS在线用户信息
说明：为了避免在线用户太多，IMS可做限制，如返回不超过1000条
说明：为了避免在线用户太多，IMS可做限制，如返回不超过100条
* Uri
```uri
/api/rest/ueManagement/v1/elementType/IMS/objectType/ueInfos?neId={neId}
/api/rest/ueManagement/v1/elementType/ims/objectType/ueInfo?imsi={imsi}&msisdn={msisdn}&neId={neId}
```
* Relations
OMC -> IMS
* Params
OMC-FE -> OMC-BE, neId={neId}, 指定IMS的neId
* OMC-FE -> OMC-BE, neId={neId}, 指定IMS的neId
* OMC -> IMS, imsi={imsi} 或者 msisdn={msisdn}，可选，如果都不指定，则查询全部ueInfo
* Method
GET
@@ -1642,81 +1671,32 @@ Example:
},
{
"imsi": "460000100000238",
"msisdn": "12307550010",
"msisdn": "12307550038",
"impu": "sip:12307550238@ims.mnc000.mcc460.3gppnetwork.org",
"barring": 0,
"regState": 1,
"activeTime": "2023-07-11 18:26:46"
}
}
]
}
```
#### 10.4.2 查询IMS单个在线用户信息
* Uri
```uri
/api/rest/ueManagement/v1/elementType/IMS/objectType/ueInfo?imsi={imsi}&msisdn={msisdn}&neId={neId}
```
* Relations
OMC -> IMS
* Params
* OMC-FE -> OMC-BE, neId={neId}, 指定IMS的neId
* OMC -> IMS, imsi={imsi} 或者 msisdn={msisdn}
* Method
GET
* Body
NA
* Return
```json
// ImsUEInfo IMS在线用户信息
type ImsUEInfo struct {
IMSI string `json:"imsi"`
MSISDN string `json:"msisdn"`
IMPU string `json:"impu"`
Barring int `json:"barring"`
RegState int `json:"regState"`
Activetime string `json:"activeTime"`
}
```
```json
{
"data":
{
"imsi": "460000100000010",
"msisdn": "12307550010",
"impu": "sip:12307550010@ims.mnc000.mcc460.3gppnetwork.org",
"barring": 0,
"regState": 1,
"activeTime": "2023-07-11 18:26:46"
}
}
```
### 10.5 基站信息
#### 10.5.1 查询某个AMF下的所有基站信息
#### 10.5.1 查询某个AMF下的基站信息
* Uri
```uri
/api/rest/ueManagement/v1/elementType/AMF/objectType/nbInfos?neId={neId}
/api/rest/ueManagement/v1/elementType/amf/objectType/nbInfo?nbId={nbId}&neId={neId}
```
* Relations
OMC -> AMF
* Params
OMC-FE -> OMC-BE, neId={neId}, 指定AMF的neId
* OMC-FE -> OMC-BE, neId={neId}, 指定AMF的neId
* OMC -> AMF, nbId={nbId}, 可选，如果不指定则查询全部基站信息
* Method
GET
@@ -1749,55 +1729,7 @@ Example:
"name": "NB6002",
"address": "192.168.1.246:36412",
"ueNum": 6
}
}
]
}
```
#### 10.5.2 查询某个AMF下的基站信息
* Uri
```uri
/api/rest/ueManagement/v1/elementType/AMF/objectType/nbInfo/{id}
```
* Relations
OMC -> AMF
* Params
OMC-FE -> OMC-BE, neId={neId}, 指定AMF的neId
* Method
GET
* Body
NA
* Return
```json
// AmfNBInfo AMF的NodeB信息
type AmfNBInfo struct {
ID string `json:"id"` //NodeB ID
Name string `json:"name"` // NodeB name
Address string `json:"address"` // 基站地址
UENum int `jons:"ueNum"` // UE数量
}
```
example:
uri: /api/rest/ueManagement/v1/elementType/AMF/objectType/nbInfo/6001
```json
{
"data":
{
"id": "6001",
"name": "NB6001",
"address": "192.168.1.245:36412",
"ueNum": 2
}
}
```