您好,欢迎来到微智科技网。
搜索
您的当前位置:首页中国移动上网日志留存系统用户上网日志查询系统接口规范V1.0.5

中国移动上网日志留存系统用户上网日志查询系统接口规范V1.0.5

来源:微智科技网


QB-╳╳-╳╳╳-╳╳╳╳

Interface Specification of User Log Query System

版本号:1.0.5

╳╳╳╳╳╳-╳╳-╳╳实施 ╳╳-╳╳-╳╳发布

中国移动通信企业标准

中国移动日志留存系统 用户上网日志查询系统

接口规范

中国移动通信集团公司 发布

QB-╳╳-╳╳╳-╳╳╳╳

目 录

前 言 ............................................................................................................................................................................III 1. 范围 .......................................................................................................................................................................... 1 2. 规范性引用文件 .................................................................................................................................................. 1 3. 术语、定义和缩略语 ........................................................................................................................................ 1

3.1. 术语、定义 ............................................................................................................................................. 1 3.2. 缩略语 ...................................................................................................................................................... 1 4. 系统介绍 ................................................................................................................................................................ 2 5. 系统结构 ................................................................................................................................................................ 4

5.1. 外部接口 ................................................................................................................................................. 4 5.2. 接口传输承载方式 .............................................................................................................................. 5 6. 上网日志查询交互接口(南向接口) ............................................................................................................ 6

6.1. 消息流程 ................................................................................................................................................. 6 6.2. 接口协议 ................................................................................................................................................. 7

6.2.1. IF_ QUERY(用户信息查询接口) ......................................................... 7

6.2.2. IF_UPLOAD(用户信息上报接口) ......................................................... 7 6.2.3. IF_NOTIFY(用户信息上报完毕通知接口) ...................................... 8 6.3. 接口消息结构 ........................................................................................................................................ 8

6.3.1. 用户信息查询请求消息(UDRQueryRequest) ................................. 8 6.3.2. 用户信息查询响应(UDRQueryResponse)...................................... 9 6.3.3. 用户信息上报完毕通知消息(UDRNotifyRequest) ........................ 10 6.3.4. 用户信息上报完毕通知响应消息(UDRNotifyResponse) ............ 11 6.4. FTP文件格式要求 ........................................................................................................................... 12

6.4.1. 文件编码规则 ................................................................................................ 12 6.4.2. 文件命名规则 ................................................................................................ 12

6.4.2.1. WAP网关话单处理机 .................................................................... 12 6.4.2.2. 网络日志服务器 .............................................................................. 12 6.4.2.3. WLAN Radius服务器 ..................................................................... 13 6.4.3. 文件格式规则 ................................................................................................ 13

6.4.3.1. WAP网关话单处理机 .................................................................... 13 6.4.3.2. 网络日志服务器 .............................................................................. 14 6.4.3.3. WLAN Radius服务器 ..................................................................... 14 6.4.4. 文件生成规则 ................................................................................................ 15 6.5. 异常处理流程 ..................................................................................................................................... 15 7. 绑定关系同步接口 .......................................................................................................................................... 16

7.1. 业务流程 .............................................................................................................................................. 16 7.2. 接口协议 .............................................................................................................................................. 16 7.3. FTP文件格式要求 ........................................................................................................................... 17

7.3.1. 文件编码规则 ................................................................................................ 17 7.3.2. 文件命名规则 ................................................................................................ 17 7.3.3. 文件格式规则 ................................................................................................ 17 7.3.4. 文件生成规则 ................................................................................................ 17

8. 在线查询服务接口(北向接口)............................................................................................................. 18

I

QB-╳╳-╳╳╳-╳╳╳╳

8.1. 消息流程 .............................................................................................................................................. 18 8.2. 接口协议 .............................................................................................................................................. 19

8.2.1. InfoQuery(用户信息查询接口) .................................................... 19 8.2.2. InfoUpload(查询结果响应接口) ................................................. 19 8.2.3. InfoNotify(用户信息查询结果响应完毕通知接口) ........... 20 8.3. 接口消息结构 ..................................................................................................................................... 20

8.3.1. 用户信息查询请求消息(onlinequery) .......................................... 20 8.3.2. 用户信息查询响应(onlinequeryresponse) ................................. 22 8.3.3. 用户信息上报通知消息(onlinenotify) ................................................ 23 8.3.4. 用户信息上传完毕通知响应消息(onlinenotifyresponse) ........... 24 8.4. FTP文件格式要求 ........................................................................................................................... 24

8.4.1. 文件编码规则 ................................................................................................ 24 8.4.2. 文件命名规则 ................................................................................................ 25 8.4.3. 文件格式规则 ................................................................................................ 25 8.4.4. 文件生成规则 ................................................................................................ 25 8.5. 异常处理流程 ..................................................................................................................................... 25 9. 编制历史 ............................................................................................................................................................. 26

II

QB-╳╳-╳╳╳-╳╳╳╳

前 言

本标准规定了用户上网日志查询系统与其他互联网元间的接口规范,是用户上网日志查询系统、WAP网关话单处理机、网络日志服务器、WLAN/二级 Radius服务器以及随e行G3上网笔记本业务自助服务平台需要遵从的技术文件。

本标准主要包括以下几方面内容:系统结构、查询接口的功能、消息流程、消息结构、文件格式、异常处理,以及绑定关系同步接口功能等要求。

本标准是用户上网日志查询系统系列标准之一,该系列标准的结构、名称或预计的名称如下:

序号 [1] 标准编号 标准名称 《用户上网日志查询系统设备规范》 本标准由中移 号文件印发。

本标准由中国移动通信集团计划部提出,集团公司技术部归口。 本标准起草单位:中国移动通信研究院 本标准主要起草人: 柏洪涛、尹瑶瑶、倪伟

III

QB-╳╳-╳╳╳-╳╳╳╳

1. 范围

本标准规定了用户上网日志查询系统与WAP网关、网络日志服务器、WLANRadius服务器、二级Radius服务器以及随e行G3上网笔记本业务自助服务平台间的接口要求,用于为用户上网日志查询系统在设备研制、开发、验证相互间接口使用提供技术依据。原则上在中国移动通信集团公司内部和厂商共同使用,适用于GSM/GPRS/TD-SCDMA网络环境。

2. 规范性引用文件

下列文件中的条款通过本标准的引用而成为本标准的条款。凡是注日期的引用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本标准,然而,鼓励根据本标准达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本标准。

表2-1:术语/定义

序号 标准编号 标准名称 发布单位 [1] 《用户上网日志查询系统中国移动通信集团公司

设备规范》

3. 术语、定义和缩略语

3.1. 术语、定义

表3-1:术语/定义

术语/定义 绑定 去绑定 3.2. 缩略语

表3-2:缩略语 缩略语 APN MSISDN WAP GGSN 英文全称 Access Point Network The Mobile Station ISDN number Wireless Application Protocol Gateway GPRS Support Node 中文含义 接入点网络 移动用户号码 无线应用协议 网关GPRS支持节点 1

解释 将内置卡与具有缴费功能的手机号码建立一一对应关系,并选择一个资费套餐开通内置卡CMTDS上网功能的过程。 解除内置卡与绑定号码间的绑定关系。 QB-╳╳-╳╳╳-╳╳╳╳

CG WLAN Radius Charging Gateway Wireless Local Area Networks Remote Authentication Dial In User Service 计费网关 无线局域网 远程用户验证服务 4. 系统介绍

在全网范围,建设一套用户上网日志查询系统,此系统主要用于为上级查询方提供两类两类上网方式提供上网日志查询服务,使查询方能反查询到用户手机号码或帐号等信息。

1. GSM/GPRS/TD-SCDMA上网(包含CMWAP APN、CMNET APN、CMTDS APN接入) 2. WLAN上网

根据查、存分离设计原则,用户上网日志查询系统不负责存储用户上网日志记录,所有的用户上网日志保存到各业务平台上。因此,用户上网日志查询系统需要能从:

 WAP GW获取用户通过CMWAP APN上网的日志记录

 网络日志服务器获取用户通过CMNET APN上网的日志记录

 网络日志服务器获取用户通过CMTDS APN上网的日志记录,从随e行G3上网笔记本业

务自助服务平台(下文简称上网本平台)获取内置卡和绑定号码的对应关系  WLAN Radius获取用户通过WLAN上网的日志记录

该系统通过CMNET网络与全网的WAP GW、全网的网络日志服务器、Radius服务器、二级Radius服务器,以及上网本平台进行连接,如图4-1所示。该系统根据查询方的查询要求,将查询指令下发到对应业务平台上,由对应的业务平台执行查询动作,将满足查询条件的结果,按照接口要求经CMNET网络返回该系统。

………Wap…图4-1 用户上网日志查询系统在网络中的位置

一、用户上网日志查询系统提供的主要功能  用户日志查询

2

…WLAN Radius…WLANG3 QB-╳╳-╳╳╳-╳╳╳╳

接受查询方的查询请求,根据查询条件,结合静态路由信息,将查询请求分发至下级业务平台,并对下级业务平台返回的查询结果文件进行解析、处理,形成完整的查询结果反馈给查询方。

 绑定关系同步

针对上网本用户,与上网本平台全量和增量同步内置卡号码和付费号码间的绑定关系。

二、上述各业务平台提供主要功能  WAP GW

 话单处理机负责保存CMWAP APN上网日志(仅限Pull日志和Socket日志):匹配

私网上网的PULL话单和防火墙NAT信息、Socket话单和防火墙NAT信息,保存包含公网地址的用户上网PULL日志和Socket日志。  负责向用户日志上网查询系统提供查询接口。  分组域的日志服务器

 负责保存CMNET、CMTDS APN上网日志的方式,且有两种保存方式:

 日志匹配方式:在分组域中部署日志服务器,负责匹配CG话单和防火墙NAT

信息,保存包含公网地址的用户上网日志。  Gn口分光方式:在分组域Gn口部署分光设备,负责旁路用户上网访问请求;

部署采集分析设备,负责对分光后的结果分析用户访问行为,保存用户通过私网地址上网的记录;部署网络日志服务器,负责匹配采集分析设备中的私网上网记录和防火墙NAT信息,保存包含公网地址的用户上网日志。与日志匹配方式相比,Gn口分光方式增加了目的URL等信息。

 负责向用户日志上网查询系统提供查询接口。  WLAN Radius服务器

 负责保存用户通过WLAN使用公网地址上网的日志记录  负责向用户日志上网查询系统提供查询接口。  上网本平台负责

 负责保存上网本内置卡和绑定号码的绑定关系

 负责向用户日志上网查询系统提供绑定关系同步接口。

3

QB-╳╳-╳╳╳-╳╳╳╳

5. 系统结构

图5-1 用户上网日志查询系统接口示意图

5.1. 外部接口

用户上网日志查询系统对外提供两类接口,如图5.1所示。 一、上网日志查询交互接口

位于用户上网日志查询系统与WAP GW、网络日志服务器、WLAN日志服务器、WLANRadius服务器、WLAN二级Radius服务器之间。该接口主要实现用户上网日志相关信息的查询功能。由三组子接口组成:

1. IF_QUERY(用户信息查询接口)

 用于用户上网日志查询系统向下级业务平台发送用户信息查询请求

(UDRQueryRequest),请求中携带查询的入口参数;下级业务平台解析处理后向用户上网日志查询系统返回对应的响应信息(UDRQueryResponse);  通信基于HTTP承载XML的方式,应采用SSL方式保证信息传输安全性。 2. IF_UPLOAD(用户信息上报接口)

 下级业务平台根据查询条件在本地完成查询后,通过该接口实现用户上网

日志数据的上报;

 接口采用基于FTP文件传输协议,应采用SFTP方式保证信息传输安全性; 3. IF_NOTIFY(用户信息上报完毕通知接口)

 下级业务平台依据查询输入完成查询和数据上传之后,通过该接口通知用

户上网日志查询系统结果上传状态时使用,由URDNotifyRequest携带文件

4

QB-╳╳-╳╳╳-╳╳╳╳

相关的上传信息,用户上网日志查询系统基于UDRNotifyResponse提供数据上传响应消息

 接口通讯基于HTTP承载XML的方式,应采用SSL方式保证信息传输安全性。

二、绑定关系同步接口

位于用户上网日志查询系统与上网本平台之间。该接口主要用于同步上网本用户内置卡号码与付费号码之间的绑定关系。接口描述如下:

1. IF_NetBook(绑定关系同步接口)

 用于上网本平台向用户上网日志查询系统同步上网本内置卡与付费号码

之间的绑定关系;

 接口采用FTP协议,可采用SFTP方式保证信息传输安全性。

三、在线查询服务接口

位于用户上网日志查询系统与查询请求系统(下称查询请求方)之间。该接口主要用于接收查询方以Web服务接口提交的查询请求,并返回查询结果。 5.2. 接口传输承载方式

用户上网日志查询系统与下级各业务平台间以及用户上网日志查询系统与外部查询系统间采用CMNET网络的数据传输承载方式,为保证用户上息传输安全性,需要在接口中采用相应的安全技术手段,如采用HTTPS方式及SFTP方式。

5

QB-╳╳-╳╳╳-╳╳╳╳

6. 上网日志查询交互接口(南向接口)

6.1. 消息流程

1.2.3.4.5.

图6-1 上网日志查询交互接口消息流程

流程说明:

1) 用户上网日志查询系统通过IF_QUERY接口,向下级业务平台发起用户信息查询请求,

请求中携带必要的查询入口参数;

2) 下级业务平台接收并解析接收到的用户信息查询请求,构造响应消息返回至用户上

网日志查询系统;

3) 下级业务平台依据查询条件检索本地存储的用户上网日志记录数据,通过

IF_UPLOAD接口,向用户上网日志查询系统上传满足查询条件的用户上网日志文件; 4) 下级业务平台上传完满足查询条件的用户上网日志文件后,通过IF_NOTIFY接口向

用户上网日志查询系统发送用户信息上报完毕通知请求,通知对端已经完成查询操作;

5) 用户上网日志查询系统接收到用户信息上报完毕通知请求后,向下级业务平台返回

响应消息。

6

QB-╳╳-╳╳╳-╳╳╳╳

6.2. 接口协议

6.2.1. IF_ QUERY(用户信息查询接口)

用于用户上网日志查询系统通过IF_QUEREY接口,向下级业务平台发送用户信息查询请求(UDRQueryRequest),请求中携带查询的入口参数;下级业务平台解析处理后向用户上网日志查询系统返回对应的响应信息(UDRQueryResponse)。

该接口基于HTTPS协议,要求HTTP的版本为1.1以上,接口传递的数据以XML的形式进行封装,以HTTP承载XML的方式通信。

接口访问形式为:

Https://Network_Element_IP:Port/IF_QUERY/ 其中:

 Network_Element_IP:标识被接入的下级业务平台提供查询服务的IP地址;  Port:标识被接入下级业务平台提供查询服务的端口号;

 IF_QUERY:标识查询接口的名称,指定本接口为用户信息查询接口;

要求下级业务平台在访问控制白名单中预先配置用户上网日志查询系统的有效IP地址。在接收查询请求时,需对请求消息的源IP地址进行合法性判断,满足访问控制白名单内的源IP地址予以查询处理和应答;对于源IP地址不在访问控制白名单内的查询请求,要求下级业务平台不进行查询处理和应答,以保证用户上网日志数据的安全性。

6.2.2.

IF_UPLOAD(用户信息上报接口)

下级业务平台通过IF_UPLOAD接口,向用户上网日志查询系统上报满足查询条件的用户日志数据。

接口基于FTP协议。下级业务平台作为FTP Client,用户上网日志查询系统开启FTP Server功能。接口访问URL形式为

FTP://UserLog_Platform_IP:Port/IF_UPLOAD/ServiceType/ 其中:

 Userlog_Platform_IP:标识用户上网日志查询系统提供用户上网日志数据上传服

务的IP地址;

 Port:标识用户上网日志查询系统提供用户上网日志数据上传服务的端口号;  IF_UPLOAD:标识查询接口的名称,指定本接口为用户信息上报接口;  ServiceType:标识上传数据来源的业务系统,需要根据不同的业务系统进行区分,

其取值如下:

 WAP_GW: 表明此路径下为WAP网关上报的数据

 PS_Log_Server:表明此路径下为GPRS网络日志服务器上报的数据  WLAN_Radius:表明此路径下为WLAN Radius服务器上报的数据

在发起上传操作之前,下级业务平台应通过系统分配的用户名、密码登录用户上网日志查询系统的FTP服务器。

7

QB-╳╳-╳╳╳-╳╳╳╳

6.2.3.

IF_NOTIFY(用户信息上报完毕通知接口)

下级业务平台通过IF_UPLOAD接口,向用户上网日志查询系统上传完满足查询条件的用户信息后,需基于IF_NOTIFY接口发送用户信息上报完毕通知消息(UDRNotifyRequest)通知用户上网日志查询系统用户数据的上传状态,通知消息中携带相关参数,用户上网日志查询系统向下级业务平台返回对应用户信息上报完毕通知响应(UDRNotifyResponse)。

该接口采用基于HTTPS协议,要求HTTP的版本为1.1以上,接口传递的数据以XML的形式进行封装,以HTTP承载XML的方式通信。

接口访问形式为:

Https://UserLog_Platform_IP:Port/IF_NOTIFY/ 其中

 Userlog_Platform_IP:标识用户上网日志查询系统提供接收上报完毕通知消息的

IP地址;

 Port:标识用户上网日志查询系统提供接收上报完毕通知消息的端口号;

 IF_NOTIFY:标识查询接口的名称,指定本接口为用户信息上报完毕通知接口。 6.3. 接口消息结构

6.3.1. 用户信息查询请求消息(UDRQueryRequest)

UDRQueryRequest消息的协议数据单元(PDU)由消息头(Header)和消息体(body)组成,其中消息头满足标准HTTP1.1协议的HTTP Header要求。

UDRQueryRequest消息的XML Schema如下:

8

QB-╳╳-╳╳╳-╳╳╳╳

UDRQueryRequest消息字段定义如下所示:

表6-1 UDRQueryRequest消息字段定义 字段名 类型 约束 说明 查询请求的序列号标识,由用户上网日志查询系统生成,格式为 yyyy-mm-dd-hh-mi-ss-nnnnn 其中nnnnn标识位的序号,由00000起始依次递增 用户访问外部网站时使用的公网IP地址 对于GPRS、WAP用户上网记录查询为可选 对于其他用户上网记录查询为必选 用户访问外部网站时使用的端口号 对于WLAN用户上网记录查询为可选 对于其他用户上网记录查询为必选 查询起始时间,格式为 yyyy-mm-dd-hh-mi-ss 查询结束时间,格式为 yyyy-mm-dd-hh-mi-ss 用户访问的目标网站URL 仅限对WAP GW保存的Pull日志和Gn口分光方式保存的分组域日志,支持目的URL查询 对于WLAN用户上网记录查询为可选 用户访问的目标网站IP地址 对于WLAN用户上网记录查询为可选 用户访问的目标网站端口号 对于WLAN用户上网记录查询为可选 被查询用户的手机号码 对于WLAN用户上网记录查询为可选 EventID xsd:string 必选 SourceIP xsd:string 可选 SourcePort xsd:string 可选 StartTime Endtime xsd:string xsd:string 必选 必选 DestinationURL xsd:string 可选 DestinationIP DestinationPort MSISDN xsd:string xsd:string xsd:string 可选 可选 可选 6.3.2.

用户信息查询响应(UDRQueryResponse)

UDRQueryResponse消息的XML Schema如下。 9

QB-╳╳-╳╳╳-╳╳╳╳

UDRQueryResponse消息字段定义如下所示:

表6-2 UDRQueryResponse消息字段定义 字段名 类型 约束 说明 查询请求的序列号标识,由”用户上网日志查询系统”生成,格式为 yyyy-mm-dd-hh-mi-ss-nnnnn 其中nnnnn标识5位的序号,由00000起始依次递增 用户查询信息接收结果: 00:查询条件正确; 01:查询条件错误; 02:解析错误; 03:系统繁忙; 04:其他 EventID xsd:string 必选 AcceptResult xsd:string 必选 6.3.3.

用户信息上报完毕通知消息(UDRNotifyRequest)

UDRNotifyRequest消息的XML Schema如下。

10

QB-╳╳-╳╳╳-╳╳╳╳

UDRNotifyRequest消息字段定义如下所示:

表6-3 UDRNotifyRequest消息字段定义 字段名 类型 约束 说明 查询请求的序列号标识,由用户上网日志查询系统生成,格式为 yyyy-mm-dd-hh- mi-ss-nnnnn 其中nnnnn标识5位的序号,由00000起始依次递增 用户信息查询结果: 00:查询到满足查询条件的用户信息,用户信息上传完毕; 01:未查询到满足查询条件的用户信息; 02:上传失败; 03:其他 仅在SearchResult=00时生效,表示查询所有文件中用户信息记录的条数; 仅在SearchResult=00时生效,表示返回的文件数目; 下级业务平台向用户上网日志查询系统上传用户数据的路径, 仅在SearchResult=00时生效,包含服务器绝对路径、文件名等信息,例如FTP://UserLog_Platform_IP:port/IF_UPLOAD/ServiceType/XXXX,XXXX为文件名 该文件名不包含序列号SEQ。 EventID xsd:string 必选 SearchResult xsd:string 必选 RecordNumber FileNumber xsd:string xsd:string 可选 可选 FTPPath xsd:string 可选

6.3.4.

用户信息上报完毕通知响应消息(UDRNotifyResponse)

UDRNotifyResponse消息的XML Schema如下。

11

QB-╳╳-╳╳╳-╳╳╳╳

UDRNotifyResponse消息字段定义如下所示:

表6-4 UDRNotifyResponse消息字段定义 字段名 类型 约束 说明 查询请求的序列号标识,由”用户上网日志查询系统”生成,格式为 yyyy-mm-dd-hh-mi-ss-nnnnn 其中nnnnn标识5位的序号,由00000起始依次递增 用户上网日志查询系统处理下级业务平台返回的通知消息的结果: 00:成功; 01:失败; EventID xsd:string 必选 NotifyResult xsd:string 必选

6.4. FTP文件格式要求

6.4.1. 文件编码规则

用户上网日志文件基于文本文件,文件编码格式统一为UTF-8。 6.4.2.

文件命名规则

6.4.2.1. WAP网关话单处理机

用户上网日志文件需命名为WAPGW_EventID.SEQ:

表6-5 WAP网关上报用户上网日志文件命名规则 字段名 WAPGW EventID SEQ

说明 代表用户信息上报来源为WAP网关,固定值为WAPGW。 代表用户上网日志查询系统查询的序列号标识,对应用户信息查询请求消息中的EventID字段。 描述同一个查询返回的文件顺序号,若查询结果被分割成多个文件则其流水号必须不同,并且从001依次递增,如: 001、002、003; 6.4.2.2. 网络日志服务器

用户上网日志文件需命名为PSLogServer_EventID.SEQ:

表6-6 网络日志服务器上报用户上网日志文件命名规则 字段名 EventID 说明 代表用户上网日志查询系统查询的序列号标识,对应“用户信息查询请求消12

PSLogServer 代表用户信息上报来源为网络日志服务器,固定值为PSLogServer。 QB-╳╳-╳╳╳-╳╳╳╳

息”中的EventID字段。 SEQ

描述同一个查询返回的文件顺序号,若查询结果被分割成多个文件则其流水号必须不同,并且从001依次递增,如: 001、002、003; 6.4.2.3. WLAN Radius服务器

用户上网日志文件命名为WLAN_Radius_EventID.SEQ,各字段说明如下:

表6-7 WLAN Radius服务器上报用户上网日志文件命名规则 字段名 说明 代表用户上网日志查询系统查询的序列号标识,对应用户信息查询请求消息中的EventID字段。 描述同一个查询返回的文件顺序号,若查询结果被分割成多个文件则其流水号必须不同,并且从001依次递增,如: 001、002、003; WLAN_Radius 代表用户信息上报来源为WLAN Radius服务器,固定值为WLAN_Radius。 EventID SEQ 6.4.3.

文件格式规则

用户上网日志文件的格式与文本数据库相类似:以行区分不同记录,即一行代表一条用户的记录;各字段之间以符号“|”分隔各列,代表不同的域。

数据格式例如:

StartTime|EndTime|MsId|NAT_ClientIP|NAT_ClientPort|DestinationURL| DestinationIP|DestinationPort|ClientMAC|ClientIP|ClientPort|ApId|APN

针对不同下级业务平台,FTP文件内字段信息如下: 6.4.3.1. WAP网关话单处理机

表6-8 WAP网关上报的用户上网日志文件格式规则

字段名 说明 表示用户上网记录的起始时间,格式为 Yyyymmddhhmiss(24小时制)。 注:对于浏览类业务,该时间为WAP网关代理用户访问SP的时间。 表示用户上网记录的结束时间,格式为 yyyymmddhhmiss(24小时制)。 注:对于浏览类业务,该时间为WAP网关收到SP响应的时间。 表示用户手机号码,即Msisdn。 源公网IP StartTime EndTime MsId NAT_CleintIP NAT_CleintPort 源公网Port 13

QB-╳╳-╳╳╳-╳╳╳╳

DestinationURL 表示用户访问的目标网站的URL。 DestinationIP ClientMAC ClientIP ClientPort ApId APN 表示用户访问的目标网站的IP地址。 为空 表示GGSN为终端分配的私网IP地址。 为空。 为空 CMWAP DestinationPort 表示用户访问的目标网站的端口号。 注:对于DestinationURL和DestinationIP字段,应至少填写二者之一。 6.4.3.2. 网络日志服务器

表6-9 网络日志服务器上报的用户上网日志文件格式规则 字段名 StartTime EndTime MsId NAT_CleintIP 说明 表示用户访问SP的时间,格式为 Yyyymmddhhmiss(24小时制)。 表示用户收到SP响应的时间,格式为 Yyyymmddhhmiss(24小时制)。 表示用户手机号码MSISDN。 源公网IP NAT_CleintPort 源公网Port DestinationURL 表示用户访问的目标网站的URL。 DestinationIP ClientMAC ClientIP ClientPort ApId APN 表示用户访问的目标网站的IP地址。 为空 表示GGSN为终端分配的私网IP地址。 表示防火墙NAT转换前的终端私网Port。 为空 接入的APN信息,如CMNET、CMTDS DestinationPort 表示用户访问的目标网站的端口号。

注:对于DestinationURL,仅当采用Gn口分光方式实现用户上网日志保存时,该字段非空;当采用日志匹配方式,该字段填空。 6.4.3.3. WLAN Radius服务器

表6-10 WLAN Radius服务器上报的用户上网日志文件格式规则 字段名 StartTime EndTime MsId 说明 表示用户上线时间,格式为 Yyyymmddhhmiss(24小时制)。 表示用户下线时间,格式为 Yyyymmddhhmiss(24小时制)。 表示用户手机号码MSISDN或WLAN上网账号。 14

QB-╳╳-╳╳╳-╳╳╳╳

NAT_CleintIP 为空 NAT_CleintPort 为空 DestinationURL 表示用户访问的目标网站的URL,为空 DestinationIP ClientMAC ClientIP ClientPort APid APN 6.4.4.

文件生成规则

表示用户访问的目标网站的IP地址,为空 无线网卡MAC地址,为空 WLAN AC为终端分配的公网IP地址 为空。 AP设备标识,为空 为空。 DestinationPort 表示用户访问的目标网站的端口号,为空 下级业务平台在向用户上网日志查询系统上报用户上网日志文件时,文件可根据配置的文件大小门限或记录条数触发产生。即文件可以按照记录条数、预设的文件大小触发,例如5000条记录生成一个用户上网日志文件,或数据文件超过2M时生成一个用户上网日志文件。

要求文件大小门限和记录条数可根据需求灵活配置。 上网日志文件在上传之前须进行压缩,压缩格式为gzip。 6.5. 异常处理流程

当用户上网日志查询系统通过IF_QUERY接口向下级业务平台发送UDRQueryRequest消息后,如果达到超时时间阈值但仍未收到UDRQueryResponse消息,则用户上网日志查询系统需启动异常处理机制,再次发送UDRQueryRequest消息。如果超过3次均未收到UDRQueryRequest,则结束异常处理流程,保存异常日志并发出告警信息。

当用户上网日志查询通过IF_QUERY接口向下级业务平台系统发送UDRQueryRequest请求后收到UDRQueryResponse响应,但如果达到超时时间阈值但仍未在IF_ NOTIFY接口收到业务平台发送的UDRNotifyRequest消息,则用户上网日志查询系统需启动异常处理机制,在IF_UPLOAD接口检查上传路径,是否有该业务平台新上传的查询结果文件,若有查询结果文件,则认为该业务平台已返回查询结果,但未收到上报完毕通知消息,结束异常处理流程,系统保存异常日志并发出告警信息,并将查询结果处理后返回给查询方。若没有查询结果文件,该系统需启动异常处理机制,通过IF_QUERY接口再次发送UDRQueryRequest消息,如果超过3次仍未收到查询响应消息,则结束异常处理流程,系统保存异常日志并发出告警信息。

当下级业务平台通过IF_NOTIFY接口向用户上网日志查询系统发送UDRNotifyRequest消息后,如果达到超时时间阈值但仍未收到UDRNotifyResponse消息,则下级业务平台需启动异常处理机制,再次发送UDRNotifyRequest消息。如果超过3次均未收到UDRNotifyResponse,则结束异常处理流程,保存异常日志并发出告警信息。

15

QB-╳╳-╳╳╳-╳╳╳╳

7. 绑定关系同步接口

7.1. 业务流程

绑绑绑绑绑绑绑绑绑绑绑绑绑绑绑绑绑绑绑绑绑IF_NETBOOK绑绑绑绑绑绑绑绑绑 绑绑绑绑绑绑绑绑绑FTP绑绑绑 绑绑绑绑绑绑绑绑绑FTP绑绑绑图7-1 绑定关系同步接口消息流程

流程说明:

1. 用户上网日志查询系统与上网本平台首次对接时,上网本平台通过向用户上网日志

查询系统全量上报上网本用户绑定数据文件;

2. 正常连接状态下,上网本平台根据预先配置的同步周期增量的将更新的用户绑定关

系数据上报至用户上网日志查询系统。 7.2. 接口协议

IF_NetBook是上网本平台与用户上网日志查询系统之间的绑定关系数据同步接口。上网本平台通过此接口向用户上网日志查询系统上报上网本用户的绑定关系数据。

该接口基于SFTP协议。上网本平台作为FTP Client,用户上网日志查询系统开启FTP Server功能。接口访问URL形式为

FTP://UserLog_Platform_IP:port/IF_NETBOOK/NETBook/ 其中:

   

Userlog_Platform_IP:标识用户上网日志查询系统提供上传绑定信息的IP地址; Port:标识用户上网日志查询系统提供上传绑定信息的端口号; IF_NETBOOK:标识绑定关系接口;

NetBook:标识上传数据来源的业务系统为上网本平台。

在发起上传操作之前,上网本平台应以系统分配的为用户名、密码登录用户上网日志查询系统的FTP服务器。

16

QB-╳╳-╳╳╳-╳╳╳╳

7.3. FTP文件格式要求

7.3.1. 文件编码规则

用户上网日志文件基于文本文件,文件编码格式统一为UTF-8。 7.3.2.

文件命名规则

用户绑定数据文件命名规则为: NetBook_EventID.SEQ,其中:  NetBook:标识文件内容为上网本平台上报的用户绑定关系数据,固定值为NetBook;  EventID:标识上报操作的序列号标识,由上网本平台依据每次上报操作和时间和

顺序产生,格式为yyyymmddhhmissnnn,其中nnn标识3位的序号,由000起始依次递增;

 SEQ:标识文件后缀, 描述上网本平台向查询系统返回的绑定关系文件顺序号,若

绑定关系被分割成多个文件则其流水号必须不同,并且从001依次递增,如: 001、002、003; 7.3.3.

文件格式规则

在用户绑定关系文件中,一个用户的所有数据字段作为一条记录占一行,各字段之间采用|分割,代表不同的域。两条用户信息记录之间采用回车、换行符分隔。

文件内容格式要求如下:

OperationTime|USIMMsisdn|BindingMsisdn|OperationFlag

表7-1 上网本平台同步的绑定关系文件格式规则 字段名 OperationTime USIMMsisdn BindingMsisdn 说明 用户进行绑定和去绑定等操作的时间,格式为: yyyymmddhhmiss 上网本内置的USIM卡号码 用户绑定的付费手机号码 标示该条绑定关系记录的属性,定义如下: 00:新增绑定关系记录 01:删除绑定关系记录 其它:暂时保留 OperationFlag

首次对接、绑定数据上报时所有绑定关系记录的OperationFlag属性均填写为00,标识为新增的绑定关系记录。 7.3.4.

文件生成规则

上网本平台向用户上网日志查询系统上报用户上网日志文件时,文件可根据配置的文件大小门限或记录条数触发产生。即文件可以按照记录条数、预设的文件大小触发,例如5000条记录生成一个用户绑定关系文件,或数据文件超过2M时生成一个用户绑定关系文件。

17

QB-╳╳-╳╳╳-╳╳╳╳

要求文件大小门限和记录条数可根据需求灵活配置。

用户绑定关系文件在上传之前须进行压缩,压缩格式为gzip。

8. 在线查询服务接口(北向接口)

该接口用于用户上网日志查询系统对外提供基于HTTP的用户上网日志查询服务,查询方(如各省客服/网投系统、手机恶意软件监测系统、IDC安全监控系统等)可通过该接口向用户上网日志查询系统发送查询请求,及接收用户上网日志查询系统返回的查询结果。 8.1. 消息流程

用户上网日志在线查询服务流程如图8-1所示:

1.2.3.4.5.

图8-1 上网日志查询交互接口消息流程

流程说明:

1) 用户上网日志查询请求方通过InfoQuery接口,向用户上网日志查询系统发起用户

信息查询请求,请求中携带必要的查询入口参数;

2) 用户上网日志查询系统接收并解析接收到的用户信息查询请求,构造响应消息返回

至用户上网日志查询请求方;

3) 用户上网日志查询系统依据查询条件向下级各日志服务器下发用户上网日志查询

指令,并接收到查询相应文件后,通过InfoUpload接口,向用户上网日志查询请求方上传满足查询条件的用户上网日志文件;

18

QB-╳╳-╳╳╳-╳╳╳╳

4) 用户上网日志查询系统上传完满足查询条件的用户上网日志文件后,通过

InfoNotify接口向用户上网日志查询请求方发送用户信息上传完毕通知请求,通知用户上网日志查询请求方已经完成查询操作;

5) 用户上网日志查询请求方接收到用户信息上传完毕通知请求后,向用户上网日志查

询系统返回响应消息。 8.2. 接口协议

8.2.1. InfoQuery(用户信息查询接口)

用户上网日志在线查询请求方通过InfoQuery接口,向用户上网日志查询系统发送用户上网日志查询请求(onlinequery),请求中携带查询的入口参数;用户上网日志查询系统解析处理后向用户上网日志在线查询请求方返回对应的响应信息(onlinequeryresponse)。

该接口基于加密的HTTPS协议,要求HTTP的版本为1.1以上,接口传递的数据以XML的形式进行封装,以HTTP承载XML的方式通信。

接口访问形式为:

Https://Network_Element_IP:Port/InfoQuery?sign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX×tamp=YYYY-MM-DD+HH%3AMM%3ASS&v=1.0

其中:

 Network_Element_IP:标识用户上网日志查询系统提供查询服务的IP地址;  Port:标识用户上网日志查询系统提供查询服务的端口号;

 InfoQuery:标识查询接口的名称,指定本接口为用户信息查询接口;  timestamp:标识接口调用时间戳,格式为yyyy-mm-dd HH:mm:ss;  v:标识在线查询服务接口版本,现阶段取值1.0;

 sign:查询请求方基于timestamp、v等参数以及由用户上网日志查询系统分配的

securekey,通过SHA256算法加密,并将加密结果转换成16进制大写字母表示的签名值。具体计算方法见《用户上网日志查询系统设备规范v1.0.5》5.5节。 8.2.2.

InfoUpload(查询结果响应接口)

用户上网日志查询系统通过InfoUpload接口,向用户上网日志在线查询请求方上报满足查询条件的用户日志数据。

接口基于FTP协议。用户上网日志查询系统作为FTP Client,用户上网日志在线查询请求方开启FTP Server功能。接口访问URL形式为

FTP://UserLog_Platform_IP:Port/InfoUpload/ 其中:

 Userlog_Platform_IP:标识用户上网日志查询系统提供用户上网日志数据上传服

务的IP地址;

 Port:标识用户上网日志查询系统提供用户上网日志数据上传服务的端口号;  InfoUpload:标识查询接口的名称,指定本接口为用户信息上传接口;

19

QB-╳╳-╳╳╳-╳╳╳╳

在发起上传操作之前,用户上网日志查询系统应通过用户上网日志在线查询请求方FTP服务分配的用户名、密码登录用户上网日志在线查询请求方的FTP服务器。 8.2.3.

InfoNotify(用户信息查询结果响应完毕通知接口)

用户上网日志查询系统查询到相应的数据后,需基于InfoNotify接口将结果信息发送到用户上网日志在线查询请求方,消息中携带相关参数。用户上网日志在线查询请求方接收到查询结果后,向用户上网日志查询系统返回对应用户信息查询结果接收响应。

该接口采用基于加密的HTTPS协议,要求HTTP的版本为1.1以上,接口传递的数据以XML的形式进行封装,以双向认证HTTPS承载XML的方式通信。

接口访问形式为:

https://UserLog_Platform_IP:Port/InfoNotify/ 其中

 Userlog_Platform_IP:标识查询方提供接收上报通知消息的IP地址;  Port:标识查询方提供接收上报完毕通知消息的端口号;

 InfoNotify:标识查询接口的名称,指定本接口为用户信息上报通知接口。 8.3. 接口消息结构

8.3.1. 用户信息查询请求消息(onlinequery)

onlinequery消息的协议数据单元(PDU)由消息头(Header)和消息体(body)组成,其中消息头满足标准HTTP1.1协议的HTTP Header要求。

onlinequery消息的XML Schema如下:

20

QB-╳╳-╳╳╳-╳╳╳╳

onlinequery消息字段定义如下所示:

表8-1 onlinequery消息字段定义 字段名 类型 约束 说明 查询请求的序列号标识,由用户上网日志查询系统生成,格式为 yyyy-mm-dd-hh-mi-ss-nnnnn 其中nnnnn标识位的序号,由00000起始依次递增 省份标识ID,可参考附录 省份代码表。 对于IDC日志查询为必选填写,其他情况不填写。 日志类型ID,标识该查询指令是否是IDC访问日志查询指令。访问日志查询指令为11,日志定时查询指令为10。 对于IDC日志查询为必选填写,其他情况不填写。 电信管理部门颁发的IDC/ISP许可证号。对于IDC日志查询为必选填写,其他情况不填写。 目标机房ID,由IDC/ISP经营者产生,在本单位中唯一。 对于IDC日志查询为必选填写,其他情况不填写。 用户访问外部网站时使用的公网IP地址 对于GPRS、WAP用户上网记录查询为可选 对于其他用户上网记录查询为必选 用户访问外部网站时使用的端口号 对于WLAN用户上网记录查询为可选 对于其他用户上网记录查询为必选 查询起始时间,格式为 yyyy-mm-dd-hh-mi-ss 查询结束时间,格式为 yyyy-mm-dd-hh-mi-ss 用户访问的目标网站URL 仅限对WAP GW保存的Pull日志和Gn口分光方式保存的分组域日志,支持目的URL查21

EventID xsd:string 必选 provID string 必填 typeID string 必填 idcID xsd:string 可选 houseID xsd:string 可选 SourceIP xsd:string 可选 SourcePort xsd:string 可选 StartTime Endtime xsd:string xsd:string 必选 必选 DestinationURL xsd:string 可选 QB-╳╳-╳╳╳-╳╳╳╳

询 对于WLAN用户上网记录查询为可选 DestinationIP DestinationPort MSISDN xsd:string xsd:string xsd:string 可选 可选 可选 用户访问的目标网站IP地址 对于WLAN用户上网记录查询为可选 用户访问的目标网站端口号 对于WLAN用户上网记录查询为可选 被查询用户的手机号码 对于WLAN用户上网记录查询为可选 注:1、开始时间和结束时间间隔最大为1小时,大于1小时则响应相对应的错误码。 8.3.2.

用户信息查询响应(onlinequeryresponse)

onlinequeryresponse消息的XML Schema如下。

onlinequeryresponse消息字段定义如下所示: 表8-2 onlinequeryresponse消息字段定义 字段名 类型 约束 说明 查询请求的序列号标识,由网络投诉支撑系统生成,格式为 EventID xsd:string 必选 yyyy-mm-dd-hh-mi-ss-nnnnn 其中nnnnn标识5位的序号,由00000起始依次递增 用户查询信息接收结果: 00:查询条件正确; 01:查询条件错误; 02:解析错误; 03:系统繁忙; 04:查询时间段过大,请修改; 05:系统容量已满,请稍后再查; 06:其它 AcceptResult xsd:string 必选

22

QB-╳╳-╳╳╳-╳╳╳╳

8.3.3.

用户信息上报通知消息(onlinenotify)

onlinenotify消息的XML Schema如下:

onlinenotify消息字段定义如下所示:

表8-3 onlinenotifyRequest消息字段定义

字段名 类型 约束 说明 查询请求的序列号标识,由网络投诉支撑系统,格式为 yyyy-mm-dd-hh- mi-ss-nnnnn 其中nnnnn标识5位的序号,由00000起始依次递增 用户信息查询结果: 00:查询到满足查询条件的用户信息,用户信息上传完毕; 01:未查询到满足查询条件的用户信息; 02:上传失败; 03:其他 仅在SearchResult=00时生效,表示查询所有文件中用户信息记录的条数; 仅在SearchResult=00时生效,表示返回的文件数目; 用户上网日志查询系统向网络投诉支撑系统上传用户数据的路径, 仅在23

EventID xsd:string 必选 SearchResult xsd:string 必选 RecordNumber FileNumber FTPPath xsd:string xsd:string xsd:string 可选 可选 可选 QB-╳╳-╳╳╳-╳╳╳╳

SearchResult=00时生效,包含服务器绝对路径、文件名等信息,例如FTP://UserLog_Platform_IP:port/IfUpload/XXXX,XXXX为文件名,该文件名不包含序列号SEQ。 8.3.4.

用户信息上传完毕通知响应消息(onlinenotifyresponse)

onlinenotifyresponse消息的XML Schema如下。

onlinenotifyresponse消息字段定义如下所示:

表8-4 onlinenotifyresponse消息字段定义 字段名 类型 约束 说明 查询请求的序列号标识,由“网络投诉支撑系统”生成,格式为 yyyy-mm-dd-hh-mi-ss-nnnnn 其中nnnnn标识5位的序号,由00000起始依次递增 网络投诉支撑系统处理用户上网日志查询系统返回的通知消息的结果: 00:成功; 01:失败; EventID xsd:string 必选 NotifyResult xsd:string 必选

8.4. FTP文件格式要求

8.4.1. 文件编码规则

用户上网日志查询响应文件基于文本文件,文件编码格式统一为UTF-8。

24

QB-╳╳-╳╳╳-╳╳╳╳

8.4.2.

文件命名规则

用户上网日志文件需命名为EventID.SEQ.txt:

表8-5 用户上网日志查询响应文件命名规则 字段名 EventID SEQ 说明 代表用户上网日志在线查询请求方查询的序列号标识,对应用户信息查询请求消息中的EventID字段。 描述同一个查询返回的文件顺序号,若查询结果被分割成多个文件则其流水号必须不同,并且从001依次递增,如: 001、002、003;

8.4.3.

文件格式规则

用户上网日志查询响应文件的格式与文本数据库相类似:以行区分不同记录,即一行代表一条用户的记录;各字段之间以符号“|”分隔各列,代表不同的域。

数据格式例如:

EventID|provID|typeID|idcID|houseID|StartTime|EndTime|MsId|NAT_ClientIP|NAT_ClientPort|DestinationURL|

DestinationIP|DestinationPort|ClientMAC|ClientIP|ClientPort|ApId|APN|Type

其中,EventID、provID、typeID、idcID、houseID等5个字段,仅当IDC日志查询时存在,其他情况下无该5个字段。

8.4.4.

文件生成规则

用户上网日志查询系统在向用户上网日志在线查询请求方上报用户上网日志文件时,文件可根据配置的文件大小门限或记录条数触发产生。即文件可以按照记录条数、预设的文件大小触发,例如5000条记录生成一个用户上网日志文件,或数据文件超过2M时生成一个用户上网日志文件。

要求文件大小门限和记录条数可根据需求灵活配置。

上网日志查询响应文件在上传之前须进行压缩,压缩格式为gzip。

8.5. 异常处理流程

当用户上网日志在线查询请求方通过InfoQuery接口向用户上网日志查询系统发送onlinequery消息后,如果达到超时时间阈值但仍未收到onlinequeryresponse消息,则用户上网日志在线查询请求方需启动异常处理机制,再次发送onlinequery消息。如果超过3次均未收到onlinequeryresponse,则结束异常处理流程,保存异常日志并发出告警信息。

当网络投诉支撑系统通过InfoQuery接口向用户上网日志查询系统发送onlinequery请求后收到onlinequeryresponse响应,但如果达到超时时间阈值但仍未在InfoNotify接口收到用户上网日志查询系统发送的onlinenotifyrequest消息,则网络投诉支撑系统需启动异常处理机制,在InfoUpload接口检查上传路径,是否有用户上网日志查询系统新上传的查询

25

QB-╳╳-╳╳╳-╳╳╳╳

结果文件,若有查询结果文件,则认为用户上网日志查询系统已返回查询结果,但未收到上报完毕通知消息,结束异常处理流程,系统保存异常日志并发出告警信息,并将查询结果处理后返回给查询方。若没有查询结果文件,该系统需启动异常处理机制,通过InfoQuery接口再次发送onlinequery消息,如果超过3次仍未收到查询响应消息,则结束异常处理流程,系统保存异常日志并发出告警信息。

当用户上网日志查询系统通过InfoNotify接口向网络投诉支撑系统发送onlinenotify消息后,如果达到超时时间阈值但仍未收到onlinenotifyresponse消息,则用户上网日志查询系统需启动异常处理机制,再次发送onlinenotify消息。如果超过3次均未收到onlinenotifyresponse,则结束异常处理流程,保存异常日志并发出告警信息。

9. 编制历史

版本号 1.0.0 1.0.1 更新时间 2010-05-05 2011-03-23 主要内容或重大修改 完成V1.0.0版本 6.3.1 用户信息查询请求中新增MDN查询条件的数据类型和XML元素名称等信息 1.0.2 2011-04-11 1. 修改图4-1,增加在线查询服务接口; 2. 修改图5-1,增加在线查询服务接口; 3. 5.2节,新增在线查询服务接口描述; 4. 新增第8章,手机病毒管控平台与查询平台的接口描述。 1. 新增在线查询服务接口,为省公司提供在线查询服务。 1. 修订在线查询服务接口,增加接口调用的授权控制; 2. 基于IDC需求,增加IDC日志查询条件。 1.0.3 1.0.5 2012-09-28 2013-07-01 26

因篇幅问题不能全部显示,请点此查看更多更全内容

Copyright © 2019- 7swz.com 版权所有 赣ICP备2024042798号-8

违法及侵权请联系:TEL:199 18 7713 E-MAIL:2724546146@qq.com

本站由北京市万商天勤律师事务所王兴未律师提供法律服务