跳到主要内容

← 概述

OmniAMF 管理 API

管理 (OAM) API 是一个面向操作员的 REST 接口，独立于 5G SBI。它公开只读状态/库存、统计信息、运行时配置和 OAM 控制操作（按 UE、按 gNB、NRF、维护和诊断）。它通过 HTTPS 在自己的端口上提供服务，并独立于 NGAP 和 SBI 监听器。

返回 操作指南 和 配置参考。

访问​

属性值
方案HTTPS (TLS)
端口8443
绑定地址0.0.0.0
路径前缀/api

所有响应都是 JSON，封装在标准信封中，带有 success / error 状态。绑定地址、端口和 TLS 材料在应用程序配置中设置（请参见 管理 API 和控制面板）。一个单独的 Web 控制面板 UI 通过 HTTPS 在端口 7443 上提供服务。

状态和库存（只读）​

方法路径描述
GET/api/status/api存活探测。
GET/api/status/nrfNRF 注册状态：nrf_status、nf_instance_id、nrf_uri。
GET/api/status/nfNF 服务状态：广告的 namf-comm/namf-evts 服务、sbi_addr/sbi_port、GUAMI。
GET/api/status/license许可证状态。
GET/api/gnb列出连接的 gNB（SCTP 关联）：gnb_id、gnb_name、ip/port、assoc_id、sctp_assoc_state、connected_since、supported_ta_list 和连接的 UE 数量。
GET/api/gnb/{id}通过 SCTP assoc_id 获取一个 gNB 的详细信息。如果未知则返回 404。
GET/api/ue列出 UE 上下文。可选查询过滤器：gnb_id、imsi（子字符串）、state（registered | idle | connected）。每个条目包含 supi、cm_state、rm_state 和 pdu_sessions_count。
GET/api/ue/{supi}通过 SUPI 获取一个 UE 的详细信息，包括安全上下文摘要、认证状态和每个会话的 PDU 会话列表。如果未找到则返回 404。
GET/api/ue_pdu_sessions/{supi}通过 SUPI 获取一个 UE 的 PDU 会话。
GET/api/ue_context列出所有活动的 UE 上下文。每个条目包含 suci、guti、tmsi_5g、gmm_state、allowed_nssai、安全上下文存在标志以及创建/最后活动时间戳。
GET/api/statistics聚合计数：已注册的 UEs、CM-CONNECTED / CM-IDLE、gNB 数量、总 PDU 会话。

运行时配置​

方法路径描述
GET/api/oam/config读取当前可变运行时配置：relative_amf_capacity、nf_capacity、nf_priority、amf_name、supported_ta_list、served_guami_list、log_level。
PATCH/api/oam/config/{id}更新上述一个或多个键。未知键将被拒绝，返回 400；无效值（例如超出范围的容量或未知的日志级别）在应用任何更新之前被拒绝。
POST/api/oam/log_level更改运行时日志级别。主体：{"level": "..."}，其中 level 是 emergency、alert、critical、error、warning、warn、notice、info、debug 之一。

更改 relative_amf_capacity 会影响广告给 gNB 和 NRF 的值，从而影响 gNB 在 AMF 之间的负载均衡。请参见 高级参数。

UE 控制操作​

POST /api/oam/ue 具有 JSON 主体。目标 UE 通过 supi（已注册的 UE）或 amf_ue_ngap_id（任何活动上下文，包括尚未拥有 SUPI 的未认证 UE）进行选择。action 字段选择操作：

action效果前提条件
paging向 UE 的最后 TAI 发送真实的 NGAP Paging。UE 必须是 RM-REGISTERED 和 CM-IDLE（需要 SUPI）。
releaseAN 释放：发送 UE 上下文释放命令并将 UE 移动到 CM-IDLE。CM-CONNECTED。
deregister网络发起的注销。如果 CM-CONNECTED，则通过 N1 发送 NAS 注销请求，否则执行本地 + SBI 拆除。无
reregister强制重新附着：注销并要求“需要重新注册”，因此 UE 立即重新注册。无
terminate硬清除：停止 UE 工作线程并丢弃其上下文（无 NAS 信令）。无

违反前提条件的请求（例如对 CM-CONNECTED UE 执行 paging）返回 409，并附带有问题的 cm_state/rm_state。未知目标返回 404。

deregister / reregister 语义（T3522，显式与隐式，安全上下文保留）在操作指南中的 注销 下进行了描述。

UE 资源（REST 动词）​

除了面向操作的 POST /api/oam/ue，UE 和 UE 上下��资源还公开直接的 REST 动词。

方法路径描述
DELETE/api/ue/{supi}注销单个 UE 并释放其上下文。这是 UE 资源上的 REST 动词；它执行与 deregister OAM 操作相同的拆除（如果 CM-CONNECTED，则通过 N1 发送 NAS 注销请求，否则本地 + SBI 拆除）。如果 SUPI 未知则返回 404。
DELETE/api/ue_context破坏性。 一次清除 所有 UE 上下文。每个活动 UE 必须重新注册。

批量 DELETE /api/ue_context 与 POST /api/oam/cache/clear 执行的 UE 上下文拆除重叠；区别在于缓存清除端点还会使 NF 发现缓存无效，而 DELETE /api/ue_context 仅丢弃 UE 上下文。在生产环境中使用时请谨慎选择。

gNB 控制操作​

DELETE /api/oam/gnb/{id}，其中 {id} 是来自 GET /api/gnb 的 SCTP assoc_id。action 查询/主体参数选择操作：

action效果
(无) / disconnectSCTP ABORT 关联：硬断开。
ng_reset向 gNB 发送 NGReset（重置所有）。
deregister_subscribers终止当前由该 gNB 服务的每个 UE 上下文。

未知的 assoc_id 返回 404。

PDU 会话控制​

方法路径描述
DELETE/api/oam/pdu_session/{id}强���释放单个 PDU 会话。{id} 是 supi:psi，例如 imsi-999700000000001:1。格式错误的 id 或未知 PSI 返回 400；未知 UE 返回 404。

维护模式​

维护模式注销 AMF 从 NRF，并拒绝新的 UE 注册，允许在重新启动之前进行排空。

方法路径描述
GET/api/oam/maintenance报告当前维护状态。
POST/api/oam/maintenance进入维护模式：从 NRF 注销，拒绝新的注册。
DELETE/api/oam/maintenance/{id}退出维护模式：重新注册到 NRF。

NRF 和缓存控制​

方法路径描述
POST/api/oam/nrf/reregister强制立即 NRF 重新注册；返回结果 nrf_status 和 nf_instance_id。
GET/api/oam/nrf_discovery列出当前 NF 发现缓存条目，包含 nf_type、解析的 uri 和 ttl_remaining_seconds，以及发现是否启用。
POST/api/oam/cache/clear清除所有内部缓存：使 NF 发现缓存无效并丢弃所有 UE 上下文。返回清除的上下文数量。
GET/api/oam/peers查看已解析的对等 NF URI（AUSF/UDM/SMF/PCF/NSSF/NRF）以及当前 SCTP 关联列表。

清除 NF 发现缓存会强制下一个 SBI 调用通过 NRF 重新解析对等体。清除 UE 上下文是破坏性的：活动 UE 必须重新注册。请参见 NF 发现。

诊断​

方法路径描述
GET/api/oam/resourcesBEAM 资源快照：进程/端口计数和限制、调度程序计数、正常运行时间、OTP/BEAM 版本。
GET/api/oam/diagnostics节点诊断：正常运行时间、连接节点、进程计数、运行队列长度、累计 I/O 字节和 GC 统计信息。

这些补充了 Prometheus 指标端点，用于在事件发生期间进行即时检查。

最后于 更新