大数据平台概要设计说明书（知识研究或个人学习）

大数据平台概要设计说明书引言编写目的本概要设计说明书的编写目的用来描述XXX大数据平台建设项目中的设计基准。文档主要给设计开发人员、实施人员参考使用，包括程序系统的基本处理流图、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和安全性设计等。以向整个设计期提供关于程序系统的逻辑和数据功能实现方式的总体描述，从而作为程序详细设计或编码的基础。读者范围建设单位项目管理人员、技术人员。承建单位项目管理、设计开发者、测试人员、质量管理员。监理单位监理工程师。总体设计平台总体结构设计思路开发时考虑的总体原则是：它必须满足设计目标中的要求，并充分考虑本网站的基本约定。建立完善的系统设计方案。信息系统的实施作为信息化规划的实践和实现，必须遵循信息化规划方案的思想，对规划进行项目实施层面上的细化和实现。首先必须遵循信息化规划“投资适度，快速见效，成熟稳定，总体最优”的总原则。具体细化到信息系统分析设计和软件系统工程上来。先进性系统构成必须采用成熟、具有国内先进水平，并符合国际发展趋势的技术、软件产品和设备。在设计过程中充分依照国际上的规范、标准，借鉴国内外目前成熟的主流网络和综合信息系统的体系结构，以保证系统具有较长的生命力和扩展能力。实用性实用性是指所设计的软件应符合需求方自身特点，满足需求方实际需要。在合法性的基础上，应根据需求方自身特点，设置符合需求方的设计需求。对于需求方的需求，在不违背使用原则的基础上，确定适合需求的设计，满足需求方内部管理的要求。 设计上充分考虑当前各业务层次、各环节管理中数据处理的便利和可行，把满足管理需求作为第一要素进行考虑。 采取总体设计、分步实施的技术方案，在总体设计的前提下，系统实施时先进行业务处理层及低层管理，稳步向中高层管理及全面自动化过渡。这样做可以使系统始终与业务实际需求紧密连在一起，不但增加了系统的实用性，而且可使系统建设保持很好的连贯性； 全部人机操作设计均充分考虑不同使用者的实际需要； 用户接口及界面设计充分考虑人体结构特征及视觉特征进行优化设计，界面尽可能美观大方，操作简便实用。可靠性在可靠性设计过程中应遵循以下原则： 可靠性设计应有明确的可靠性指标和可靠性评估方案； 可靠性设计必须贯穿于功能设计的各个环节，在满足基本功能的同时，要全面考虑影响可靠性的各种因素； 应针对故障模式（即系统故障或失效的表现形式）进行设计，最大限度地消除或控制产品在寿命周期内可能出现的故障（失效）模式； 在设计时，应在继承以往成功经验的基础上，积极采用先进的设计原理和可靠性设计技术。但在采用新技术时必须经过试验，并严格论证其对可靠性的影响；在进行产品可靠性的设计时，应对产品的性能、可靠性、费用、时间等各方面因素进行权衡，以便做出最佳设计方案。可操作性系统在设计上要充分考虑用户界面应方便、友好、灵活，用户应能够方便地在权限范围内于各子系统之间切换。系统有良好的整体化设计，同时完善的帮助系统也是增强可操作性的必要辅助工具之一。 可操作性系统在设计上要充分考虑用户界面应方便、友好、灵活，用户应能够方便地在权限范围内于各子系统之间切换。系统有良好的整体化设计，同时完善的帮助系统也是增强可操作性的必要辅助工具之一。 开放性系统采用开放性的平台，充分考虑本系统与其它系统的数据接口。根据我们对系统需求和系统目标的分析，实现思路是：快速适应系统的业务需求，应用先进的软件设计思想，同时充分考虑系统长期发展的前瞻性要求，基于J2EE的多层B/S架构体系之上实现系统的灵活性、安全性，并使系统具有良好的可管理性。重点考虑以下几点：最大限度保护用户现有投资 任何新体系的引进都必须保证不能影响原有业务系统的性能，保证关键业务系统的正常运转，这是引进新的信息技术的前提。本系统将充分考虑本系统的现状，最大程度地保护用户现有软硬件和网络投资。对准备弃用的原有系统中的数据完整地迁移到新系统中，对保留使用的原有系统进行全面整合，加以充分利用。总体规划、分步实施 系统必须本着“整体规划，统一组织，分步实施”的原则进行开发建设，系统建设应在建设之初的统一规划下，充分考虑以上多方的情况，有机的、分步骤的逐步完善。此外，系统的建设涉及众多新的和复杂的软硬件技术，工程实施环节复杂，应按照总体设计的规划来进行分步实施。 标准化的开发与设计 系统开发与建设应做到工作标准统一、业务流程统一、服务程序统一。在业务、软件产品、通信技术等各方面采用行业、国家和国际标准化组织制定的有关技术规范与标准。保证信息流传递快速顺畅，网络运行安全可靠。完备的安全体系 系统安全性也是设计与开发应用系统的首要考虑因素，是整个过程中应当遵循的准则。应用系统在设计时制定一整套有效的安全措施以保证整个系统的安全性，能够满足本系统制定的安全管理需要，能够防止来自内、外部入侵的威胁。可扩展性可扩展性指的是系统可以根据业务发展的需要，能够方便的升级，扩展系统的功能。由于本次采用了集中式系统架构，数据和应用的集成集中在中间件一级进行处理，所以，也就为日后的扩展打下了良好的基础。 同时保证系统能在各种操作系统和不同的中间件平台上移植。从本次采用的系统体系架构、开发语言到各平台服务器的选型我们都充分考虑到了移植性的要求。 系统性原则以系统的眼光作出整体规划，做到统一设计，逐步实施, 并制定统一的数据标准、网络标准和应用标准，形成决策层、调度层、操作层之间相互衔接的标准体系。  同时，由于信息化涉及面广、覆盖面宽，任务重，难度大，非一朝一夕所能够完成，因此，在实施过程中必须坚持远近结合、突出重点、急用先建、分步实施、逐步推进。在系统设计过程中考虑系统实施的分步性、阶段性，提供逐步实施的具体方法，先试点再推广与分阶段升级实施。快速见效，保证满足基本需求和规划方向结合。成熟性原则系统设计和开发平台采用业界公认成熟并被广泛应用的技术，保证系统实施的进度和质量、保证系统的稳定可靠。系统技术成熟稳定和主流相结合。  坚持以安全、实用为前提，在实施中首选先进、成熟、可靠、适应行业特点的信息技术，同时又要体现信息系统的开放性、兼容性和可扩展性，做到既满足业务管理和安全保密的自身需要，又要满足与相关外部业务之间的开放对接之需要。运行环境软件平台编号操作系统类型网络环境用途1CentOS7.3测试系统2CentOS7.3Jenkins+测试数据库3windowsserver2008R264位SuperMap4windowsserver2008R264位交换平台5CentOS7.3ambari+datax+hive+yarn等6CentOS7.3目录+单点登录+可视化+数据库+资源库+Nginx负载7CentOS7.3部署pg数据库，MySQL数据库(选装)，oracle数据库(选装)硬件平台序号配置项配置参数1数据库服务器Intel(R)Xeon(R)CPUE5-2630v4@2.2GHzCPU、32GB内存、70GB硬盘2非结构化数据存储服务器Intel(R)Xeon(R)CPUE5-2630v4@2.2GHzCPU、128GB内存、4TB+70GB硬盘3视频存储服务器Intel(R)Xeon(R)CPUE5-2630v4@2.2GHzCPU、128GB内存、70GB硬盘功能设计统门系统系统概述通过建立统一开放平台，逐步实现公共数据集开放，鼓励委办和公众挖掘利用，推动治理、公共服务、产业发展等领域大数据创新应用。针对公务员提供数据申请、审批、利用、分析的系列功能集，建立统一大数据利用平台，逐步实现公共数据集开放，鼓励在管理和业务办理中的数据挖掘利用，推动治理、公共服务、产业发展等领域大数据创新应用。具体包括数据目录、一张图、API服务、数据开放、数据治理、数据可视化等栏目。系统流程数据结构序号字段名称是否必填数据类型输入方式备注通知公告表字段1通知公告名称是字符型手动输入2发布日期是日期型自动带出新闻动态表字段1新闻动态名称是字符型手动输入2发布日期是日期型自动带出 我的资料表字段1用户名称是字符型手动输入2登陆名是字符型手动输入3联系电话是字符型手动输入4邮箱是字符型手动输入视频资料表字段1相关视频名称是字符型手动输入2发布机构是字符型手动输入3发布日期是日期型自动带出文档资料表字段1相关文档名称是字符型手动输入2发布机构是字符型手动输入3发布日期是日期型自动带出常见问题表字段1常见问题名称是字符型手动输入2发布机构是字符型自动带出3发布日期是日期型自动带出我的消息表字段1消息内容是字符型自动带出2时间是日期型自动带出3状态是字符型自动带出4操作是字符型自动带出基础支撑平台系统概述基础支撑平台包括支持应用开发的JavaEE技术框架，支持平台设计的SOA体系架构，实现服务接口标准化的WebService、XML等技术，以及包括数据适配器、服务总线、流程引擎、消息中间件、等相关支撑中间件组成，为构建大数据平台提供基础技术支撑。系统结构系统流程约束条件系统流程依赖于系统运维管理部门的设置，参与者包括系统管理员、运维人员、大数据中心人员。数据结构序号字段名称是否必填数据类型输入方式备注主表字段1机构名称是字符型自动带出根据系统人员的相关单位自动带出2区域名称是字符型下拉选择默认为区，可下拉选择本单位的区域3是否禁用是数值型下拉选择默认为否，可下拉选择是否禁用4数据字典是字符型自动带出根据系统登录人员的名称自动带出5功能授权否字符下拉选择已经创建的的用户，需要作为功能授权就下拉选择6部门ID是数值型自动带出根据系统登录人员的名称自动带出7模板路径是字符型手动选择根据系统登录人员手动选择上传模板的路径数据管理子系统系统概述数据管理子系统通过一个大数据门户系统，向全市各职能部门和公众提供大数据中心的数据共享目录，职能部门和公众可以根据自己的需要，在大数据门户上浏览和查询共享数据目录，找到需要的数据后，对其发起申请，由数据管理人员对申请信息进行审核，审批通过后，各职能部门和公众可根据自身需求，同步数据到自己数据库或者生成数据调用接口，以供职能部门和公众进行数据的调用，完成辅助其系统或者查看的功能。功能包括数据目录申请、数据目录审核、数据目录任务调度、数据目录调用接口生成等。系统结构

系统流程添加数据源流程数据目录注册流程数据目录申请流程数据目录使用流程约束条件数据目录注册流程依赖于各职能部门提供自己部门的数据目录进行注册，参与者包括职能部门数据使用人员，职能部门数据管理人员、大数据管理员、后台运维人员。数据目录申请审核流程依赖于各职能部门根据需求申请数据目录，参与者包括包括职能部门数据使用人员，职能部门数据管理人员、大数据管理员、后台运维人员。数据结构序号字段名称是否必填数据类型输入方式备注数据源主表字段1数据源类型是字符型手动输入2数据源名称是字符型手动输入3服务器地址是字符型手动输入4服务器端口是字符型手动输入5用户名是字符型手动输入6密码是字符型手动输入7数据库名是字符型选择序号字段名称是否必填数据类型输入方式备注数据目录主表字段1目录名称是字符型手动输入2资源格式是字符型选择3数据源是字符型选择4资源分类是字符型选择5主题分类是字符型选择6业务类别是数值型选择7目录标识是字符型自动带出自动生成8提供部门是字符型选择9共享方式是数值型选择10摘要信息是字符型手动输入11共享类型是数值型选择12更新周期是数值型选择13是否向公众公开是数值型选择14标签是字符型选择15使用要求是字符型手动输入16数据审批人是数值型自动带出自动生成17数据审批人部门是数值型自动带出自动生成18数据审批人名称是字符型自动带出自动生成19创建人是数值型自动带出自动生成20数据审批人是数值型自动带出自动生成数据目录信息项子表字段1信息项中文名称是字符型自动带出2信息项英文名称是字符型自动带出3是否搜索是数值型选择4是否排序是数值型选择5是否脱敏是数值型选择6信息项描述是字符型手动输入序号字段名称是否必填数据类型输入方式备注数据目录申请主表字段1申请人是数值型自动带出2使用单位是字符型自动带出3数据用途是字符型手动输入4申请状态是字符型自动带出5审批时间是日期型自动带出6申请时间是日期型自动带出7使用范围是字符型手动输入8数据使用方式是字符型自动带出9数据审批人部门是数值型自动带出10数据审批人是数值型自动带出11申请记录标识否数值型自动带出12数据申请单号是字符型自动带出13申请人名称是字符型自动带出14申请人所在部门是字符型自动带出15数据申请人所在部门是数值型自动带出16数据管理方部门名称是字符型自动带出17流程审批人是数值型自动带出18流程审批状态是数值型自动带出数据交换管理平台系统概述数据交换管理平台是大数据平台的支撑子系统，一方面对系统用户、权限划分、组织机构等进行模块化管理，实现用户与功能、用户与角色、角色与功能的高自由化组合配置；另一方面负责数据交换状态的实时监控，随时掌握数据交换节点、服务器、数据流量等各项指标情况。系统结构系统流程约束条件系统流程依赖于系统运维管理部门的资源管理，参与者包括系统管理员、运维人员、大数据中心人员。数据结构序号字段名称是否必填数据类型输入方式备注主表字段1内容分类是字符型下拉选择默认为通知公告，可下拉选择本单位下的内容分类2资源分类是字符型下拉选择默认为法人信息库，可下拉选择资源分类3主题分类是字符型下拉选择默认为人口信息，可下拉选择主题分类4目录标识是字符型自动带出根据选择的目录名称自动带出5业务类别是字符型下拉选择默认为行政权力，可下拉选择业务类别6审批部门是字符型下拉选择默认为北运维中心，可下拉选择审批部门7共享方式是字符型下拉选择默认为系统对接，可下拉选择共享方式8更新周期是字符型下拉选择默认为实时，可下拉选择更新周期内部接口内部接口是指软件逻辑模块之间的调用接口。内部接口设计规约定义内部模块之间的调用关系和传递的数据结构。内部接口方面，各模块之间采用函数调用、参数传递、返回值的方式进行信息传递。目录分类接口目录分类注册接口名称目录分类注册接口URL样式http://ip:端口/XXX/catalogcategory/register提交方式POST接口协议HTTP+JSON内容类型application/json提交资源数据名称是否必须类型长度描述group_id是string50目录分类编码group_name是string50目录分类名称parent_id是string50父目录分类编码credit_code是string50目录分类授权部门的社会信用代码remark否string100目录分类描述order_num否int8目录分类排序编号提交httpheader数据名称是否必须类型长度描述Authorization是string50BearerToken提交数据举例{"group_id":"3300454502000000001","group_name":"服务中心","parent_id":"3300454502000","credit_code":"45020500023456789X","remark":"服务中心","order_num":"22"}返回Http状态200返回数据参数名称类型长度描述codeint6执行结果代码（详见附录A返回码定义）messagestring-执行结果信息（和结果代码对应，是执行结果的说明信息）data--返回数据cascadeguidstring50数据交换平台返回的目录分类id返回数据举例（处理正常）{"code":"1","data":{"cascadeguid":"3300454502000000001"},"message":"目录分类注册成功"}名称目录分类变更接口URL样式http://ip:端口/XXX/catalogcategory/modify提交方式POST接口协议HTTP+JSON内容类型application/json提交资源数据名称是否必须类型长度描述group_id是string32数据交换平台返回的目录分类idgroup_name是string32目录分类名称（可变更）parent_id是string32父目录分类编码（可变更）remark否string100目录分类描述（可变更）order_num否int8目录分类排序编号（可变更）提交httpheader数据名称是否必须类型长度描述Authorization是string50BearerToken提交数据举例{"group_id":"3300454502000000001","parent_id":"3300454502000","group_name":"服务中心","remark":"服务中心","order_num":"23"}返回Http状态200返回数据参数名称类型长度描述codeint6执行结果代码（详见附录A返回码定义）messagestring-执行结果信息（和结果代码对应，是执行结果的说明信息）返回数据举例（处理正常）{"code":"1","message":"目录分类变更成功"}目录分类变更接口名称目录分类变更接口URL样式http://ip:端口/XXX/catalogcategory/modify提交方式POST接口协议HTTP+JSON内容类型application/json提交资源数据名称是否必须类型长度描述group_id是string32数据交换平台返回的目录分类idgroup_name是string32目录分类名称（可变更）parent_id是string32父目录分类编码（可变更）remark否string100目录分类描述（可变更）order_num否int8目录分类排序编号（可变更）提交httpheader数据名称是否必须类型长度描述Authorization是string50BearerToken提交数据举例{"group_id":"3300454502000000001","parent_id":"3300454502000","group_name":"服务中心","remark":"服务中心","order_num":"23"}返回Http状态200返回数据参数名称类型长度描述codeint6执行结果代码（详见附录A返回码定义）messagestring-执行结果信息（和结果代码对应，是执行结果的说明信息）返回数据举例（处理正常）{"code":"1","message":"目录分类变更成功"}目录分类撤销接口名称目录分类撤销接口URL样式http://ip:端口/XXX/catalogcategory/cancel提交方式POST接口协议HTTP+JSON内容类型application/json提交资源数据名称是否必须类型长度描述group_id是string50数据交换平台返回的目录分类id提交httpheader数据名称是否必须类型长度描述Authorization是string50BearerToken提交数据举例{"group_id":"3300454502000000001"}返回Http状态200返回数据参数名称类型长度描述codeint6执行结果代码（详见附录A返回码定义）messagestring-执行结果信息（和结果代码对应，是执行结果的说明信息）返回数据举例（处理正常）{"code":"1","message":"目录分类撤销成功"}目录信息接口目录注册接口名称目录注册接口URL样式http://ip:端口/XXX/catalog/register提交方式POST接口协议HTTP+JSON内容类型application/json提交资源数据名称是否必须类型长度描述group_id是string50数据交换平台返回的目录分类idcata_title是string512信息资源目录名称catacode是string100信息资源目录编码credit_code是string50资源目录提供方部门的统一信用代码,该部门必须先通过机构注册上报到共享交换平台internalorgan否string100提供方内部部门名称description是string1024信息资源摘要resourceformat是string20数据字典：信息资源格式分类columnlist否catalogcolumn_schema-当信息资源格式为电子表格和数据库类型时，数据项项列表信息必须填写，其他资源格式可以不上报，但若上报必须符合格式校验publishedtime是datatime-信息资源目录发布时间，格式为：yyyy-MM-ddHH:mm:ssshared_type是string20数据字典：共享类型shared_condition是string200共享条件sharedway否string20数据字典：共享方式open_type是int20数据字典：开放类型open_condition是string1024开放条件updatetime是datatime-更新时间，格式为：yyyy-MM-ddHH:mm:ssupdate_cycle是string10数据字典：更新周期提交httpheader数据名称是否必须类型长度描述Authorization是string50BearerToken提交数据举例{"group_id":"3300454502000000002","cata_title":"财务报表信息","catacode":"3300454502000000002/0001","credit_code":"45020500023456789X","internalorgan":"财务","description":"财务报表信息","resourceformat":"03","columnlist":[{"dataformat":"nvarchar","columnid":"12313478","length":"100","namecn":"报表名称","updatetime":"2017-12-2516:38:11","order_id":"22"},{"dataformat":"numeric","columnid":"12313478","length":"18","namecn":"报表金额","updatetime":"2017-12-2516:38:11","order_id":"22"}],"publishedtime":"2017-10-2622:30:00","shared_type":"1","shared_condition":"无","sharedway":"0102","open_type":1,"open_condition":"无","updatetime":"2017-10-2622:30:00","update_cycle":"1"}返回Http状态200返回数据参数名称类型长度描述codeint6执行结果代码（详见附录A返回码定义）data--返回数据cascadeguidstring50数据交换平台返回的目录id，uuidmessagestring-执行结果信息（和结果代码对应，是执行结果的说明信息）返回数据举例（处理正常）{"code":"1","data":{"cascadeguid":"a5013904-8bbc-4576-adc8-68910a0a8087"},"message":"目录注册成功"}目录变更接口名称目录变更接口URL样式http://ip:端口/XXX/catalog/modify提交方式POST接口协议HTTP+JSON内容类型application/json提交资源数据名称是否必须类型长度描述cata_id是string32数据交换平台返回的目录id，uuiddescription是string1024信息资源摘要open_condition是string1024开放条件（对向社会开放资源的条件描述。如无条件，请填写无）updatetime是datatime-更新时间，格式为：yyyy-MM-ddHH:mm:ss，提交httpheader数据名称是否必须类型长度描述Authorization是string50BearerToken提交数据举例{"cata_id":"a5013904-8bbc-4576-adc8-68910a0a8087","description":"财务报表信息说明","open_condition":"无","updatetime":"2017-10-2622:30:00"}返回Http状态200返回数据参数名称类型长度描述codeint6执行结果代码（详见附录A返回码定义）messagestring-执行结果信息（和结果代码对应，是执行结果的说明信息）返回数据举例（处理正常）{"code":"1","message":"目录变更成功"}目录撤销接口名称目录撤销接口URL样式http://ip:端口/XXX/catalog/cancel提交方式POST接口协议HTTP+JSON内容类型application/json提交资源数据名称是否必须类型长度描述cata_id是string32数据交换平台返回的目录id，uuid提交httpheader数据名称是否必须类型长度描述Authorization是string50BearerToken提交数据举例{"cata_id":"a5013904-8bbc-4576-adc8-68910a0a8087"}返回Http状态200返回数据参数名称类型长度描述codeint6执行结果代码（详见附录A返回码定义）messagestring-执行结果信息（和结果代码对应，是执行结果的说明信息）返回数据举例（处理正常）{"code":"1","message":"目录撤销成功"}资源信息接口库表资源注册接口名称资源注册接口URL样式http://ip:端口/XXX/table/register提交方式POST提交资源数据名称类型必填说明备注resource_nameString是资源名称符合命名规范cata_idString是数据交换平台返回的目录id，uuidresour_system_idString否数据交换平台返回的应用系统id，uuidcredit_code是string32资源提供部门统一社会信用代码businessString否业务类型（域）数据字典：主题分类connecttion_nameString是数据源名称db_ipString是数据库IPdb_portString是数据库端口db_nameString是数据库名称db_userString是账号db_pwdString是密码tableJson名称类型必填说明备注table_nameString是表中文名table_sqlnameString是数据库表名table_columns名称类型必填说明备注descString是列说明字段中文名称nameString是列名字段名称typeString是列类型数据字典：数据类型lengthInt是列长度precisionInt否列精度is_pkInt是是否主键0：否，1：是is_nullInt是是否允许为空0：否，1：是columnidvarchar是信息项标识目录注册中的信息项columnid提交数据举例{"resource_name":"财务报表信息","cata_id":"1ea3219d-e119-42c7-ac9e-ad5e7a226f6b","resour_system_id":"","credit_code":"45020500023456789X","business":"1","connecttion_name":"测试数据源","db_ip":"9","db_port":"3306","db_name":"perdb_lz_test","db_user":"root","db_pwd":"Gepoint","db_schema":"","tableJson":{"table_name":"测试表2","table_sqlname":"testtable2","table_columns":[{"desc":"test1","name":"test1","type":"nvarchar","length":50,"precision":0,"is_pk":0,"is_null":0,"columnid":"12313478"},{"desc":"test2","name":"test2","type":"numeric","length":18,"precision":6,"is_pk":0,"is_null":0,"columnid":"12313479"}]}}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息dataMap消息体封装返回的数据cascadeguidString数据交换平台库表资源id，uuid返回数据举例{"code":"1","data":{"cascadeguid":"ce190a34-4977-4d82-837a-ba071b5116de"},"message":"库表资源注册成功"}库表资源撤销接口名称库表资源撤销接口URL样式http://ip:端口/XXX/table/cancel提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注table_idString是库表资源Id数据交换平台库表资源id，uuidnoteString是撤销原因长度不能改超过2000提交数据举例{"table_id":"27ea8af6-fcdc-424e-8453-b782ab35f102","note":"撤销原因"}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息返回数据举例{"code":"1","message":"库表资源撤销成功"}文件资源注册接口名称文件资源注册接口URL样式http://ip:端口/XXX/file/register提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注resource_nameString是资源名称符合命名规范cata_idString是数据交换平台返回的目录idresour_system_idString否数据交换平台返回的业务系统IDcredit_codestring是32统一信用代码businessString否业务类型（域）数据字典:主题分类remarkstring否255描述ftp_ipstring是255ftp服务器IPftp_portstring是255ftp服务器端口ftp_userstring是255ftp账号ftp_pwdstring是255ftp密码folder_namestring是255根目录对应文件资源所在文件夹名称，只取根目录下一层提交数据举例{"resource_name":"目录分类-库表目录1_文件资源","cata_id":"313723e0-f989-48a2-8a94-8f4a6f6ec497","credit_code":"45020500023456789X","business":"9","remark":"财务报表文件","ftp_ip":"","ftp_port":"22","ftp_user":"epoint","ftp_pwd":"epoint","folder_name":"testfile"}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息dataMap消息体封装返回的数据cascadeguidString数据交换平台文件资源id，uuid返回数据举例（处理正常）{"code":"1","data":{"cascadeguid":"7f3cd5d2-fd69-4a81-beed-adc0cd14b5ab"},"message":"文件资源注册成功"}文件资源撤销接口名称文件资源撤销接口URL样式http://ip:端口/XXX/file/cancel提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注file_idString是文件资源Id数据交换平台文件资源id，uuidnoteString是撤销原因长度不能改超过2000提交数据举例{"file_id":"7f3cd5d2-fd69-4a81-beed-adc0cd14b5ab","note":"撤销原因"}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息返回数据举例{"code":"1","message":"文件资源撤销成功"}接口资源注册接口名称服务注册URL样式http://ip:端口/XXX/service/register提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据Body中提交名称是否必须中文名称描述cnName是服务中文名称全网不允许重复，机构名称_服务描述，长度范围：1~100字符enName是服务英文名称长度范围：1~32字符serviceDesc是服务描述长度范围：0~200字符cata_id是国家平台目录ID数据交换平台返回的目录id，uuidcredit_code是string32serviceShareType是共享类型1：开放;2：共享url是服务的有效地址长度范围：1~100字符serviceType是协议类型0:RestAPI;1:WebServicemethodType是请求方式数据字典：方法类型inputParams否输入参数描述见表inputParams_contentoutputParams否返回参数描述见表outputParams_contentoutput否响应示例callExample否调用示例responseType是响应类型数据字典：响应类型提交数据举例{"cnName":"目录分类-库表目录1_接口资源","enName":"lzln_testapi","serviceDesc":"目录分类-库表目录1_接口资源","cata_id":"313723e0-f989-48a2-8a94-8f4a6f6ec497","credit_code":"45020500023456788X","serviceShareType":"2","url":"http://ip:端口/cascade11/rest/cascade/register","serviceType":"0","methodType":"1","output":"响应示例","callExample":"调用示例","responseType":"JSON","inputParams":[{"paramname":"paras","paramtype":"String","mustfill":"1","remark":"输入参数"}]}返回Http状态200返回数据参数名称描述Code执行结果代码（成功：1，失败：详见错误码列表）message执行结果信息（和结果代码对应，是执行结果的说明信息）Data查询响应数据（json对象）id数据交换平台服务注册id，uuid返回数据举例（处理正常）{"code":"1","data":{"cascadeguid":"095fe990-1a41-4353-9fe0-038bf37b699f"},"message":"接口资源注册成功"}接口资源撤销接口名称接口资源撤销接口URL样式http://ip:端口/XXX/service/cancel提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注service_idString是接口资源Id数据交换平台返回标识,格式：UUIDnoteString是撤销原因长度不能改超过2000提交数据举例{"service_id":"095fe990-1a41-4353-9fe0-038bf37b699f","note":"paras"}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息返回数据举例{"code":"1","message":"接口资源撤销成功"}资源申请接口资源申请接口名称资源申请接口URL样式http://ip:端口/XXX/resource/apply提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注resource_idString是资源Id数据交换平台资源id,格式：UUIDapply_userString是申请人姓名contactString是申请人联系方式电话/邮箱credit_codeString是申请部门社会信用代码start_datedate否申请有效期，开始日期不填为永久有效end_datedate否申请有效期，失效日期不填为永久有效use_scopeString是资源使用范围参考附录use_descString是资源用途说明attachString是附件信息见表:attach_listapply_typeString是申请类型库表：1文件：3接口：4fieldnameString是申请的字段名称，多个分号隔开库表资源必填提交数据举例{"resource_id":"bfce1857-8eed-4d13-a52b-99ab5f448ae3","credit_code":"91510100MA6C8A7M4M","apply_user":"张三","contact":"zhagnsan@162.com","start_date":"2019-01-01","end_date":"2019-01-01","use_scope":"资源使用范围","use_desc":"主要用途","apply_type":"1","fieldname":"male;name","attach":[]}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息dataMap消息体封装返回的数据cascadeguidString数据交换平台申请记录标识返回数据举例{"code"：1，"message":"资源申请提交成功","data":{"cascadeguid"：""}}资源申请附件上传接口名称资源申请附件上传接口URL样式http://ip:端口/XXX/apply/fileupload提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注filenameString是文件名称filecontentString是附件内容附件二进制内容（文件类型为：jpg,gif,png,txt,doc,docx,pdf,xls,xlsx；文件大小最大10M）提交数据举例{"filename":"资源申请表6","filecontent":"YWx0ZXIgdGFibGUgcHJlc19jYXRhbG9nX3JpZ2h0IGFkZCB0eXBlIFZBUkNIQVIoMSkgZGVmYXVsdCAxOw0KaW5zZXJ0IGludG8gcHJlc19jYXRhbG9nX3JpZ2h0IChzZWxlY3QgKiwyIGFzIHR5cGUgZnJvbSBwcmVzX2NhdGFsb2dfbGVhZG91cmlnaHQpOw0KaW5zZXJ0IGludG8gcHJlc19jYXRhbG9nX3JpZ2h0IChzZWxlY3QgKiwzIGFzIHR5cGUgZnJvbSBwcmVzX2NhdGFsb2dfcGFydG5lcm91cmlnaHQpOw0KQUxURVIgVEFCTEUgcHJlc19jYXRhbG9nX3JpZ2h0IEFERCBJTkRFWCBpbmRleF90eXBlKHR5cGUpOw0KYWx0ZXIgdGFibGUgTWV0YURhdGFfQ29kZU1haW4gYWRkIGluZGV4IGluZGV4X2NvZGVOYW1lKGNvZGVOYW1lKTsNCmFsdGVyIHRhYmxlIHByZXNfYmFzaWNpbmZvIG1vZGlmeSBjb2x1bW4gUmVzb3VyY2VzTmFtZSBWQVJDSEFSKDUwMCk7DQphbHRlciB0YWJsZSBwcmVzX2Jhc2ljaW5mbyBhZGQgaW5kZXggaW5kZXhfUmVzb3VyY2VzTmFtZShSZXNvdXJjZXNOYW1lKTsNCg0KMQ"}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息dataMap消息体封装返回的数据cascadeguidString数据交换平台文件记录标识返回数据举例{"code":"1","data":{"cascadeguid":"5a55c49b-e766-4204-a622-24ae98ad3ff2"},"message":"附件上传成功"}名称资源申请附件下载接口URL样式http://ip:端口/XXX/apply/filedowload提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注fileidString是文件标识数据交换平台文件标识filenameString是文件名称提交数据举例{"fileid":"","filename":"资源申请表"}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息dataMap消息体封装返回的数据filecontentString文件内容，base64返回数据举例{"code"：1，"message":"资源申请提交成功","data":{"filecontent"：""}}资源申请附件下载接口名称资源申请附件下载接口URL样式http://ip:端口/XXX/apply/filedowload提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注fileidString是文件标识数据交换平台文件标识filenameString是文件名称提交数据举例{"fileid":"","filename":"资源申请表"}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息dataMap消息体封装返回的数据filecontentString文件内容，base64返回数据举例{"code"：1，"message":"资源申请提交成功","data":{"filecontent"：""}}资源申请审核接口名称资源申请审核接口URL样式http://ip:端口/XXX/apply/review提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注apply_idString是申请标识数据交换平台申请标识passString是审核结果是否通过审核（0:驳回补正;1:审核通过；2:驳回）opinionString是审核意见提交数据举例{"apply_id":"","pass":"1","opinion":"同意"}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息返回数据举例{"code"：1，"message":"处理成功"}资源需求方取消资源申请名称资源需求方取消资源申请URL样式http://ip:端口/XXX/apply/consumercancel提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注apply_idString是申请标识数据交换平台申请标识reasonString是审核意见提交数据举例{"apply_id":"","reason":"不需要使用该资源"}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息返回数据举例{"code"：1，"message":"处理成功"}资源提供方取消资源申请名称资源需求方取消资源申请URL样式http://ip:端口/XXX/apply/provideercancel提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注apply_idString是申请标识数据交换平台申请标识reasonString是审核意见提交数据举例{"apply_id":"","reason":"不提供资源"}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息返回数据举例{"code"：1，"message":"处理成功"}资源订阅接口库表资源订阅接口名称资源需求方订阅库表资源URL样式http://ip:端口/XXX/subscribe/table提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注resource_idString是数据交换平台返回的资源idsubscribenameString是订阅名称credit_codeString是订阅方社会信用代码update_frequencyString是更新频率单位：秒fieldnameString是字段名称多个分号隔开targerdbnameString是目标数据库名称dbipString是目标数据库IPdbportString是目标数据库端口dbnameString是目标数据库名称dbuserString是目标数据库账号dbpwdString是目标数据库密码fieldidString是订阅字段的id,下行表catalog_fieldinfo中column_id，多个用，隔开tablenameString否映射表名，如果需要订阅到指定表则添加fieldLinkString否映射表字段集，多个逗号隔开，如果有映射表，必填，并且与fieldid对应提交数据举例{"resource_id":"080b818d-f859-420a-abb0-4dbdda48ab96","subscribename":"testkevin","credit_code":"007566111","update_frequency":"50000","fieldname":"name;age","targerdbname":"test","dbip":"localhost","dbport":"3306","dbname":"mysql","dbuser":"root","dbpwd":"Gepoint",///分隔线---------------------------------"fieldid":"29b87549-2761-4027-8e15-285dd82569dc","tablename":"","fieldLink":""}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息dataMapcascadeguidString数据交换平台订阅标识返回数据举例{"code"：1，"message":"处理成功","data"：{"cascadeguid"：""}}文件资源订阅接口名称资源需求方订阅文件资源URL样式http://ip:端口/XXX/subscribe/file提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注resource_idString是数据交换平台返回的资源idsubscribenameString是订阅名称credit_codeString是订阅方社会信用代码update_frequencyString是更新频率单位：秒targerftpnameString是目标ftp名称ftpipString是目标ftpIPftpportString是目标ftp端口ftpfoldernameString是目标ftp文件夹名称ftpuserString是目标ftp账号ftppwdString是目标ftp密码提交数据举例{"resource_id":"218928","subscribename":"资源订阅1","credit_code":"21892812122","update_frequency":"50000","targerftpname":"订阅库","ftpip":"","ftpport":"21","ftpfoldername":"resourcedolowad","ftpuser":"root","ftppwd":"11111",}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息dataMapcascadeguidString数据交换平台订阅标识返回数据举例{"code"：1，"message":"处理成功","data"：{"cascadeguid"：""}}接口资源订阅接口名称资源需求方订阅接口资源URL样式http://ip:端口/XXX/subscribe/api提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注resource_idString是数据交换平台返回的资源idsubscribenameString是订阅名称credit_codeString是订阅方社会信用代码update_frequencyString是更新频率单位：秒appidString是订阅的应用名称提交数据举例{"resource_id":"218928","subscribename":"资源订阅1","credit_code":"21892812122","update_frequency":"50000","appid":"12133"}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息dataMapcascadeguidString数据交换平台订阅标识返回数据举例{"code"：1，"message":"处理成功","data"：{"cascadeguid"：""}}资源需求方订阅取消接口名称资源需求方订阅取消接口URL样式http://ip:端口/XXX/subscribe/consumercancel提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注subscribe_idString是订阅idreasonString是取消原因提交数据举例{"subscribe_id":"218928","reason":"不再使用"}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息返回数据举例{"code"：1，"message":"处理成功"}资源提供方订阅取消接口名称资源提供方订阅取消接口URL样式http://ip:端口/XXX/subscribe/providercancel提交方式POST提交资源数据header中提交名称是否必须描述Authorization是string提交资源数据名称类型必填说明备注subscribe_idString是订阅idreasonString是取消原因提交数据举例{"subscribe_id":"218928","reason":"不再提供"}返回Http状态200返回数据参数名称类型说明备注codeString执行状态执行结果代码（成功：1，失败：详见错误码列表）messageString返回信息提示信息返回数据举例{"code"：1，"message":"处理成功"}外部对接用户组织管理的核心在于对外提供一套标准的员工和组织接口，包括各种API接口、WEBService服务接口、界面接口等。 定义该接口的目的，是为了屏蔽在项目实施过程中，不同的项目可能存在着不同的用户组织管理方式。针对不同的用户组织管理系统，只需实现一个基于该接口定义的适配器就可以了。而基于大数据模块接口开发的其它业务模块，不必再修改关于大数据模块的内容了。通用接口方式（接口是大数据平台自动生成）名称通用生成接口URL样式http://ip:port/userauthentication/getapplicationdata.do?paras=xxxxx&

jmzfc=xxxxx提交方式POST提交资源数据名称类型必填说明备注parasString是查询参数paras：该参数是一个封装对象，其中包括5条属性（5个属性均为必填项，若某属性为空，则填空字符串）：loginname

:登陆名pwd

:登陆密码mlbs

:目录标识（数据目录的标识）queryclumn

:添加查询限制条件的列名称（只能填某一列的列名）queryvalue

:添加查询限制条件的列值jmzfcString是密钥jmzfc：该参数是一个字符串，是用来解密paras所需的密钥，每个登录名都有自己拥有且唯一的密钥。提交数据举例http://ip/userauthentic