OMC系统北向接口通用技术规范V1.0.0

中中 国国 移移 动动 通通 信信 企企 业业 标标 准准 QB XX XXX XXXXQB XX XXX XXXX OMCOMC 北向接口通用技术规范北向接口通用技术规范 NorthboundNorthbound InterfaceInterface GeneralGeneral TechnologyTechnology SpecificationSpecification forfor OMCOMC 版本号版本号 1 0 01 0 0 2016 2016 9 91010 1 124244 4 发布发布2016 2016 10109 9 1 124244 4 实施实施 中国移动通信集团公司发布中国移动通信集团公司发布 QB XX XXX XXXX 2 37 目录目录 1范围 5 2规范性引用文件 5 3缩略语 5 4接口架构 5 5通用技术约定 6 5 1公共要求 6 5 2FTP 通用要求 6 6资源数据接口 8 6 1接口协议 8 6 2接口数据 9 6 3数据格式 9 6 4技术指标 12 7性能数据接口 13 7 1接口协议 13 7 2接口数据 13 7 3数据格式 13 7 4技术指标 14 8告警数据接口 14 8 1接口协议 14 8 2通信过程 15 8 2 1消息方式的实时告警流水 15 8 2 2文件方式的批量告警同步 16 8 3消息数据 18 8 3 1消息格式 18 8 3 2登录与登录响应 19 8 3 3消息方式同步告警请求与响应 20 8 3 4文件方式同步告警请求与响应 21 8 3 5心跳请求与响应 22 8 3 6关闭连接通知 22 QB XX XXX XXXX 3 37 8 3 7实时告警上报 23 8 4文件数据 23 8 5技术指标 24 9操作指令接口 24 10接口日志 25 11接口可靠性要求 25 12编制历史 25 QB XX XXX XXXX 4 37 前 言 本标准由中国移动通信集团公司网络部提出并归口 本标准起草单位 中国移动通信集团公司网络部 本标准主要起草人 刘立卫 刘云霞 李健 肖捷 陈丹 高建军 张凤桥 本标准解释单位 中国移动通信集团公司网络部 本标准由中国移动通信集团公司 XXX 号文发布 QB XX XXX XXXX 5 37 1范围范围 本规范给出了中国移动 OMC 系统北向接口的通用技术要求 适用于无线网 核心 网 传输网和 IP 网四个专业 适用于新建 OMC 系统以及现网 OMC 系统改造 本规范适用于中国移动 OMC 系统北向接口的设计和实现 是中国移动 OMC 系统提 供商必须遵循的指导性文件 本规范是中国移动各级运营单位进行 OMC 系统的招标采 购 工程设计 网络运营 管理 维护 检查和验收等方面的技术依据 2规范性引用文件规范性引用文件 下列文件中的条款通过本标准的引用而成为本标准的条款 凡注日期的引用文件 其随后所有的修改单 不包括勘误的内容 或修订版均不适用于本标准 然而 鼓励 根据本标准达成协议的各方研究是否可使用这些文件的最新版本 凡不注日期的引用 文件 其最新版本适用于本标准 序号序号文档名称文档名称文档来源文档来源 01 OMC系统功能规范中国移动通信集团公司 02 OMC系统通用技术规范中国移动通信集团公司 03 OMC系统北向接口数据规范中国移动通信集团公司 3缩略语缩略语 英文缩写英文缩写英文全称英文全称中文解释中文解释 OMCOperations QB XX XXX XXXX 19 37 1 同一个空间粒度的普通测量项存储在一个数据文件中 2 如果该空间粒度还含有一系列的伪子测量项 在性能数据分册中包含 的 子测量项 如 Cause 有两种解决方案 方案一 该空间粒度的每类伪子测量单独存储一个文件 文件的命名在文件名规则的 网 元子类 部分增加伪子测量的标识 网元子类 子测量类型 登录用户名 Ri 统计周期 如 PM ENB EUTRANCELLTDD CAUSE 01 V1 1 0 000 15 001 csv zip 该文件列除资 源对象标识和时间外 包括伪子测量的标识 后面的部分 和所有该类型伪子测量指 标 具体见样例 数据样例 伪子测量 数据样例 伪子测量 数据样例 伪子测量 TimeStamp 2015 06 11 05 08 00 TimeZone UTC 8 Period 15 VendorName ZTE ElementType ENB PmVersion V2 6 0 rmUID Dn UserLabel startTime Cause RRC AttConnEstab Cause RRC SuccConnEstab Ca use RRC SuccConnReestab Cause 1301HWWX2CELA12ZA1 ZTE CMZJ TZ SubNetwork ltetdd18 ManagedElement ENODEBME EnbFunction EutranCellTdd 1 2015 06 11 10 00 00 12345 2 2 2 其中 Cause 就是伪子测量类型标识 后面都是带有 Cause 的指标名 因为不同 Cause 指标的统计对象可能不同 所以可能存在某些指标列为空的情况 比如 1301HWWX2CELA12ZA1 ENODEB1 2015 06 11 10 00 00 12345 1 2 方案二 空间粒度的每类伪子测量项和普通测量项在同一个文件中上报 文件命名规则参 见 5 2 章节 样例 PM ENB EUTRANCELLTDD 01 V1 1 0 000 15 001 csv zip 目前 TD LTE eNB 统计数据规范中有 3 类伪子测量 测量命名规则及扩展方法 分别为 QB XX XXX XXXX 20 37 1 Qci 对应子测量项 命名为 1 9 数字 并可递加扩展 如 ENBHB01 每 QCI 平均 E RAB 数子项的名称为 ERAB NbrMeanEstab 1 ERAB NbrMeanEstab 9 因 此 Qci 对应子测量项可以全部展开成 测量名称 1 测量名称 9 数量固定 2 Cause 对应子测量项 命名为英文字母开头的字符串 仅由大小写字母 数 字和 组成 例如为 3GPP 或厂家私有原因英文字符串缩写 不含空格 Cause 可以全部展开成 测量名称 字符串 但对于不同测量的 Cause 其原因数量是不同的 并且在不同厂家间 数量也是不同的 3 PRB 对应子测量项 命名为英文字母或数字开头的字符串 仅由大小写字母 数 字和 组成 PRB 可以全部展开成 测量名称 0 测量名称 99 数量固定 数据样例 伪子测量 数据样例 伪子测量 TimeStamp 2016 06 16 10 54 56 TimeZone UTC 8 Period 15 VendorName Huawei ElementType ENB PmVersion V2 6 0 rmUID Dn UserLabel startTime CONTEXT AttInitalSetup CONTEXT AttInitalSetup Csfb C ONTEXT AttMod CONTEXT AttMod Csfb CONTEXT AttRelEnb CONTEXT AttRelEnb CauseUserIn activity CONTEXT AttRelEnb HOFailure CONTEXT AttRelEnb Normal CONTEXT AttRelEnb R NL CONTEXT AttRelEnb UeLost CONTEXT AttRelMme CONTEXT AttRelMme Normalrel CONTEXT FailInitalSetup CONTEXT FailInitalSetup NoRadioRes CONTEXT FailInitalSetup RNL C ONTEXT FailInitalSetup SecurModeFail CONTEXT FailInitalSetup UeNoReply CONTEXT Fa ilMod CONTEXT NbrLeft CONTEXT SuccInitalSetup Csfb CONTEXT SuccInitalSetup CONTEX T SuccMod Csfb CONTEXT SuccMod ERAB ActiveMaxNbrDL 1 ERAB ActiveMaxNbrDL 2 ERAB A ctiveMaxNbrDL 3 ERAB ActiveMaxNbrDL 4 ERAB ActiveMaxNbrDL 5 ERAB ActiveMaxNbrDL 6 ERAB ActiveMaxNbrDL 7 ERAB ActiveMaxNbrDL 8 ERAB ActiveMaxNbrDL 9 4301HWWXACEL HW CMHN CS ManagedElement 2216 EnbFunction 1 EutranCellTdd 0 FM nanshan 0 2016 04 15 14 30 00 850 785 131 440 794 561 327 508 424 902 719 188 457 496 894 485 641 418 403 662 83 772 905 64 955 990 918 312 928 81 无线无线 LTE OMC 性能数据上报采用方案二方式 性能数据上报采用方案二方式 核心网核心网 XML 文件文件 Schema 定义 定义 QB XX XXX XXXX 21 37 QB XX XXX XXXX 22 37 核心网核心网 XML 文件样例 文件样例 2016 06 27T22 37 45 QB XX XXX XXXX 23 37 UTC 8 15 ZTE CSCF V2 0 0 2016 06 27T22 15 00 IcscfFunction LIQ AttLIR LIQ FailLIA Cause LIQ SuccLIA UR AttUAR UR FailUAA Cause UR SuccUAA 16 LIQ FailLIA 5001 0 LIQ FailLIA 5003 0 16 13 UR FailUAA 5001 0 UR FailUAA 5002 0 UR FailUAA 5003 0 UR FailUAA 5004 0 13 QB XX XXX XXXX 24 37 EpRpDynCxIcscf SIG SLFHSSCongest SIG SLFHSSCongestDuration SIG SLFHSSCongestPack SIG SLFHSSReceiveBytes SIG SLFHSSReceivePack SIG SLFHSSSendBytes SIG SLFHSSSendPack SIG SLFHSSUnavailable SIG SLFHSSUnavailableDuration 0 0 0 30720 57 30720 57 0 0 7 4技术指标技术指标 NoNo 指标名称指标名称指标含义指标含义指标值指标值 接口必选字段个数 OMC 系统内必选字段总个数 100 99 5 1 字段完整性 接口 B 类字段个数 OMC 系统内 B 类字段总个数 100 90 2 记录完整性接口记录数 OMC 系统内记录数 100 99 3 性能数据时延 性能测量文件生成时延 文件完成生成的时间 性能文 件统计周期结束时间 10 分钟 4 数据存储时长性能接口数据文件保存时长 7 天 5 并发连接数支持 ftp 客户端多连接的数量 10 个 QB XX XXX XXXX 25 37 8告警数据接口告警数据接口 8 1接口协议接口协议 告警范围 告警范围 OMC 北向接口必须上报全量告警 不允许在 OMC 侧进行告警过滤或屏蔽 接口协议 接口协议 1 实时告警采用消息方式 采用 socket tcp 协议 OMC 为 socket 的 server 端 NMS 为 socket 的 client 端 2 批量告警采用文件方式 采用 SFTP 或者 FTP 协议 接口模式 接口模式 1 消息方式的实时告警流水 2 文件方式的批量告警同步 8 2通信过程通信过程 OMC 提供一个服务端口 端口号可选范围为 31232 31241 默认使用 31232 OMC 为每个 NMS 分配不同的账号 允许每个账号建立两个 socket 连接 一个用 于消息方式的实时告警流水 一个用于文件方式的批量告警同步 QB XX XXX XXXX 26 37 8 2 1消息方式的实时告警流水消息方式的实时告警流水 OMC NMS 实时告警上报 响应 心跳下发 登录 响应 连接 消息方式同步告警请求 响应 先补发告警之后恢复 实时告警 查找 告警 断开连接 1 2 3 5 6 7 8 9 10 4 1 NMS 作为 socket 客户端 主动建立与 OMC 的连接 2 NMS 发送登录请求 登录请求信息包括用户名 授权码 请求类别 实时告警流 水 3 OMC 对用户名和授权码进行认证 接受或拒绝登录请求 OMC 检测到 NMS 连续 三次登录失败后 主动断开与 NMS 的连接 4 OMC 发送从当前时间开始的实时告警 QB XX XXX XXXX 27 37 5 当 NMS 发现实时告警消息序号不连续时 漏告警 且差值不大于 1000 时 可向 OMC 发起 1 次消息方式告警同步请求 即每次缺漏的告警 NMS 只能发起 1 次消 息同步请求 并告知 OMC 同步告警消息的起始序号 如果同步请求未成功 NMS 下次请求时至少比前次请求的告警消息起始序号 1 实时告警消息序号差值 超过 1000 时 采用文件方式同步缺失告警 6 OMC 响应请求 返回确认信息 7 OMC 暂停发送实时告警 在告警消息发送缓存中查询 NMS 提供的同步告警消息 起始序号的告警 然后补发从该告警消息序号开始的告警消息 方式和格式同 4 含告警产生消息和告警清除消息 之后继续上报实时告警消息 当 OMC 没有找到 该起始序号的告警数据 超出缓存范围 时 忽略该同步请求 从暂停序号之后的最 新告警开始实时告警上报 8 NMS 每隔 60 秒发送一次心跳信息给 OMC 进行连接可用性确认 如果在 180 秒 内 OMC 没有接收到 NMS 的任何信息时 OMC 主动断开 socket 连接 9 OMC 收到 NMS 的心跳后 响应返回确认信息 如果在 180 秒内 NMS 没有接收到 OMC 的任何信息 NMS 主动断开 socket 连接 然后尝试重新连接 10 NMS 告警数据接口程序终止前 向 OMC 发起关闭 socket 连接的通知 OMC 收 到通知后停止发送告警 断开连接 NMS 判断该关闭通知发送成功后 断开和 OMC 的连接 8 2 2文件方式的批量告警同步文件方式的批量告警同步 QB XX XXX XXXX 28 37 OMC NMS 文件告警同步 结果消息 文件方式同步告警请求 响应 FTP获取数据文件 登录 响应 连接 断开连接 生成 文件 1 2 3 4 5 6 9 8 7 10 心跳下发 响应 1 NMS 作为 socket 客户端 主动建立与 OMC 的连接 2 NMS 发送登录请求 登录请求信息包括用户名 授权码 请求类别 文件告警同 步 3 OMC 对用户名和授权码进行认证 接收或拒绝登录请求 OMC 检测到 NMS 连续 三次登录失败后 主动断开与 NMS 的连接 4 NMS 告知 OMC 同步告警范围 5 OMC 响应请求 返回确认信息 6 NMS 每隔 60 秒发送一次心跳信息给 OMC 进行连接可用性确认 如果在 180 秒 内 OMC 没有接收到 NMS 的任何信息时 OMC 主动断开 socket 连接 QB XX XXX XXXX 29 37 7 OMC 收到 NMS 的心跳后 响应返回确认信息 如果在 180 秒内 NMS 没有接收到 OMC 的任何信息 NMS 主动断开 socket 连接 然后尝试重新连接 8 OMC 基于请求条件 生成告警数据文件 发送文件通知消息给 NMS 9 NMS 从 OMC 侧获取数据文件 10 NMS 断开和 OMC 的连接 补充说明 补充说明 一次连接只能申请一次文件同步 获取完数据一次连接只能申请一次文件同步 获取完数据 OMC 返回的数据文件之后 立即返回的数据文件之后 立即 完成步骤完成步骤 10 的断开操作 的断开操作 OMC 告警文件同步有两种模式 告警文件同步有两种模式 1 基于 基于 OMC 数据库的告警数据文件数据库的告警数据文件 基于 OMC 数据库的活动告警生成数据文件 只有告警产生数据 没有告警清除数 据 主要用于 NMS 第一次启动或者周期性进行批量活动告警同步 2 基于告警流水日志的告警数据文件 基于告警流水日志的告警数据文件 基于 OMC 告警流水日志生成数据文件 包括告警产生消息和告警清除消息 主要 用于 NMS 故障或升级 OMC 故障或升级 实时告警流水漏告警条数大于 1000 等情况 8 3消息数据消息数据 8 3 1消息格式消息格式 消息数据由消息头和消息体组成 消息头由 9 个字节 byte 表示 消息体长度不 固定 各类消息不同 消息头的 9 个字节不能当做字符处理 需要按整型数处理 QB XX XXX XXXX 30 37 组成组成中文名称中文名称英文名称英文名称长度长度 byte byte取值或说明取值或说明 开始标志 startSign2 固定为 0 xFFFF 消息开始标识 消息类型 msgType1 单字节整型数 类型编码含义如下 0 realTimeAlarm 1 reqLoginAlarm 2 ackLoginAlarm 3 reqSyncAlarmMsg 4 ackSyncAlarmMsg 5 reqSyncAlarmFile 6 ackSyncAlarmFile 7 ackSyncAlarmFileResult 8 reqHeartBeat 9 ackHeartBeat 10 closeConnAlarm 秒时间戳 timeStamp4 4 字节整型数 字节顺序为 Big Endian 表示 消息产生时间 为距离 1970 01 01 00 00 00 时间偏移的秒数 消息头 长度 lenOfBody2 2 字节整型数 字节顺序为 Big Endian 表示 消息体字节长度 取值范围 0 32767 消息体 具体消息内容 对于上报的告警消息 realTimeAlarm 消息体中只包括一条 json 格式的 告警数据 除 实时告警上报消息 外的所有消息体由消息名和参数组成 形如 1 消息名 参数名大小写不敏感 2 消息名与参数间用分号 分隔 3 参数间用分号 分隔 4 参数名与参数值用 连接 参数为空时参数值为字符串 null 消息体样例 reqLoginAlarm user yiy key qw type msg 8 3 2登录与登录响应登录与登录响应 NMS 发给发给 OMC 的登录请求消息 下行 的登录请求消息 下行 消息名 reqLoginAlarm 参数 QB XX XXX XXXX 31 37 1 user 登录用户名 用户名由字母和数字组成 字母不区分大小写 2 key 授权码 授权码中不得含有分号 3 type 连接类型 取值 msg 为实时告警流水上报连接 取值 ftp 为文件方式告警同 步连接 消息样例 reqLoginAlarm user yiy key qw type msg OMC 发给发给 NMS 的登录请求的响应消息 上行 的登录请求的响应消息 上行 消息名 ackLoginAlarm 参数 1 result 登录结果 取值 succ 表示登录成功 fail 表示登录失败 2 resDesc 登录失败原因 长度小于 32 个字符 消息样例 ackLoginAlarm result fail resDesc username error 8 3 3消息方式同步告警请求与响应消息方式同步告警请求与响应 NMS 发现缺失告警时 发给发现缺失告警时 发给 OMC 的消息方式同步告警请求消息 下行 的消息方式同步告警请求消息 下行 消息名 reqSyncAlarmMsg 参数 1 reqId 操作序号 用于区分同一连接的多次请求 2 alarmSeq 同步告警的起始告警消息序号 丢失多条告警时 为最小告警消息序列 号 同一个起始告警消息序号的消息方式同步请求 NMS 只能发送一次 消息样例 reqSyncAlarmMsg reqId 33 alarmSeq 10 OMC 发给发给 NMS 的消息方式同步告警请求的响应消息 上行 的消息方式同步告警请求的响应消息 上行 消息名 ackSyncAlarmMsg 参数 1 reqId 操作序号 取值为请求消息的 reqId 2 result 响应结果 取值 succ 表示请求成功 fail 为请求失败 3 resDesc 失败原因 长度小于 32 个字符 不允许带分号 消息样例 ackSyncAlarmMsg reqId 33 result succ resDesc null QB XX XXX XXXX 32 37 8 3 4文件方式同步告警请求与响应文件方式同步告警请求与响应 NMS 发给发给 OMC 的文件方式同步告警请求消息 下行 的文件方式同步告警请求消息 下行 命令名 reqSyncAlarmFile 命令参数 1 reqId 操作序号 用于区分同一连接的多次请求 2 startTime endTime 所取告警的开始时间和结束时间 若 startTime 或 endTime 为 空 表示该条件不生效 即 若 startTime 为空 则从当前告警中最早的开始 若 endTime 为空 则取到当前最新的告警截止 告警的开始 结束时间取值的约定 对于 syncSource 0 的情况 取告警发生的时间 即告警本身的 event time 对于 syncSource 1 的情况 取北向接口记录日志流水的时间 3 alarmSeq 同步告警的起始告警消息序号 只适用于 syncSource 1 的情况 且在一 次请求中给定 alarmSeq 和 startTime endTime 是互斥的 同一条请求中只能出现其 中之一 即一次文件流水方式同步 按起始告警消息序号同步 或者按告警流水记 录时间同步 4 syncSource 同步的告警数据源 取值为 0 基于 OMC 数据库的存量活动告警数据文件 该模式下 告警消息序号 alarmSeq 的取值不做要求 但 alarmSeq 字段必须有 1 基于告警消息日志的告警消息流水数据文件 该模式下 告警消息序号 alarmSeq 和原实时上报的要保持一致 为提高 omc 北向接口部分搜索告警流水数据文件的速度 建议在存储的文件名上直 接体现该文件所存储的告警数据的起止告警消息起始序号和告警流水记录起止时间 以便通过文件名即可确定需要同步的告警文件范围 消息样例 reqSyncAlarmFile reqId 33 startTime 2014 11 27 10 00 00 endTime 2014 11 27 10 30 00 syncSource 0 reqSyncAlarmFile reqId 34 startTime 2014 11 27 10 00 00 endTime 2014 11 27 10 30 00 QB XX XXX XXXX 33 37 syncSource 1 reqSyncAlarmFile reqId 35 alarmSeq 100 syncSource 1 OMC 发给发给 NMS 的文件方式同步告警请求的响应消息 上行 的文件方式同步告警请求的响应消息 上行 消息名 ackSyncAlarmFile 无结果的立即应答 参数 1 reqId 操作序号 取值为请求消息的 reqId 2 result 响应结果 取值 succ 表示请求成功 fail 表示请求失败 3 resDesc 失败原因 长度小于 32 个字符 不允许带分号 消息样例 ackSyncAlarmFile reqId 33 result succ resDesc null OMC 发给发给 NMS 的文件方式同步告警请求的响应消息 上行 的文件方式同步告警请求的响应消息 上行 消息名 ackSyncAlarmFileResult 含有文件同步结果的应答 参数 1 reqId 操作序号 取值为请求消息的 reqId 2 result 响应结果 取值 succ 为请求成功 fail 为请求失败 3 fileName 告警数据文件的路径和名称 多个文件之间用逗号分隔 4 resDesc 失败原因 消息样例 ackSyncAlarmFileResult reqId 33 result succ filename ftproot GD WX HW JS OMC2 FM FM OMC 1A V1 1 0 603 001 txt resDesc null 8 3 5心跳请求与响应心跳请求与响应 没有实时告警数据时 没有实时告警数据时 NMS 每隔每隔 60 秒向秒向 OMC 发送一次心跳消息 下行 发送一次心跳消息 下行 消息名 reqHeartBeat 参数 reqId 操作序号 用于区分同一连接的多次请求 消息样例 reqHeartBeat reqId 33 OMC 发给发给 NMS 的心跳响应消息 上行 的心跳响应消息 上行 QB XX XXX XXXX 34 37 消息名 ackHeartBeat 参数 reqId 操作序号 用于区分同一连接的多次请求 消息样例 ackHeartBeat reqId 33 8 3 6关闭连接通知关闭连接通知 NMS 发给发给 OMC 的关闭连接通知消息 下行 的关闭连接通知消息 下行 消息名 closeConnAlarm 消息样例 closeConnAlarm 8 3 7实时告警上报实时告警上报 对应的消息头中的消息类型编码为 0 realTimeAlarm 消息体为具体告警数据 采用 json 格式 消息体信息包括告警消息序号和告警业务字段 业务字段参见 OMC 北向接口数 据规范 告警数据分册 告警消息序号 alarmSeq OMC 内告警事件连续标识 用于判断是否丢失告警 消息 具体要求如下 1 用连续正整数编号 初始编号从 1 开始 如果编号超过最大正整数 2 31 1 重 新从 1 开始编号 2 发送给多个 NMS 系统的同一条告警 告警消息序号相同 3 在 OMC 升级 重启等情况下 需要保证序号能够继续连续编号 消息体样例 alarmSeq 10 alarmStatus 1 alarmId neUID 1301HWWX1ENB2A2367 neName 深圳同发路D HLH QB XX XXX XXXX 35 37 alarmCause 数据通道配置失败 addInfo 8 4文件数据文件数据 同步告警文件采用 txt 格式文件 文件后缀为 txt 每条告警信息 告警产生或 告警清除 为 json 格式 多个告警消息的 间用 r n 分割 格式样例 alarmSeq 10 alarmStatus 1 alarmId neUID 1301HWWX1ENB neName 深圳同发路D HLH alarmCause 数据通道配置失败 addInfo 8 5技术指标技术指标 NoNo 指标名称指标名称指标含义指标含义指标值指标值 1 告警完整性NMS 收到告警数 OMC 系统内告警数 100 100 2 告警时延OMC 发送告警时间 告警发生时间 5 秒 3 告警时序性 北