ue
This commit is contained in:
BIN
docs/05-5GC OMC restful intefaces v0.76.pdf
Normal file
BIN
docs/05-5GC OMC restful intefaces v0.76.pdf
Normal file
Binary file not shown.
BIN
docs/05-5GC OMC restful intefaces v7.7.pdf
Normal file
BIN
docs/05-5GC OMC restful intefaces v7.7.pdf
Normal file
Binary file not shown.
@@ -55,9 +55,9 @@
|
|||||||
//Timestamp string `json:"timestamp"`
|
//Timestamp string `json:"timestamp"`
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
* Example:
|
* Example:
|
||||||
OMC BE -> OMC FE
|
OMC BE -> OMC FE
|
||||||
|
|
||||||
```json
|
```json
|
||||||
|
|
||||||
"data": [
|
"data": [
|
||||||
@@ -237,7 +237,6 @@
|
|||||||
```uri
|
```uri
|
||||||
/api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms
|
/api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms
|
||||||
```
|
```
|
||||||
|
|
||||||
* Method
|
* Method
|
||||||
|
|
||||||
POST
|
POST
|
||||||
@@ -1443,3 +1442,362 @@ Example:
|
|||||||
```json
|
```json
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 10 核心网用户信息接口
|
||||||
|
|
||||||
|
### 10.1 UDM签约用户
|
||||||
|
|
||||||
|
#### 10.1.1 查询/增加/修改/删除
|
||||||
|
|
||||||
|
用MML接口
|
||||||
|
|
||||||
|
* Uri
|
||||||
|
|
||||||
|
```uri
|
||||||
|
/api/rest/ueManagement/v1/elementType/UDM/objectType/subData/{imsi}?neId={neId}
|
||||||
|
```
|
||||||
|
* Relations
|
||||||
|
|
||||||
|
OMC -> UDM
|
||||||
|
* Params
|
||||||
|
|
||||||
|
OMC-FE -> OMC-BE, neId={neId}, 指定UDM的neId
|
||||||
|
* Method
|
||||||
|
|
||||||
|
GET
|
||||||
|
* Body
|
||||||
|
|
||||||
|
NA
|
||||||
|
* Return
|
||||||
|
|
||||||
|
```json
|
||||||
|
// SmfUEInfo SMF在线用户信息
|
||||||
|
type SubData struct {
|
||||||
|
IMSI string `json:"imsi"` // SIM卡号
|
||||||
|
MSISDN string `json:"msisdn""`
|
||||||
|
Amf string `json:"amf"` // Amf
|
||||||
|
Status string `json:"status"` // 状态
|
||||||
|
Ki string `json:"ki"` // ki
|
||||||
|
AlgoIndex string `json:"algoIndex"` //
|
||||||
|
Opc string `json:"opc"`
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"data":
|
||||||
|
{
|
||||||
|
"imsi": "460000100000010",
|
||||||
|
"msisdn": "12307550010",
|
||||||
|
"...": "..."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 10.2 UDM鉴权用户
|
||||||
|
|
||||||
|
#### 10.2.1 查询/增加/修改/删除
|
||||||
|
|
||||||
|
用MML接口
|
||||||
|
|
||||||
|
### 10.3 UE信息
|
||||||
|
|
||||||
|
#### 10.3.1 查询SMF在线用户数
|
||||||
|
|
||||||
|
|
||||||
|
* Uri
|
||||||
|
|
||||||
|
```uri
|
||||||
|
/api/rest/ueManagement/v1/elementType/SMF/objectType/ueNum?neId={neId}
|
||||||
|
```
|
||||||
|
* Relations
|
||||||
|
|
||||||
|
OMC -> SMF
|
||||||
|
* Params
|
||||||
|
|
||||||
|
OMC-FE -> OMC-BE, neId={neId}, 指定SMF的neId
|
||||||
|
* Method
|
||||||
|
|
||||||
|
GET
|
||||||
|
* Body
|
||||||
|
|
||||||
|
NA
|
||||||
|
* Return
|
||||||
|
|
||||||
|
```json
|
||||||
|
// SmfUENum SMF在线用户数
|
||||||
|
type SmfUENum struct {
|
||||||
|
UENum int `json:"ueNum"` // 当前在线用户数
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"data":
|
||||||
|
{
|
||||||
|
"ueNum": 6
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 10.3.2 查询SMF在线用户
|
||||||
|
|
||||||
|
* Uri
|
||||||
|
|
||||||
|
```uri
|
||||||
|
/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}
|
||||||
|
* Method
|
||||||
|
|
||||||
|
GET
|
||||||
|
* Body
|
||||||
|
|
||||||
|
NA
|
||||||
|
* Return
|
||||||
|
|
||||||
|
```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"`
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"data":
|
||||||
|
{
|
||||||
|
"imsi": "460000100000010",
|
||||||
|
"msisdn": "12307550010",
|
||||||
|
"...": "..."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 10.4 IMS在线用户信息
|
||||||
|
|
||||||
|
#### 10.4.1 查询IMS所有在线用户信息
|
||||||
|
|
||||||
|
说明：为了避免在线用户太多，IMS可做限制，如返回不超过1000条
|
||||||
|
|
||||||
|
* Uri
|
||||||
|
|
||||||
|
```uri
|
||||||
|
/api/rest/ueManagement/v1/elementType/IMS/objectType/ueInfos?neId={neId}
|
||||||
|
```
|
||||||
|
|
||||||
|
* Relations
|
||||||
|
|
||||||
|
OMC -> IMS
|
||||||
|
* Params
|
||||||
|
|
||||||
|
OMC-FE -> OMC-BE, neId={neId}, 指定IMS的neId
|
||||||
|
* 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"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"imsi": "460000100000238",
|
||||||
|
"msisdn": "12307550010",
|
||||||
|
"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下的所有基站信息
|
||||||
|
|
||||||
|
* Uri
|
||||||
|
|
||||||
|
```uri
|
||||||
|
/api/rest/ueManagement/v1/elementType/AMF/objectType/nbInfos?neId={neId}
|
||||||
|
```
|
||||||
|
|
||||||
|
* 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数量
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"data": [
|
||||||
|
{
|
||||||
|
"id": "6001",
|
||||||
|
"name": "NB6001",
|
||||||
|
"address": "192.168.1.245:36412",
|
||||||
|
"ueNum": 2
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "6002",
|
||||||
|
"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
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user