5G基站自动开通网管接口功能技术要求

15G基站自动开通网管接口功能技术要求本文件规定了5G基站自动开通网管接口需求、接口分析、接口设计以及所使用的通信协议本文件适用于OMC系统5G基站自动化开通功能的设计和实现。2规范性引用文件本文件没有规范性引用文件3术语和定义下列缩略语适用于本文件。A0S基站白动开通系统AutomaticOpenNS网络管理系统NetworkMonngsmentSysREST表述性状态传递RepresentationalStateTra5.接口概述5G基站自动开通接口是A0S(基站自动开通系统)与oMC(操作维护中心)之间的接口，A0S通过该接口与0MC交互，触发ONC自动完成5G基站的开通。接口架构如图1所示。图1接口架构图6接口需求6.1自动开站流程5G基站自动开通接口以自动化开通5G基站为目标，实现开站流程自动化。本文件定义的开站流程范围是从获取开站数据文件开始，A0S将开站数据文件下发到0MC,经过开站数据制作、开站命令执行和基站自检操作，最后以自检完成通知标识结束。接口功能主要包括开站数据的制作、开站命令执行和基站自检三部分。开站主要流程如图2所示YD/T202×—xxxx图250基站开通流程图3YD/Txxxxxxxxa)登录：AOS登录OMC,为了实现A0S对OMC系统的访问，需要通过0MC系统的认证并获取相关鉴权凭证；b)创建开站任务：A0S发起创建开站任务的指令，获取到任务标识；c)创建通知订购：A0S向OWC订购本次开站任务相关的通知；d)下发文件：AOS将开站相关数据文件下发至0MC。该环节需在启动数据制作前完成；与创建开站任务和订购通知操作之间无时序要求5G开站执行阶段主要包括数据制作、开站指令执行以及基站自检等三个环节，具体流程如下；a)开站数据制作；A0S触发0MC启动开站数据制作b)制作完成通知：ONC完成数据制作后向A0S上报制作完成通知c)创建网元：OMC创建、纳管网元。该接口有两种实现方式：1)c.1,A0S触发ONC创建网元，实现OMC与网元建链2)c.2,OMC无需A0S触发，自动和网元建链为了最大程度保证开站指令执行的成功率，原则上该环节应确保在开站命令执行环节开始前触发；另一方面，该环节与制作数据环节没有时序要求。d)开站命令执行：A0S触发OMC执行开站命令，该环节无需待创建网元过程完成后触发。o)开站命令执行完成通知：开站命令执行完成后0MC向A0S上报完成通知0基站自检；A0S触发OMC启动基站自检g)自检完成通知：自检完成后ONC向A0S上报完成通知5G开站收尾阶段主要包括：a)删除通知订购：删除之前A0S关于该开站任务对OMC所有相关通知；b)退出；A0S调用退出接口，成功后，accessToken将失效，即A0S将无法利用该accessToken访问相关权限的开站功能接口。除上述流程中涉及的接口功能外，还有以下辅助功能需求(以下功能接口均可以在整个开站过程中任意时刻调用):a)查询开站并发数：A0S获取OMC当前并发处理基站开通任务的能力b)查询通知订阅：A0S查询当前OMC上仍然生效的通知详细信息。该功能属于通知管理配套要求，与创建通知订购和刷除通知订购均有关。c)握手：A0S在登录时获取的OMC的凭证(accessToken)有一定时间限制，如果A0S和OMC之间没有任何操作时长超过上述时限，accessToken会自动失效。如果需要继续使用该accessToken,应在失效前执行握手操作，因此，在开站过程中，A0S会多次调用握手接口确保该接口的可用性。6.2批量开站要求OMC北向接口应支持批量开站并且具备同时对至少10个基站进行开站操作的能力。7.1通用接口AOS通过该接口实现与OWC间的登录、退出和握手功能。认证流程如图3所示。45YD/Txxxxxxxx7.2业务接口创建开站任务接口提供创建开站任务的接口。A0S调用该接口触发OWC创建开站任务，OMC实现一个开站任务管理、关联开站数据制作、开站命令执行和基站自检三个开站子流程，具备多个开站任务并发处理能力。开站数据制作接口提供开站数据制作接口。A0S调用该接口触发ONC启动开站数据制作操作，ONC自动根据开站数据文件生成基站可执行的开站命令数据，并进行数据合法性校验、约束性检测。查询制作进度接口提供查询数据制作进度接口。开站数据制作比较耗时，数据制作过程中需要查询进度，A0S调用该接口向OMC查询操作数据制作进度，0MC返回开站数据制作中所有网元开站数据制作总进度以及每个网元的开站数据制作进度制作完成通知接口提供OMC主动向A0S上报数据制作完成通知的接口。OMC根据开站数据文件生成基站可执行的开站命令数据，并对数据合法性校验、约束性检测完成后自动触发OMC向A0S上报制作完成通知。创建网元功能接口提供创建网元的功能接口。该接口为条件必选，当OMC不具备自动创建纳管网元功能时，0MC应支持该接口，以供A0S调用该接口实现网元被OMC创建和纳管。开站命令执行接口提供下发开站命令接口。A0S调用该接口触发OMC执行开站命令，OMC进行目标基站的软件版本安装激活和配置数据的配置激活。查询开站命令执行进度接口提供查询开站命令执行进度接口，AOS调用该接口向OMC查询开站命令执行进度，OMC返回开站命令执行中所有网元开站命令执行总进度以及每个网元的开站命令执行进度和当前进度状态，进度状态包括OMC和基站建链、基站软件下载、开站配置数据下载、基站软件和配置数据激活。开站命令执行完成通知接口提供OMC主动向A0S上报开站命令执行完成通知接口。开站命令执行完成，基站软件版本和配置数据激活后OMC和基站之间链路正常，自动触发ONC主动向A0S上报开站命令执行完成通知。基站自检接口提供执行基站自检操作接口，A0S调用该接口启动自检操作。基站开通完成后进一步对网元发起全面自检，包括业务链路检查、小区状态检查、业务告警检查、硬件单元检查等。0自检完成通知接口提供0NC主动向A0S上报基站自检结果通知。基站完成链路检查、小区状态检查、业务告警检查、硬件单元检查、单板状态检查等操作后自动触发0MC向A0S上报自检完成通知7.2.2其他业务接口查询开站并发接口提供查询开站并发能力接口，A0S调用该接口查询0MC当前正在并行执行开站操作的基站数以6及OMC能够承担的最大并行开站数，AOS根据OMC的当前负荷，进行流控，分批开站，避免由于0MC资源不足导致开站失败。通知管理接口A0S通过该接口与ONC交互，实现创建、查询、删除通知订阅功能。通知管理流程如图4。通知管理流程如图4。通知管理接口流程主要说明如下：a)A0S触发ONC创建通知订阅b)创建通知订阅成功，OMC返回通知订阅ID给AOSc)OMC根据订阅需求向A0S上报开站业务相关通知，本文件中主要涉及以下通知：制作完成通知、开站命令执行完成通知、自检完成通知d)A08向OMC查询通知订阅信息e)OMC给A0S返回通知订阅信息f)A0S删除通知订阅g)OMC向A0S上报删除通知订阅结果7.1创建通知订阅接口提供创建订阅通知接口。AOS调用该接口向OMC订阅指定开站任务下的制作完成通知、开站命令执行完成通知和自检完成通知。订阅成功后OMC向A0S返回通知订阅ID。.2查询通知订阅接口提供查询通知订阅接口。AOS调用该接口向OMC查询通知订阅信息。.3删除通知订阅接口提供删除通知订阅接口。A0S调用该接口删除通知订阅。8接口设计8.1接口设计约定5G基站自动开通接口是OMC以RESTAPI服务方式开放的能力接口。0MC为接口服务端，A0S作为客户端调用5G基站自动开通接口对OMC发起基站开通相关操作，实现5G基站自动开通。接口设计约定如下：通信协议HTTPS加密传输方式。服务接口的根路径如下，更细的路径在8.2和8.3中定义。URI的命名方式采用小驼峰命名法。/api/rest/{apiCategory}/lapiVe服务分类，取值securityManagenent、commonManagement、服务接口的版本，取值为字符串，格式为“v”+“数字”,如v1,v2等，消息头中携带的资源表示的格式由Content-Type和Accept头字段中的媒体类型指示。应支持的媒体类型是：application/json(RFCmultipart/form-data(仅适用于下发文件接口)字符集：charset=UTF-8,为NoBOM编码方式。Header的字段命名采用驼峰命名法。请求报文的属性字段命名采用小驼峰命名法。接口方法API接口的HTTP/1.1方法语义：8GET:用于查询制作进度、查询开站命令执行进度、查询通知订阅POST:用于登录、握手、下发文件、创建开站任务、开站数据制作、制作结果完成通知、创建网元、开站命令执行、开站命令执行完成通知、基站自检、自检完成通知、创建通知订阅DELETE:用于退出、删除通知订阅响应报文的属性字段命名采用小驼峰命名法。8.2通用接口登录接口操作成功时返回状态码200,失败时返回相应状态码(状态码参见附录A)./api/rest/securityManagement/vl/oauth/to访问方法中文名选请求报文样例(仅供参考)POST/api/rest/securitylanagenent/yi/oaoth/tokenHTIP/1.1Content-Type:appllication/json:charse9响应参数(OMC→A0S)中文名条件必响应报文样例(仅供参考)Content-Type:application/json:charse)用户名或密码错误的失败样例：Content-Type:application/json;charset=UTP-8注意事项a)需要在服务端创建用户，以及绑定对应权限，以便与客户端进行对接b)给不同A05分配的用户名应不同。c)同一用户重复登录时，服务端返回不同的accessToken操作成功时返回状态码204,失败时返回相应状态码(状态码参见附录A)/api/rest/securityNanagement/vl/oauth/t访问方法中文名条件必请求报文样例(仅供参考)DELETE/api/rest/scurityManagorent/vl/oauth/DELETE/api/rest/scurityManagorent/vl/oauth/Authorlzation:Bearer52661fhd-6b84-4rc2-aale-17879a5Contnt-Type:application/json:charset响应参数无响应报文样例(仅供参考)Content-Type:application/json:charset)操作成功时返回状态码200,失败时返回相应状态码(状态码参见附录A)。/api/rest/securityWanagement/v1/6auth/hands访问方法中文名请求报文样例(仅供参考)POST/apl/rest/securltylanagenent/v1/oauth/handshakeHITP/1.1Authorization:Bearer5266lfhd-6b84-4fc2-aale-17879a5c6c9bContent-Type:application/json;charset)响应参数无响应报文成功样例响应报文失败样例Content-Type:application/json:charse)8.2.2下发文件接口AOS将文件下发到ONC系统，在自动化开站过程中，AOS调用此接口将开站数据文件下发到OMC网管的接口，采用文件流的方式传输文件，操作成功时返回状态码2000K;失败时返回相应状态码 (状态码参见附录A),并根据error对象获取错误码和错误信息。/api/rest/commonManagement/v1/operator/putF访问方法中文名选请求报文样例(仅供参考)POST/rest/comonlanagenent/vl/operator/putFileHTTP/1.1Authorization:Bearer5266lfhd-6b84-4fc2-aale-17879a5c6c9bContent-Type:multipart/form-data:charse)响应参数(OMC→A0S)中文名条件必径应失败时该参error对象包含如下属性：中文名选响应报文样例(仅供参考)Content-Type:application/json!charset(“filePath":“)8.3业务接口8.3.1开站业务接口创建开站任务接口A0S调用该接口触发OVC创建开站任务。操作成功时返回状态码201CREATED:失败时返回相应状态码(状态码参见附录A),并根据error对象获取错误码和错误信息。/api/rest/provisionManagement/v1/operator/setup访问方法无请求报文样例(仅供参考)POST/rest/provisionManagenent/1/operator/setupJobHIP/1.1POST/rest/provisionManagenent/1/operator/setupJobHIP/1.1Authorization:Bearer52661fhd-6b84-4fc2-male-17879a5c6e9bContent-Type;application/json:charset)中文名选应失败时该参error对象包含如下属性：中文名选响应报文样例(仅供参考)Content-Type:application/json:charse““jobld':i00)开站数据制作接口A0S通过该接口触发ONC启动开站数据制作操作。该接口为异步接口，发起后即时返回应答。操作成功时返回状态码201CREATED:失败时返回相应状态码(状态码参见附录A),并根据error对象获取错误码和错误信息。/api/rest/provisionManagement/vl/operator/jobs/[jobld//data访问方法中文名请求报文样例(仅供参考)POST/rest/prorisionlanngenent/vl/operator/jobs/(jobld)/dataPlanHITP/L.1POST/rest/prorisionlanngenent/vl/operator/jobs/(jobld)/dataPlanHITP/L.1Authorization:Bearer52661fbd-6b84-4fc2-aale-1787945c6c9bContent-Type:sgplication/json:charset“filePath":"/hone/temp/xxxplanning_tenplate.xlsm”)中文名选选(响中文名中文名选响应报文样例(仅供参考)Content-Type;application/json:charset)查询制作进度接口A0S调用该接口查询ONC开站数据制作进度。操作成功时返回状态码200OK;失败时返回相应状态码(状态码参见附录A),并根据error对象获取错误码和错误信息。/api/rest/provisionManagement/v1/operator/jobs/(jobld/data访问方法无请求报文样例(仅供参考)GEThes/provisionManagementMl/operator/jobs/(jobld//dataPAuthorization:Bearer52661fbd-6684-4fc2-aale-17879a5cBeContent-Type:application/json:charse((}中文名范国[0..100].选(响应失败数必neDataProgress对象数组中的对象包含如下属性：中文名条件必度，取值范围[0..100].选(当status取值为1时该参数必neDataProgressError对象数组中的对象包中文名选固定为0:中文名选息。包括以下内容：参数名称、error对象包含如下属性：中文名响应报文样例(仅供参考)Content-Type:application/json:charse(("subNetwork":“1”"neld":“2”"status":“1”.(}]]制作完成通知接口开站数据制作完成后，OMC及时向A0S上报开站数据制作完成通知。A0S收到通知后，如无异常时返回状态码204,失败时返回相应状态码(状态码参见附录A);如出现异常，则返回失败状态码，并且响应消息体中携带error对象具体的错误码和错误信息。接口需要具备重试机制。当返回失败状态码时，ONC应重新调用通知接口，重复调用3次仍失败的情况下可放弃本次通知上报。数据制作结果以CSV格式文件方式记录，ONC将生成的数据制作结果文件上传到SFTP服务器，数据制作结果文件存放路径随通知消息上报，AOS根据文件路径从SFTP服务器下载数据制作结果文件，数据制作结果文件相关技术约定详见附录B。A0S订阅时携带的callbackURI。访问方法中文名选识由厂商名称+0MC编号组成订阅接口请求参数中jobld和发生改变04C必须分配不同的subseriptionsld正整数。完成通知文件请求报文样例(仅供参考)POST/rest/provisionManagement/v1/operator/dataPlan/Result/HTTP/1.1POST/rest/provisionManagement/v1/operator/dataPlan/Result/HTTP/1.1Content-Type:application/Json:charset=UTF“jobld”:100,"resultFilePath”:"/hone/tenp/aos_dataplan_result_中文名条件必选(响应失败error对象包含如下属性：中文名响应报文样例(仅供参考Content-Type:aplication/json:churset)创建网元功能接口(条件必选)A0S调用该接口触发OWC启动创建网元操作。该接口为条件必选，当oMC不具备自动创建纳管网元功能时，ONC必须支持该接口。0MC创建网元需要的参数(如ESN、网元IP地址、VLANID)从开站数据文件中获取。操作成功时返回状态码201CREATED;操作失败时返回相应状态码(状态码参见附录A),并根据error对象获取错误码和错误信息。/api/rest/provisionManagement/vl/operator/neNode/[jo访问方法无请求报文样例(仅供参考)POST/rest/provisionManagenent/vl/operator/ncNode/[jobld]HTTP/1.1POST/rest/provisionManagenent/vl/operator/ncNode/[jobld]HTTP/1.1Authorization:Bearer5266lfhd-6684-4fc2-aale-17879a5cfc9bContent-Type:application/json:charse)中文名选枚举值：选(响error对象包含如下属性：中文名响应报文样例(仅供参考)Content-Type:application/json;charset"result":”success”)开站命令执行接口A0S调用该接口触发ONC执行开站命令。该接口为异步接口，发起后即时返回应答。操作成功时返回状态码201:失败时返回相应状态码(状态码参见附录A),并根据error对象获取错误码和错误信息/api/rest/provisionManagement/vl/operator/jobs/(jobld/execS访问方法中文名选请求报文样例(仅供参考)POST/rest/prowisionlhnagencnt/vl/operator/jobs/[jobld]/cxeSetupHTTP/1.1POST/rest/prowisionlhnagencnt/vl/operator/jobs/[jobld]/cxeSetupHTTP/1.1Authorization:Bearer526611hd-6b34-4fc2-aale-17879a5c6cCotent-Type:appllcation/Json:charse"execTine":”2020-10-2012:00:00”中文名中文名选选(响应失败时该参error对象包含如下属性：中文名响应报文样例(仅供参考)Content-Type:application/json:charse(“result”:"success”)查询开站命令执行进度接口开站操作比较耗时，A0S调用该接口查询OMC开站命令执行进度。操作成功时返回状态码200OK;失败时返回相应状态码(状态码参见附录A),并根据error对象获取错误码和错误信息。/api/rest/provisionManagement/vl/operator/jobs/(jobldl/execS访问方法无请求报文样例(仅供参考)GET/rest/provisionMangcrent/vl/operator/jobs/(jobld//exeSetupHTP/1.1Authorization:Bearer52661fbd-6b84-4fc2-aale-17879Content-Type!application/json:charset)响应参数(OMC→A0S)中文名取值范围[0..100].数必neSetupProgress对象数组中的对象包含如下属性：中文名选6-N:/厂商白定义(被具体度。取值范围[0..100].选(当status取值为1时该参数必neSetupProgressError对象数组中的对象包含如下属性YD/T202×—xxxx中文名固定为0:体的失收原因，每个网元可能有error对象包含如下属性：中文名响应报文样例(仅供参考)响应报文样例(仅供参考)Content-Type:application/json;charse"sulNetwork":“1”}"subNetwork":“1”"recordNo":“1”“detail”;“xux”]}]开站命令执行完成通知接口开站命令执行完成后，OMC及时向A0S上报开站命令执行完成通知。A0S收到通知后，如无异常则返回状态码204,失败时返回相应状态码(状态码参见附录A);如有异常，则返回失败状态码，并且响应消息体中携带error对象具体的错误码和错误信息。接口需要具备重试机制。当返回失败状态码时，ONC应重新调用通知接口，重复调用3次仍失败的情况下可放弃本次通知上报。开站命令执行结果以CSV格式文件方式记录，ONC将生成的开站命令执行结果文件上传到SFTP服务器，开站命令执行结果文件存放路径随通知消息上报，A0S根据文件路径从SFTP服务器下载数据制作结果文件，数据制作结果文件相关技术约定详见附录B。A0S订阅时携带的callbackURI,访问方法中文名选识请求报文样例(仅供参考)POST/rest/provisionManagement/v1/operator/execSetup/BesultHIPOST/rest/provisionManagement/v1/operator/execSetup/BesultHIContent-Typo:application/json:charsot“jobld”:100."resultFllePath":"/hone/tenp/aos_setup_result_[jobld}_)中文名条件必应失败error对象包含如下属性：中文名选响应报文样例(仅供参考)Content-Type:application/json:charset)基站自检接口执行开站命令执行完成后，AOS调用该接口触发OMC启动基站自检操作，该接口为异步接口，发起后即时返回应答。操作成功时返回状态码201CREATED:失败时返回相应状态码(状态码参见附录A),并根据crror对象获取错误码和错误信息。/api/rest/provisionManagement/v1/operator/jobs/[jobld//ch访问方法无请求报文样例(仅供参考)POST/api/rest/provisionllanagenent/vl/operator/jobs/[jobld]/checkHITP/1POST/api/rest/provisionllanagenent/vl/operator/jobs/[jobld]/checkHITP/1Authorlzation:Bearer52661fbd-6584-4fc2-aale-17879a5cfe96Content-Type:application/json:char()中文名条件必选应失败时该参error对象包含如下属性：中文名选响应报文样例(仅供参考)Content-Type:application/json:churst)0自检完成通知接口自检完成后，OMC及时向A0S上报自检完成通知。A0S收到通知后，如无异常时返回状态码204,失败时返回相应状态码(状态码参见附录A);如出现异常，则返回失败状态码，并且响应消息体中携带error对象具体的错误码和错误信息。接口需要具备重试机制。当返回失败状态码时，0MC应重新调用通知接口，重复调用3次仍失败的情况下可放弃本次通知上报。自检报告以excel格式文件方式记录，ONC将生成的自检报告上传到SFTP服务器，自检报告文件存放路径随通知消息上报，A0S根据文件路径从SFTP服务器下载自检报告文件，自检报告文件相关技术约定详见附录B。A0S订阅时携带的callbackURI。访问方法中文名选识白检报告文件径。A0S可以从该文件路径下毂请求报文样例(仅供参考)POST/rest/provisionManagement/v1/operator/check/ResultHTIP/1.1POST/rest/provisionManagement/v1/operator/check/ResultHTIP/1.1Content-Type:application/Json:charse"resultFilcPath":"/hooc/tenp/aos_check_result_[jobld}中文名选选(响应失败error对象包含如下属性：中文名响应报文样例(仅供参考)Content-Type:appllication/json:charse(8.3.2其他业务接口查询开站并发接口OMC提供接口查询开站并发能力，A0S可以根据OMC的当前并发能力进行调度。操作成功时返回状态码2000K:失败时返回相应状态码(状态码参见阳录A),并根据error对象获取错误码/api/rest/provisionManagement/v1/operator/setupAbi访问方法无请求报文样例(仅供参考)GET/rest/provisionManagement/v1/operator/setupAbilityHTIGET/rest/provisionManagement/v1/operator/setupAbilityHTIAuthorlzatlon:Bearer52661fhd-6684-4rc2-aale-17879a5Content-Type:application/json:charsot中文名选力选(响应失败数必error对象包含如下属性：中文名选响应报文样例(仅供参考)Content-Type:application/json:charset).1创建通知订阅接口失败时返回相应状态码(状态码参见附录A),并根据error对象获取错误码和错误信息。/api/rest/provisionManagement/vl/operator/subscript访问方法请求参数(A0S→OWC)中文名选1)制作结果通知的回调URL;Result请求报文样例(仅供参考)POST/api/rest/provisionlanagement/v1/operator/subscriptionsMTTP/1.1Authorization:Bearer52661fbd-6b84-4fc2-aale-17879a5cContent-Type:application/json;charse““jobld”:100,“callbackUrl”:"https://x.x.x,x:x/provisionhlanagenent/vI/operator/dataPlan/Result")中文名条件必正整数。选(响中文名响应报文样例(仅供参考)Content-Type:application/json;charse“subseriptioosld”:“1”).2查询通知订阅接口提供查询订阅的功能。A0S调用该接口向OMC查询通知订阅信息。操作成功时返回状态码200OK,失败时返回相应状态码(状态码参见附录A),并根据error对象获取错误码和错误信息查询单个订阅：/api/rest/provisionManagement/vl/operator/subscriptions/[subscription查询所有订阅；/api/rest/provisionManagement/vl/operator/subscript访问方法无请求报文样例(仅供参考)GET/apl/rest/provislonWangerent/v1/operator/sobscrlptlons/(subserlptlonsId)HGET/apl/rest/provislonWangerent/v1/operator/sobscrlptlons/(subse