1
0
Files
build.ems/docs/08-interfaces/OMC网元直连接口.md

1264 lines
49 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# OMC
OMC HTTP Restful API Interfaces
Base URLs:
* `<a href="http://192.168.150:33030">`直连网元: http://192.168.150:33030`</a>`
# Authentication
# 网元直连接口
## GET 获取网元告警
GET /api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms
OMC不支持 部分网元也不支持,具体看情况
### Params
| Name | Location | Type | Required | Description |
| ---------------- | -------- | ------ | -------- | ----------- |
| elementTypeValue | path | string | yes | 网元类型 |
> Response Examples
> 成功
```json
null
```
```json
[
{
"alarmSeq": 0,
"alarmId": "90001711797675752",
"neId": "4400HX1SMF001",
"neName": "SMF_001",
"neType": "SMF",
"objectName": "SMF_001",
"province": "网元所在省份",
"PVFlag": "PNF",
"eventTime": "2024-03-30T19:21:15+08:00",
"alarmCode": 9000,
"alarmType": "EquipmentAlarm",
"alarmTitle": "Service Process Startup",
"origSeverity": "Event",
"alarmStatus": 1,
"specificProblem": "cause:Service Process Startup",
"specificProblemID": "AC9000",
"locationInfo": "PDI:3964079,User:root,PName:smf,StartTime:2024-03-30 19:21:15"
}
]
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | Title | description |
| -------------------- | ------- | -------- | ------------ | ----- | ----------- |
| » alarmSeq | integer | false | none | | none |
| » alarmId | string | false | none | | none |
| » neId | string | false | none | | none |
| » neName | string | false | none | | none |
| » neType | string | false | none | | none |
| » objectName | string | false | none | | none |
| » province | string | false | none | | none |
| » PVFlag | string | false | none | | none |
| » eventTime | string | false | none | | none |
| » alarmCode | integer | false | none | | none |
| » alarmType | string | false | none | | none |
| » alarmTitle | string | false | none | | none |
| » origSeverity | string | false | none | | none |
| » alarmStatus | integer | false | none | | none |
| » specificProblem | string | false | none | | none |
| » specificProblemID | string | false | none | | none |
| » locationInfo | string | false | none | | none |
# 网元直连接口/参数配置
## PUT 网元配置对端网管信息
PUT /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/config/omcNeConfig
在网管上配置相连的网元信息,下发参数给网元。
udm pcf ausf下发返回200 响应请求内容
ims smf amf下发返回204 无数据返回
nssf下发返回201 响应操作修改内容
> Body Parameters
```json
{
"neId": "001",
"neName": "SMF_001",
"port": 3030,
"province": "-",
"pvFlag": "PNF",
"rmUID": "4400HX1SMF001",
"vendorName": "AGrandTech",
"dn": "-"
}
```
### Params
| Name | Location | Type | Required | Title | Description |
| ---------------- | -------- | ------ | -------- | -------------------------------------------- | ----------- |
| elementTypeValue | path | string | yes | | 网元类型 |
| body | body | object | no | | none |
| » neId | body | string | yes | 网元标识(内部) | none |
| » rmUID | body | string | yes | rmUID 网元唯一标识 | none |
| » neName | body | string | yes | 网元名称(内部)/友好名称(北向资源/性能等使用) | none |
| » pvFlag | body | string | yes | 网元虚实性标识 VNF/PNF: 虚拟/物理 | none |
| » province | body | string | yes | 网元所在省份 | none |
| » vendorName | body | string | yes | 厂商名称 | none |
| » dn | body | string | yes | 资源里边的ManagedBy性能的Dn网络唯一标识 | none |
> Response Examples
> 成功
> 204 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ------------------------------------------------------------ | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | 删除成功 | Inline |
### Responses Data Schema
## GET 网元参数配置数据
GET /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/config/{paraName}
### Params
| Name | Location | Type | Required | Title | Description |
| ---------------- | -------- | ------ | -------- | ----- | ----------- |
| elementTypeValue | path | string | yes | | 网元类型 |
| paraName | path | string | yes | | 网元参数mib |
> Response Examples
> Success
```json
{
"data": [
{
"index": 0,
"plmnId": "46011",
"tac": 81
},
{
"index": 1,
"plmnId": "46011",
"tac": 82
}
]
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## PUT 网元参数配置更新
PUT /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/config/{paraName}
成功204 无内容
仅array使用index属性定位变更数据项
> Body Parameters
```json
{
"index": 2,
"plmnId": "46060",
"apn": "internet",
"pgwIp": "192.168.1.181"
}
```
### Params
| Name | Location | Type | Required | Title | Description |
| ---------------- | -------- | ------ | -------- | ----- | ---------------------------------- |
| elementTypeValue | path | string | yes | | 网元类型小写 |
| paraName | path | string | yes | | 可用属性值 |
| loc | query | string | no | | 仅array 层级 index必须大于已有的 |
| body | body | object | no | | none |
> Response Examples
> No Content
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ------------------------------------------------------------ | ----------- | ----------- |
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | Inline |
### Responses Data Schema
## DELETE 网元参数配置删除array
DELETE /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/config/{paraName}
成功返回204 无内容
array类型会有loc的层概念, 多层时需要划分嵌套层0/ueDnnIpPool/1
### Params
| Name | Location | Type | Required | Title | Description |
| ---------------- | -------- | ------ | -------- | ----- | -------------------------- |
| elementTypeValue | path | string | yes | | 网元类型小写 |
| paraName | path | string | yes | | 可用属性值 |
| loc | query | string | yes | | 层级 index必须大于已有的 |
> Response Examples
> 204 Response
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ------------------------------------------------------------ | ----------- | ----------- |
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | Inline |
### Responses Data Schema
## POST 网元参数配置新增array
POST /api/rest/systemManagement/v1/elementType/{neType}/objectType/config/{paramName}
响应200成功请求体发送什么返回什么
array类型会有loc的层概念, 多层时需要划分嵌套层0/ueDnnIpPool/1
> Body Parameters
```json
{
"index": 3,
"plmnId": "46000",
"tac": 1,
"regionId": 1,
"setId": 1,
"pointer": 1,
"amfIp": "192.168.1.188"
}
```
### Params
| Name | Location | Type | Required | Title | Description |
| --------- | -------- | ------ | -------- | ----- | -------------------------- |
| neType | path | string | yes | | 网元类型小写 |
| paramName | path | string | yes | | 可用属性值 |
| loc | query | string | yes | | 层级 index必须大于已有的 |
| body | body | object | no | | none |
> Response Examples
> 成功
```json
null
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
### Responses Data Schema
# 网元直连接口/AMF
## GET AMF基站信息
GET /api/rest/ueManagement/v1/elementType/amf/objectType/nbInfo
### Params
| Name | Location | Type | Required | Title | Description |
| ---- | -------- | ------ | -------- | ----- | ----------- |
| nbId | query | string | yes | | none |
| neId | query | string | yes | | none |
> Response Examples
> 记录不存在
```json
{
"cause": "GNB_NOT_FOUND",
"status": 404
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ----------------------------------------------------------- | ----------- | ----------- |
| 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | 记录不存在 | Inline |
### Responses Data Schema
# 网元直连接口/IMS
## GET IMS会话数
GET /api/rest/ueManagement/v1/elementType/ims/objectType/ueNum
### Params
| Name | Location | Type | Required | Title | Description |
| --------------- | -------- | ------ | -------- | ----- | ------------------- |
| neId | query | string | no | | none |
| Authorization | header | string | yes | | Authoirzation token |
| Referer | header | string | yes | | User Referer |
| User-Agent | header | string | yes | | User Agent |
| Accept-Language | header | string | yes | | en_US;q=0.9 |
> Response Examples
> Success
```json
{
"ueNum": 512
}
```
```json
{
"ueNum": 512
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## GET IMS会话信息
GET /api/rest/ueManagement/v1/elementType/ims/objectType/ueInfo
### Params
| Name | Location | Type | Required | Title | Description |
| --------------- | -------- | ------ | -------- | ----- | ------------------- |
| neId | query | string | no | | none |
| Authorization | header | string | yes | | Authoirzation token |
| Referer | header | string | yes | | User Referer |
| User-Agent | header | string | yes | | User Agent |
| Accept-Language | header | string | yes | | en_US;q=0.9 |
> Response Examples
> Success
```json
{
"ueNum": 512
}
```
```json
{
"ueNum": 512
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
# 网元直连接口/SMF
## GET SMF会话数
GET /api/rest/ueManagement/v1/elementType/smf/objectType/ueNum
只含5G用户数据
### Params
| Name | Location | Type | Required | Title | Description |
| --------------- | -------- | ------ | -------- | ----- | ------------------- |
| neId | query | string | no | | none |
| Authorization | header | string | yes | | Authoirzation token |
| Referer | header | string | yes | | User Referer |
| User-Agent | header | string | yes | | User Agent |
| Accept-Language | header | string | yes | | en_US;q=0.9 |
> Response Examples
> OK
```json
{
"data": {
"ueNum": 26090
}
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | Title | description |
| ---------- | ------- | -------- | ------------ | ----- | ----------- |
| » data | object | true | none | | none |
| »» ueNum | integer | true | none | | none |
## GET SMF在线用户列表
GET /api/rest/ueManagement/v1/elementType/smf/objectType/ueInfo
含4G 5G用户数据
### Params
| Name | Location | Type | Required | Title | Description |
| -------- | -------- | ------ | -------- | ----- | ---------------------------- |
| imsi | query | string | no | | none |
| msisdn | query | string | no | | none |
| pageNum | query | number | no | | Page numberdefault 1 |
| pageSize | query | number | no | | Size of one pagedefault 10 |
> Response Examples
> OK
```json
{
"rows": [
{
"imsi": "imsi-001010000000000",
"msisdn": "msisdn-1010000000",
"ratType": "NR",
"pduSessionInfo": [
{
"ipv4": "11.0.4.224",
"dnn": "cmnet",
"tai": "00101-001124",
"pduSessionID": 1,
"ipv6": "",
"sstSD": "1-000001",
"upfN3IP": "192.168.1.161",
"ranN3IP": "192.168.8.34",
"activeTime": "2024-06-27 14:41:09",
"upState": "Active"
}
]
}
],
"total": 1
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | Title | description |
| ------------------- | -------- | -------- | ------------ | ----- | ----------- |
| » rows | [object] | true | none | | none |
| »» imsi | string | true | none | | none |
| »» msisdn | string | true | none | | none |
| »» ratType | string | true | none | | none |
| »» pduSessionInfo | [object] | true | none | | none |
| »»» ipv4 | string | true | none | | none |
| »»» dnn | string | true | none | | none |
| »»» tai | string | true | none | | none |
| »»» pduSessionID | integer | true | none | | none |
| »»» ipv6 | string | true | none | | none |
| »»» sstSD | string | true | none | | none |
| »»» upfN3IP | string | true | none | | none |
| »»» ranN3IP | string | true | none | | none |
| »»» activeTime | string | true | none | | none |
| »»» upState | string | true | none | | none |
| » total | integer | true | none | | none |
# 网元直连接口/PCF
## GET Query PCF UE Info
GET /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo
### Params
| Name | Location | Type | Required | Title | Description |
| --------------- | -------- | ------ | -------- | ----- | ------------------- |
| imsi | query | string | no | | none |
| msisdn | query | string | no | | none |
| neId | query | string | yes | | none |
| AccessToken | header | string | yes | | none |
| Authorization | header | string | yes | | Authoirzation token |
| Referer | header | string | yes | | User Referer |
| User-Agent | header | string | yes | | User Agent |
| Accept-Language | header | string | yes | | en_US;q=0.9 |
> Response Examples
> 成功
```json
{
"data": [
{
"msisdn": "12307550237",
"pccRules": "internet",
"rfsp": 0,
"sessRules": "internet"
},
{
"msisdn": "12307550238",
"pccRules": "internet|ims_sig",
"rfsp": 0,
"sessRules": "internet|ims_sig"
}
]
}
```
```json
{
"data": [
{
"msisdn": "12307550237",
"pccRules": "internet",
"rfsp": 0,
"sessRules": "internet"
},
{
"msisdn": "12307550238",
"pccRules": "internet|ims_sig",
"rfsp": 0,
"sessRules": "internet|ims_sig"
}
]
}
```
```json
{
"data": [
{
"hdrEnrich": "dnn",
"imsi": "460990100000006",
"msisdn": "86755900001",
"pccRules": "internet|ims_sig",
"qosAudio": "qos_audio",
"qosVideo": "qos_video",
"rfsp": 1,
"sar": "def_sar",
"sessRules": "internet|ims_sig",
"uePolicy": "uep_001"
}
]
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
### Responses Data Schema
## POST Add PCF UE Info
POST /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo
> Body Parameters
```json
{
"imsi": "460990100000002",
"msisdn": "86755900001",
"qosAudio": "qos_audio",
"pccRules": "internet|ims_sig",
"rfsp": 1,
"uePolicy": "uep_001",
"sessRules": "internet|ims_sig",
"sar": "def_sar",
"hdrEnrich": "dnn",
"qosVideo": "qos_video"
}
```
### Params
| Name | Location | Type | Required | Title | Description |
| ------------ | -------- | ------- | -------- | ----- | ----------- |
| neId | query | string | yes | | none |
| body | body | object | no | | none |
| » imsi | body | string | yes | | none |
| » msisdn | body | string | yes | | none |
| » rfsp | body | integer | no | | none |
| » sar | body | string | no | | none |
| » pccRules | body | string | no | | none |
| » sessRules | body | string | no | | none |
| » uePolicy | body | string | no | | none |
| » qosAudio | body | string | no | | none |
| » qosVideo | body | string | no | | none |
| » hdrEnrich | body | string | no | | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
### Responses Data Schema
## PUT Modify PCF UE Info
PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo
> Body Parameters
```json
{
"imsi": "000510200000001",
"msisdn": "1350000001",
"rfsp": "omitempty",
"sar": "",
"pccRules": "",
"sessRules": "",
"uePolicy": "",
"qosAudio": "",
"qosVideo": "",
"hdrEnrich": ""
}
```
### Params
| Name | Location | Type | Required | Title | Description |
| ------------ | -------- | ------- | -------- | ----- | ----------- |
| imsi | query | string | no | | none |
| msisdn | query | string | no | | none |
| neId | query | string | yes | | none |
| AccessToken | header | string | yes | | none |
| body | body | object | no | | none |
| » imsi | body | string | yes | | none |
| » msisdn | body | string | no | | none |
| » rfsp | body | integer | no | | none |
| » sar | body | string | no | | none |
| » pccRules | body | string | no | | none |
| » sessRules | body | string | no | | none |
| » uePolicy | body | string | no | | none |
| » qosAudio | body | string | no | | none |
| » qosVideo | body | string | no | | none |
| » hdrEnrich | body | string | no | | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
### Responses Data Schema
## DELETE Delete PCF UE Info
DELETE /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo
### Params
| Name | Location | Type | Required | Title | Description |
| ----------- | -------- | ------ | -------- | ----- | ----------- |
| imsi | query | string | yes | | none |
| neId | query | string | yes | | none |
| AccessToken | header | string | yes | | none |
> Response Examples
> Record Not Found
```json
{
"cause": "DATA_NOT_FOUND",
"status": 404
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ----------------------------------------------------------- | ---------------- | ----------- |
| 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | Record Not Found | Inline |
### Responses Data Schema
HTTP Status Code **404**
| Name | Type | Required | Restrictions | Title | description |
| --------- | ------- | -------- | ------------ | ----- | ----------- |
| » cause | string | true | none | | none |
| » status | integer | true | none | | none |
## POST Batch Add PCF UE Info
POST /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/batch/{number}
> Body Parameters
```json
{
"num": 11,
"imsi": "260990100000001",
"msisdn": "86755900001",
"qosAudio": "qos_audio",
"pccRules": "internet|ims_sig",
"rfsp": 1,
"uePolicy": "uep_001",
"sessRules": "internet|ims_sig",
"sar": "def_sar",
"hdrEnrich": "dnn",
"qosVideo": "qos_video",
"neId": "001"
}
```
### Params
| Name | Location | Type | Required | Title | Description |
| ------------ | -------- | ------- | -------- | ----- | ----------- |
| number | path | string | yes | | none |
| neId | query | string | yes | | none |
| body | body | object | no | | none |
| » imsi | body | string | yes | | none |
| » msisdn | body | string | yes | | none |
| » rfsp | body | integer | no | | none |
| » sar | body | string | no | | none |
| » pccRules | body | string | no | | none |
| » sessRules | body | string | no | | none |
| » uePolicy | body | string | no | | none |
| » qosAudio | body | string | no | | none |
| » qosVideo | body | string | no | | none |
| » hdrEnrich | body | string | no | | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
### Responses Data Schema
## PUT Batch Modify PCF UE Info
PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/batch/{number}
> Body Parameters
```json
{
"imsi": "000510200000001",
"msisdn": "1350000001",
"rfsp": "omitempty",
"sar": "",
"pccRules": "",
"sessRules": "",
"uePolicy": "",
"qosAudio": "",
"qosVideo": "",
"hdrEnrich": ""
}
```
### Params
| Name | Location | Type | Required | Title | Description |
| ------------ | -------- | ------- | -------- | ----- | ----------- |
| number | path | string | yes | | none |
| neId | query | string | yes | | none |
| body | body | object | no | | none |
| » imsi | body | string | yes | | none |
| » msisdn | body | string | yes | | none |
| » rfsp | body | integer | yes | | none |
| » sar | body | string | yes | | none |
| » pccRules | body | string | yes | | none |
| » sessRules | body | string | yes | | none |
| » uePolicy | body | string | yes | | none |
| » qosAudio | body | string | yes | | none |
| » qosVideo | body | string | yes | | none |
| » hdrEnrich | body | string | yes | | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
### Responses Data Schema
## DELETE Batch Delete PCF UE Info
DELETE /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/batch/{number}
### Params
| Name | Location | Type | Required | Title | Description |
| --------------- | -------- | ------ | -------- | ----- | ------------------- |
| number | path | string | yes | | none |
| neId | query | string | yes | | none |
| imsi | query | string | yes | | none |
| Authorization | header | string | yes | | Authoirzation token |
| Referer | header | string | yes | | User Referer |
| User-Agent | header | string | yes | | User Agent |
| Accept-Language | header | string | yes | | en_US;q=0.9 |
> Response Examples
> 成功
```json
{
"cause": "no imsi",
"status": 400
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
### Responses Data Schema
## GET Export PCF UE Info
GET /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/file/export
### Params
| Name | Location | Type | Required | Title | Description |
| -------- | -------- | ------ | -------- | ----- | ----------- |
| neId | query | string | yes | | none |
| fileType | query | string | yes | | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
### Responses Data Schema
## PUT Import PCF UE Info
PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/file/import
> Body Parameters
```json
{
"neId": "001",
"type": "txt",
"filePath": "xxx.txt"
}
```
### Params
| Name | Location | Type | Required | Title | Description |
| ------------ | -------- | ------- | -------- | ----- | ----------- |
| neId | query | string | yes | | none |
| filePath | query | string | yes | | none |
| fileType | query | string | yes | | none |
| body | body | object | no | | none |
| » imsi | body | string | yes | | none |
| » msisdn | body | string | yes | | none |
| » rfsp | body | integer | yes | | none |
| » sar | body | string | yes | | none |
| » pccRules | body | string | yes | | none |
| » sessRules | body | string | yes | | none |
| » uePolicy | body | string | yes | | none |
| » qosAudio | body | string | yes | | none |
| » qosVideo | body | string | yes | | none |
| » hdrEnrich | body | string | yes | | none |
> Response Examples
> OK
```json
{
"detail": "[Request Body] unexpected end of JSON input",
"status": 400,
"title": "Malformed request syntax"
}
```
```json
{
"neId": "001",
"fileType": "txt",
"filePath": "/home/agtuser/PCF_001_1701420431873_zsda89.txt"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | Title | description |
| ----------- | ------ | -------- | ------------ | ----- | ----------- |
| » neId | string | true | none | | none |
| » fileType | string | true | none | | none |
| » filePath | string | true | none | | none |
# 网元直连接口/OMC
## GET 获取OMC状态
GET /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/systemState
### Params
| Name | Location | Type | Required | Title | Description |
| ---------------- | -------- | ------ | -------- | ----- | ------------------- |
| elementTypeValue | path | string | yes | | 网元类型 |
| Authorization | header | string | yes | | Authoirzation token |
| Referer | header | string | yes | | User Referer |
| User-Agent | header | string | yes | | User Agent |
| Accept-Language | header | string | yes | | en_US;q=0.9 |
> Response Examples
> OK
```json
{
"hostName": "5GC",
"osInfo": "Linux 5GC 4.15.0-112-generic #113-Ubuntu SMP Thu Jul 9 23:41:39 UTC 2020 x86_64 GNU/Linux",
"dbInfo": "adb v1.0.1",
"version": "2.2312.10",
"ipAddr": [
"192.168.1.173",
""
],
"port": 3030,
"capability": 50000,
"serialNum": "13740272",
"expiryDate": "2023-12-31",
"cpuUsage": {
"nfCpuUsage": 0,
"sysCpuUsage": 209
},
"memUsage": {
"totalMem": 8167368,
"nfUsedMem": 1413816,
"sysMemUsage": 2372
},
"diskSpace": {
"partitionNum": 7,
"partitionInfo": [
{
"total": 3966,
"used": 0
},
{
"total": 797,
"used": 0
},
{
"total": 200559,
"used": 16755
},
{
"total": 3987,
"used": 0
},
{
"total": 5,
"used": 0
},
{
"total": 3987,
"used": 0
},
{
"total": 797,
"used": 0
}
]
}
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | Title | description |
| ------------------ | -------- | -------- | ------------ | ----- | ------------------------------------ |
| » hostName | string | true | none | | linux命令: hostname |
| » osInfo | string | true | none | | linux命令: uname -a |
| » dbInfo | string | true | none | | 网元如果有db, 显示数据库名和版本信息 |
| » version | string | true | none | | 软件版本信息 |
| » ipAddr | [string] | true | none | | none |
| » port | integer | true | none | | 端口 |
| » capability | integer | true | none | | none |
| » serialNum | string | true | none | | none |
| » expiryDate | string | true | none | | 过期时间 |
| » cpuUsage | object | true | none | | CPIU使用 |
| »» nfCpuUsage | integer | true | none | | none |
| »» sysCpuUsage | integer | true | none | | none |
| » memUsage | object | true | none | | none |
| »» totalMem | integer | true | none | | none |
| »» nfUsedMem | integer | true | none | | none |
| »» sysMemUsage | integer | true | none | | none |
| » diskSpace | object | true | none | | none |
| »» partitionNum | integer | true | none | | none |
| »» partitionInfo | [object] | true | none | | none |
| »»» total | integer | true | none | | none |
| »»» used | integer | true | none | | none |
## POST 告警信息上报
POST /api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms
> Body Parameters
```json
[
{
"alarmSeq": 1,
"alarmId": "HXEMSSM10000",
"neId": "4400HX1MOCNGW001",
"alarmCode": 10000,
"alarmTitle": "The system state is abnormal",
"eventTime": "2024-03-18T18:08:18+08:00",
"alarmType": "EquipmentAlarm",
"origSeverity": "Major",
"perceivedSeverity": "",
"pvFlag": "PNF",
"neName": "MOCNGW",
"neType": "MOCNGW",
"objectUid": "",
"objectName": "EMS;SystemManagement;Heartbeat",
"objectType": "SystemState",
"locationInfo": "SystemManagement.State: NE heartbeat timestamp=2024-03-13 18:02:29ï¼threshold=30",
"province": "",
"alarmStatus": 1,
"specificProblem": "Alarm cause: the system state of target NE has not been received for 30 seconds",
"specificProblemID": "AC10000",
"addInfo": ""
}
]
```
### Params
| Name | Location | Type | Required | Title | Description |
| ---------------- | -------- | ------------- | -------- | ----- | ----------- |
| elementTypeValue | path | string | yes | | none |
| User-Agent | header | string | yes | | User Agent |
| Accept-Language | header | string | yes | | en_US;q=0.9 |
| body | body | array[object] | no | | none |
> Response Examples
> 成功
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
### Responses Data Schema
## POST 黄金指标上报
POST /api/rest/performanceManagement/v1/elementType/{elementTypeValue}/objectType/kpiReport/{index}
> Body Parameters
```json
"{\r\n \"TimeStamp\": \"{% mock 'now', 'day', 'yyyy-MM-dd', '', mode='start' %}T{% mock 'now', 'second', 'HH:mm:ss+08:00', '', mode='start' %}\",\r\n \"Task\": {\r\n \"Period\": {\r\n \"StartTime\": \"{% mock 'now', 'day', 'yyyy-MM-dd', '', mode='start' %}T{% mock 'now', 'second', 'HH:mm:ss+08:00', duration='-5 second', mode='start' %}\",\r\n \"EndTime\": \"{% mock 'now', 'day', 'yyyy-MM-dd', '', mode='start' %}T{% mock 'now', 'second', 'HH:mm:ss+08:00', '', mode='start' %}\"\r\n },\r\n \"NE\": {\r\n \"NEName\": \"MME_001\",\r\n \"rmUID\": \"4400HX1MME001\",\r\n \"NeType\": \"MME\",\r\n \"KPIs\": [\r\n {\r\n \"KPIID\": \"MME.A.01\",\r\n \"Value\": {% mock 'integer', 0, 5675 %},\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.02\",\r\n \"Value\": {% mock 'integer', 0, 5675 %},\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.03\",\r\n \"Value\": {% mock 'integer', 0, 5675 %},\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.04\",\r\n \"Value\": {% mock 'integer', 0, 5675 %},\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.05\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.06\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.07\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.08\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.09\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.10\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.11\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.12\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.13\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.14\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.15\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.16\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.17\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.18\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.19\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.20\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.21\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.22\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.23\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.24\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.25\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.26\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.27\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.28\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.29\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.30\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n },\r\n {\r\n \"KPIID\": \"MME.A.31\",\r\n \"Value\": 0,\r\n \"Err\": \"\"\r\n }\r\n ]\r\n }\r\n }\r\n}"
```
### Params
| Name | Location | Type | Required | Title | Description |
| ---------------- | -------- | -------- | -------- | ----- | ------------------------------------------------------------------------ |
| elementTypeValue | path | string | yes | | 网元类型 |
| index | path | string | yes | | 黄金指标的上报粒度是1分钟index是当前时间片在一天中的索引取值0~1439 |
| Authorization | header | string | yes | | Authoirzation token |
| Referer | header | string | yes | | User Referer |
| User-Agent | header | string | yes | | User Agent |
| Accept-Language | header | string | yes | | en_US;q=0.9 |
| body | body | object | no | | none |
| » TimeStamp | body | string | yes | | none |
| » Task | body | object | yes | | none |
| »» Period | body | object | yes | | none |
| »»» StartTime | body | string | yes | | none |
| »»» EndTime | body | string | yes | | none |
| »» NE | body | object | yes | | none |
| »»» NEName | body | string | yes | | none |
| »»» rmUID | body | string | yes | | none |
| »»» NeType | body | string | yes | | none |
| »»» KPIs | body | [object] | yes | | none |
| »»»» KPIID | body | string | yes | | none |
| »»»» Value | body | integer | yes | | none |
| »»»» Err | body | string | yes | | none |
> Response Examples
> 成功
```json
null
```
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
### Responses Data Schema
# 网元直连接口/N3IWF
## GET N3IWF会话信息
GET /api/rest/ueManagement/v1/elementType/n3iwf/objectType/ueInfo
> Response Examples
> Success
```json
{
"data": {
"ueNum": 0
}
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
# Data Schema