详细设计-开放平台、数据应用平台

系统开发项目 详细设计 详详细细设设计计 开开放放平平台台 数数据据应应用用平平台台 日期作者 修订人章节修改内容版本 2018 06 01张广良1 0 系统开发项目 详细设计 2 目录目录 第一章第一章综述综述 3 1 1阅读前的注意事项 3 1 2规范要求 3 第二章第二章应用系统设计应用系统设计 4 2 1数据开放平台 4 2 1 1开放数据 4 2 1 2云接口 8 2 1 3云服务 12 2 1 4开放需求 17 2 1 5用户中心 21 2 2数据应用平台 25 2 2 1PAAS服务平台 25 2 2 2资源管理 29 2 2 3资源图谱 34 2 2 4目录活化系统 37 2 2 5运营管理 40 2 2 6运维管理 45 2 2 7通用服务 50 第三章第三章系统错误处理设计系统错误处理设计 53 3 1系统访问异常 53 系统开发项目 详细设计 3 第一章第一章 综述综述 1 1 阅读前的注意事项阅读前的注意事项 本文件涉及具体的业务知识和大量的技术知识 需要掌握相应的业务和技术 知识才能正确完全地理解本文 1 2 规范要求规范要求 GB T 9385 2008 计算机软件需求说明编制指南 中华人民共和国计算机信息系统安全保护条例 国务院令第 147 号 1994 2 18 计算机信息系统保密管理暂行规定 国保发 1998 1 号 计算机软件保护条例 2001 年 12 月 20 日中华人民共和国国务院令第 339 号公布根据 2011 年 1 月 8 日 国务院关于废止和修改部分行政法规的决定 第 一次修订根据 2013 年 1 月 30 日 国务院关于修改 计算机软件保护条例 的 决定 第二次修订 系统开发项目 详细设计 4 第二章第二章 应用系统应用系统设计设计 2 1 数据开放平台数据开放平台 2 1 12 1 1 开放数据开放数据 2 1 1 12 1 1 1 概述概述 主要便于公众可以快速根据基础资源 主题资源 部门资源和地方资源的 分类目录快速准确查找对应的信息资源 同时提供了最新资源 热门资源和推 荐资源的信息展示 主要展示的数据为对社会有价值的公告数据 比如教育局的小升初数据以 交通局的违章查询等实用数据 本地市民可以通过此平台查询 下载等 数据的格式主要为 word 或者 excel 2 1 1 22 1 1 2 界面设计界面设计 2 1 1 32 1 1 3 流程说明流程说明 1 门户用户注册成平台注册用户 2 注册用户浏览查阅开放数据信息 3 注册用户申请使用开放数据 4 注册用户支付开放数据费用 5 注册用户下载开放数据 系统开发项目 详细设计 5 2 1 1 42 1 1 4 输入数据结构输入数据结构 获取数据列表 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1serviceObjectString否服务对象 如果多个以英文 分隔 2scopeString否范围 3orgIdInt否机构 ID 4categoryIdInt否分类 ID 5tagIdString否标签 ID 多个以 分隔 6chargeTypeString否收费类型 01 免费 02 收费 7keywordString否关键字 8orderByString否排序字段 不传为默认排序 1 为开放 顺序 2 为访问量 9pageInt否需要查询的页面 默认为 0 10pageSizeInt否每页显示数量 默认为 10 HEADER1mscx area codeString是区域 ID 获取数据详情 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1dataIdint是数据 id 2 HEADER1mscx area codeString是区域 ID 2Mscx user dataString否 userId 用户 ID name 用户账号 mobile 手机号码 name 姓名 企业 合 作伙伴姓名 2 1 1 52 1 1 5 处理过程处理过程 请求报文 成功响应报文 code 000000 message success result 系统开发项目 详细设计 6 id 53 name 数据 1 description 数据描述 1 item 数据项 1 categoryId 26 categoryName null tags 58 50 tagNames publishDate 1481558400000 scope 数据所属范围 orgId 78 orgName 社会企业 fileUri null fileType sql fileSize 134 demoFileUri null chargeType 02 chargeTypeDesc 收费 price 10 status 0 serviceObject 01 02 serviceObjectNames 个人 企业 recommendOrder null ownCity 440100 sourceCity 440100 comments ok area 440100 createdTime 1481533251000 系统开发项目 详细设计 7 createdBy admin updatedTime 1481533936000 updatedBy admin attentionCount 0 downloadCount 0 viewCount 44 fileKey temp 73a0e950d1e2ee60f2c85ed4426c0233 demoFileKey temp 71d9a5c99bf9542398f48162d318a381 attentionFlag false status OK 失败报文 code 999999 message result status ERROR 2 1 1 62 1 1 6 输出数据结构输出数据结构 输出参数输出参数 Response 值说明值说明 序号序号参数参数参数说明参数说明 1 code 返回码 详见下方 返回码 返回信息说明 2 message 返回信息 3 status 返回状态 OK 成功 ERROR 失败 4 result 文件下载地址 返回码 返回信息说明返回码 返回信息说明 序号序号返回码返回码 code 返回信息返回信息 message 1 000000 本次请求成功 系统开发项目 详细设计 8 2 999999 请求失败 2 1 1 72 1 1 7 接口设计接口设计 具体接口 具体接口 获取数据报告列表接口 获取数据详情接口 下载数据内容接口 相关规范 相关规范 访问方式 GET 返回码 返回信息说明 000000 本次请求成功 999999 请求失败 2 1 1 82 1 1 8 备注备注 2 1 22 1 2 云接口云接口 2 1 2 12 1 2 1 概述概述 云接口 即 API 是随着互联网和云计算的兴起而催生的产物 是服务 应用和系统的数字纽带 公共信息融合服务云接口主要依托政府部门和公共事 业单位的服务资源 对现有服务产品进行 API 服务化 以云模式对外提供公共 信息共享融合服务 围绕现有产品打造新的公共信息融合服务生态 云接口 API 分为数据 API 模型 API 工具 API 三大类 具体详情如下 1 数据 API 提供全国性数据 API 并对本地的数据进行 API 化 让用 户可以直接申请使用数据资源 2 模型 API 引入成熟的模型为本地服务 同时结合本地资源建立属地 模型 3 工具 API 提供公共服务工具和基础支撑工具 系统开发项目 详细设计 9 2 1 2 22 1 2 2 界面设计界面设计 2 1 2 32 1 2 3 流程说明流程说明 1 门户用户注册成平台注册用户 2 注册用户浏览查阅接口信息 3 注册用户申请使用云接口 4 注册用户支付云接口费用 5 注册用户调用云接口 2 1 2 42 1 2 4 输入数据结构输入数据结构 查看 API 服务详情 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1apiServiceIdString是服务唯一标识 Header1mscx area codeString是区域 ID 2mscx user dataString否当前用户信息 发布 API 服务 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1scopeString是服务范围 2cnameString是服务名称 3nameString是服务标识 4descriptionString否服务简介 5imageUriString是服务图标 系统开发项目 详细设计 10 6categoryIdInteger是服务分类 7tagsString是标签 多个用逗号分隔 8rtnCodeString是服务返回码 9serviceObjectString是服务对象 10chargeSetJsonString否套餐 JSON 字符串 见下文说明 收费 套餐必填 11apiListJsonString是API 列表 JSON 字符串 见下文说明 12imageKeyString是Ali 图片 key 13chargeTypeString是收费类型 01 免费 02 收费 14typeString是Api 服务类型 Header1mscx area codeString是区域 ID 2mscx user dataString是当前用户信息 2 1 2 52 1 2 5 处理过程处理过程 请求报文 Headers mscx user data name admin userId 10000 mscx area code 440100 响应报文 code 000000 message success result updatedTime 2016 12 09 statusDesc 审核通过 chargeRuleList countLimit 10 expiryDate 2072 05 07 chargeCount 100 effectDate 2016 12 08 price 100 00 monthLimit 2 name 套餐 1 chargeType 01 description 套餐描述 chargeTypeDesc 免费 id 13 countLimit 12 expiryDate 2013 05 07 chargeCount 102 effectDate 2016 12 09 price 100 02 monthLimit 3 name 套餐 2 chargeType 02 description 套餐描述 2 chargeTypeDesc 收费 id 1 countLimit 12 expiryDate 2013 05 07 chargeCount 102 effectDate 2016 12 09 price 100 02 monthLimit 3 name 套餐 2 chargeType 02 description 套餐描述 2 chargeTypeDesc 收费 id 7 description 提供全国天气预报信息 chargeTypeDesc 收费 apiServiceId 4 accessCnt 0 type 2 tagNames null null tags 1 2 3 are 系统开发项目 详细设计 11 aId 440100 providerId 1 viewCnt 0 categoryName 政府数据 scope 广 州 iconUrl http file server image weather icon categoryId 38 attentionFlag N apiServiceCName 天气预报 providerName 服务商 1 rtnCode 000000 success 999999 fail status 0 apiList apiCName 温 度预告 apiId 1 status OK 2 1 2 62 1 2 6 输出数据结构输出数据结构 获取 API 信息 输出参数输出参数 Response 值说明值说明 序号序号参数参数参数说明参数说明 1code返回码 详见下方 返回码 返回信息说明 2message返回信息 3status返回状态 OK 成功 ERROR 失败 4result用户业务信息 详见下方 result 说明 Result 说明说明 序号序号参数参数参数说明参数说明 1apiNameAPI 名称 2chargeRuleId套餐 ID 3price套餐价格 4apiServiceIdAPI 资源 ID 5typeAPI 资源类型 6logoUrl图标地址 7apiServiceDesc资源描述 8area区域 ID 9chargeName套餐名称 10countLimit购买限制 11monthLimit使用限制 12chargeDesc套餐描述 13apiTypeDescAPI 资源类型描述 14apiStatusAPI 服务状态 0 已通过 1 已下架 4 已删除 15chargeStatus套餐状态 01 正常 02 删除 03 失效 16unitPrice套餐单价 2 1 2 72 1 2 7 接口设计接口设计 具体接口 具体接口 系统开发项目 详细设计 12 发布 API 服务接口 查看 API 服务详情接口 获取 API 内容接口 相关规范 相关规范 访问方式 GET 返回码 返回信息说明 000000 本次请求成功 999999 请求失败 2 1 2 82 1 2 8 备注备注 2 1 32 1 3 云服务云服务 2 1 3 12 1 3 1 概述概述 云服务是平台直接面向公众使用者以及开发者提供服务的渠道 通过对平 台提供的公共信息服务资源及工具 API 数据 API 模型 API 等云接口进行融合 加工 组装成具有相当独立功能的微应用或者 SaaS 服务供开发者使用 平台通过 云服务 频道提供服务 功能如下 微应用 平台汇聚的各类创新应用 公众开发者根据自己的需要可以直接 申请使用服务 创新应用提供可视化接口 或者通过 H5 页面嵌入或 APK 等方 式为创新创业者提供服务 平台汇聚的各类 SaaS 服务 终端用户根据自己的需要可以直接申请使用 SaaS 服务 系统开发项目 详细设计 13 2 1 3 22 1 3 2 界面设计界面设计 2 1 3 32 1 3 3 流程说明流程说明 1 门户用户注册成平台注册用户 2 注册用户浏览查阅微应用信息 3 注册用户申请使用云服务 4 注册用户支付云服务费用 5 注册用户调用云服务 2 1 3 42 1 3 4 输入数据结构输入数据结构 发布云服务 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数 1appJSONOb ject 是 identifyString 是微服务标识 nameString是微服务名称 categoryIdInteger是分类 id tagsString是标签 id 列表 多个 id 以英文逗号隔开 imageKeyString 是图片 key serviceObjectString是根据字典表传 code 多个以逗号隔开 scopeString是服务范围 demoUriString是演示地址 uriString是访问地址 demoKey1String否文件 key 系统开发项目 详细设计 14 demoKey2String否文件 key demoKey3String否文件 key descriptionString 是微服务描述 2chargeRuleJSONAr ray 否 nameString 是 effectDateDate是起效时间 expiryDateDate否失效时间 descriptionString 是描述 3urlJSONAr ray urlString 是请求地址 descriptionString是描述 查看云服务信息 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数 keywordString否简介 名称模糊查询 categoryIdInteger否分类 id tagIdInteger否标签 id orderByString否0 默认 1 新上线 2 使用量 serviceObjectString否根据字典表传 code 多个以逗号隔开 scopeString 否服务范围 省市区 3 个框中中取最右的 文本 pagelong否当前页 pageSizelong否每页数据量 2 1 3 52 1 3 5 处理过程处理过程 请求报文 app name aaasadfvaxqa categoryId 303 tags 893 894 imageKey c47b969fb6e7457f97002176306c0476 serviceObject 01 02 系统开发项目 详细设计 15 chargeType 02 scope 苏州 上海 demoUri 83 uri description 0000000000000000000000000000 demoKey1 c47b969fb6e7457f97002176306c0476 demoKey2 c47b969fb6e7457f97002176306c0476 demoKey3 c47b969fb6e7457f97002176306c0476 chargeRule name tttttttt chargeType 04 price 20 chargeCount 1 boughtLimit 1 invokeLimit 1 effectDate 2016 12 31 expiryDate 2017 12 31 description taocantaocan url url aaa do description 111111 响应报文 系统开发项目 详细设计 16 status OK code 000000 message result null 2 1 3 62 1 3 6 输出数据结构输出数据结构 云服务信息输出接口 返回值业务参数说明 返回值业务参数说明 result 序号序号参数参数参数说明参数说明 name 服务名称 categoryName 分类名称 tagNames 标签名称 多个以逗号隔开 imageUri 服务图标地址 imageKey 图片 key 若是修改微服务 这个值必传 serviceObjectNames 服务对象 serviceChannel 服务渠道 ServiceType 提供方式 providerName 服务商名称 Scope 服务范围 demoUri 演示地址 Uri 访问地址 demoImage1 示例图片地址 demoKey1 图片 key 若是修改微服务 且上传了图片 这个值必传 description 服务描述 attentionCount 关注量 viewCount 访问量 updatedTime 更新时间 attentionFlag 是否已经关注 true 为已关注 未登录用户值为 false 2 1 3 72 1 3 7 接口设计接口设计 具体接口 具体接口 发布云服务接口 查看云服务详情接口 系统开发项目 详细设计 17 相关规范 相关规范 访问方式 GET 返回码 返回信息说明 000000 本次请求成功 999999 请求失败 2 1 3 82 1 3 8 备注备注 2 1 42 1 4 开放需求开放需求 2 1 4 12 1 4 1 概述概述 由于社会公众 企事业单位或政府部门的数据资源需求存在多样性 在资 源需求方无法通过平台直接获取资源时 可以提出资源开放需求 申请资源归 属的政府部门或公共事业单位开放自己的数据 资源归属部门需要通过平台进 行反馈 并根据自己的权限进行相应数据资源的对外开放 1 数据供给需求 当公众没有找到自己需要的资源时 可以提出资源需求 申请资源归属的 政府部门开放自己的数据 政府部门进行反馈 并根据自己的权限授权开放数 据 2 API 开发需求 政府机构可以根据自己的需要 面向社会的创新创业者发布自己的项 API 开发需求任务 创新创业者可以直接和需求发起方进行对接 接受任务并根据 任务需求提交项目成果 3 微应用开发需求 政府机构可以根据自己的需要 面向其他政府部门或机构发布自己的项微 应用开发需求 其他部门或机构可以直接和需求发起方进行对接 接受任务并 根据任务需求提交项目成果 系统开发项目 详细设计 18 2 1 4 22 1 4 2 界面设计界面设计 2 1 4 32 1 4 3 流程说明流程说明 1 注册用户发布数据资源需求 2 后台用户查询数据资源需求 3 后台用户反馈数据资源需求 4 后台用户确认需求后发布数据资源 5 注册用户通过门户申请使用数据资源 2 1 4 42 1 4 4 输入数据结构输入数据结构 新增数据需求 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1nameString是数据需求名称 2dataDescriptionString是数据需求描述 3dataItemString是数据项 4dataUsageString是数据用途 5departmentString否归属部门 6dataFormatString否数据格式 other 其他 其他对应一致 如 csv 对应 csv 7reqUserString否需求用户 默认为当前创建用户 8areaString否城市 gateway 提供 9userIdString否创建用户 ID gateway 提供 10nameString否创建者姓名 gateway 提供 获取需求申请 参数说明参数说明序号序号参数参数数据类数据类是否必填是否必填参数说明参数说明 系统开发项目 详细设计 19 型型 输入参数输入参数1keywordsString否名称及数据描述 模糊搜索 2beginTimeString否查询开始日期 yyyy MM dd 3endTimeString否查询结束日期 yyyy MM dd 4pageSizeInteger是分页大小 默认 10 5pageInteger是索引页 默认 1 2 1 4 52 1 4 5 处理过程处理过程 请求报文 响应报文 code 000000 message success result dataItem 需求项 publishTime 1480923546000 flag 1 pageviewAmount 7 dataFormat XLS myself 1 reqUser 测试君 datalink 1111 feedbackTime 1480923546000 focusAmount 1 name 数据需求 id 4 feedbackSuggestion 111 department 市民政局 dataUsage 就是测试用的 aaaaaaa status 5 系统开发项目 详细设计 20 status OK 2 1 4 62 1 4 6 输出数据结构输出数据结构 获取需求申请信息 返回值业务参数说明 返回值业务参数说明 result 序号序号参数参数参数说明参数说明 1 name 数据需求名称 2 id 数据需求 ID 3 dataItem 数据项 4 reqUser 发布用户 5 feedbackTime 反馈日期 6 dataFormat 数据格式 xls 等 7 publishTime 发布日期 long 型数字 8 department 归属部门 9 dataUsage 数据用途 10 feedbackSuggestion 反馈意见 11 datalink 数据展现链接 12 pageviewAmount 访问量 13 focusAmount 关注量 14 flag 是否关注 1 已关注 0 未关注 15 myself 是否本人发布需求 0 否 1 是 16 status 需求状态 0 暂存 1 处理中 2 已通过 3 已拒绝 4 已接单 5 已关闭 6 已反馈 2 1 4 72 1 4 7 接口设计接口设计 具体接口 具体接口 新增数据需求接口 获取需求申请列表接口 相关规范 相关规范 访问方式 GET 返回码 返回信息说明 000000 本次请求成功 999999 请求失败 系统开发项目 详细设计 21 2 1 4 82 1 4 8 备注备注 2 1 52 1 5 用户中心用户中心 2 1 5 12 1 5 1 概述概述 用户中心主要包括如下几项功能 1 用户基本信息 用户基本信息 是以文字的形式显示用户的基本信息 内容区包括用户是否实名认证 用户的 APIKey secretKey 手机号码 用户类型的信息 2 实名认证 为确认注册用户身份 方便用户共享和使用数据 保障用户之间的诚信合 作 规避一些不法分子通过平台进行非法操作 平台制定了实名认证规则 期 望通过平台进行数据共享交换的用户必须进行实名认证 平台提供个人用户或者企业用户填写认证信息的页面 用户进行个人认证 需填写的姓名 身份证号码 上传身份证照片 需要做身份证号码校验 企业 认证需填写的基本信息 企业信息 联系人信息等主要内容 3 修改密码 用户通过验证旧密码的方式修改新密码 系统开发项目 详细设计 22 2 1 5 22 1 5 2 界面设计界面设计 2 1 5 32 1 5 3 流程说明流程说明 1 注册用户通过点击用户中心完成实名认证 2 注册用户通过点击用户中心查询数据资源的使用情况 3 注册用户通过点击用户中心查询 API 的资源使用情况 4 注册用户通过点击用户中心查询微应用的资源使用情况 5 注册用户通过点击用户中心进行支付未完成支付资源 2 1 5 42 1 5 4 输入数据结构输入数据结构 注册用户 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1loginNameString是登录名 用户名或手机号 2passwordString是密码 个人实名认证 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1nameString是姓名 2idcardString是身份证号 3certificationTypeString是实名认证类型 01 手机认证 系统开发项目 详细设计 23 4mobileString否手机号 5bankCardNoString否银行卡号 6photoIdString否个人照片 id 添加购物车 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1resourceTypeString是密码 2resourceIdInteger是资源 id 3chargeRuleIdInteger是套餐 id 4applyTimesInteger是申请次数 2 1 5 52 1 5 5 处理过程处理过程 响应报文 code 000000 message success result userId xxx account xty mobileuserType 01 area 0001 userInfo userStatus 01 apiKey ASDFIIOIJNNLSDIJOISNS secretKey ASDKFLJOIQWEIORJSDLKFJASLKDFJKADSF userCertificationInfo certificationType 01 certificationStatus null name 王小二 idcard null 系统开发项目 详细设计 24 photoUrl 47ec9c48a2af42e 0eb30f2442a7d93389d8712ca54bd11373f00178 jpg mobile null bankCardNo null idcardPic1Url null idcardPic2Url null enterpriseCertificationInfo null partnerInfo null status OK 2 1 5 62 1 5 6 输出数据结构输出数据结构 查询用户信息 返回值业务参数说明 返回值业务参数说明 result 参数参数参数说明参数说明 userId 用户 ID account 用户名 mobile 手机号 userType 用户类型 字典码 14 01 创业创新用户 02 合作伙伴 userInfo 创业创新用户信息 详见下方 userInfo 说明 partnerInfo 合作伙伴信息 详见下方 partnerInfo 说明 返回值业务参数说明 返回值业务参数说明 userInfo 参数参数参数说明参数说明 userStatus 用户状态 字典码 15 01 已注册 02 已个人认证 03 已企业认证 apiKey 公钥 系统开发项目 详细设计 25 secretKey 密钥 userCertificationIn fo 个人认证信息 详见下方 userCertificationInfo 说明 enterpriseCertifica tionInfo 企业认证信息 详见下方 enterpriseCertificationInfo 说明 2 1 5 72 1 5 7 接口设计接口设计 具体接口 具体接口 用户注册接口 实名认证接口 添加购物车接口 查询用户信息接口 相关规范 相关规范 访问方式 GET 返回码 返回信息说明 000000 本次请求成功 999999 请求失败 2 1 5 82 1 5 8 备注备注 2 2 数据应用平台数据应用平台 2 2 12 2 1 PAASPAAS 服务平台服务平台 2 2 1 12 2 1 1 概述概述 PAAS 平台通过平台化和组件化的方式 帮助使用者快速进行云环境中经济高效 无缝地构建 部署和管理负载 同时保障开放性和超强的安全性 该平台具有如下特点 基于 Docker 容器引擎 提供高度可扩展和高性能的容器管理服务 提供自动持续集成服务 打通 dev ops 之间的鸿沟 提高开发和 IT 运维效 率 应用的自动化全生命周期管理 用户注册 持续集成 应用监控 系统开发项目 详细设计 26 提供一站式管理控制台 简单 高效 易用 2 2 1 22 2 1 2 界面设计界面设计 2 2 1 32 2 1 3 流程说明流程说明 1 用户通过平台进行远程镜像配置 2 用户通过平台进行应用程序设置 3 用户通过平台进行程序发布 4 用户通过平台进行程序的使用情况监控 5 用户通过平台进行监控 CPU 等资源使用情况 6 用户通过平台进行集群管理 2 2 1 42 2 1 4 输入数据结构输入数据结构 用户注册 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1loginNameString是登录名 用户名或手机号 2ninchengString是昵称 3youxiangString是邮箱 4lianxiString是联系方式 持续集成 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1yuandaimaString是源代码 2codeString是密码 系统开发项目 详细设计 27 应用监控 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1yuandaimaString是策略名称 2codeString是策略类型 3ZhouqiString是监控周期 4ruleString是监控规则 镜像仓库 私有镜像的版本 部起停卸的超时时间 启动脚本等 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1BanbenString是版本名称 2TimeString是超时时间 3JiaobenString是启动脚本 IAAS 接入 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1AddressString是接入地址 2NameString是用户名 3CodeString是密码 集群管理 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1NameString是集群名称 2NetworkString是集群网络 应用负载 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1DuankouString是负载端口 2BaowenString是报文 3LeixingString是协议类型 4FangwenString是访问端口 2 2 1 52 2 1 5 处理过程处理过程 用户注册 校验用户输入值合法性 提交数据库注册 如邮箱或手机号码的全局唯一性 系统开发项目 详细设计 28 用户名全局唯一性校验 持续集成 用户第三方源代码托管系统通过认证后 clone 并根据 dockerfile 文件构建出私有 的 docker 镜像 应用监控 应用部署 将应用镜像从仓库拉取到 node 上 应用启动 为应用创建容器 并启动应用 应用停止 将应用容器停止 应用卸载 删除应用容器及相关的网络信息 镜像仓库 添加时将私有镜像信息保存入库 当执行删除版本操作时 将镜像从仓库中删 除 IAAS 接入 根据设置的参数从 IAAS 里获取可用虚拟机 集群管理 创建集群完成 存数据库 应用负载 若为一级负载 将负载信息保存到 paas 平台的 nginx 中 并为应用做端口映射 若为二级负载 将负载信息保存到二级负载均衡器中 不用做端口映射 2 2 1 62 2 1 6 输出数据结构输出数据结构 用户注册 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1loginNameString是登录名 用户名或手机号 2CodeString是密码 持续集成 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1DocumentString是Docker 镜像文件 系统开发项目 详细设计 29 2RizhiString是日志文件 应用监控 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1CPUString是CPU 使用率 2NeicunString是内存使用率 IAAS 接入 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1AddressString是接入地址 2NameString是用户名 3CodeString是密码 应用负载 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1DuankouString是负载端口 2BaowenString是报文 3LeixingString是协议类型 4FangwenString是访问端口 2 2 1 72 2 1 7 接口设计接口设计 具体接口 具体接口 用户注册接口 远程镜像接口 持续集成接口 应用负载接口 相关规范 相关规范 访问方式 GET 返回码 返回信息说明 000000 本次请求成功 999999 请求失败 系统开发项目 详细设计 30 2 2 1 82 2 1 8 备注备注 2 2 22 2 2 资源管理资源管理 2 2 2 12 2 2 1 概述概述 资源管理系统是业务支撑的核心组成系统之一 主要进行大数据及其 应用资产的维护 发布 定价以及对外提供服务等方面的大数据资产管理 大数据资源管理主要管理数据 含数据报告 API 微服务 SaaS 应用以及资讯等与数据资产相关的内容 以便安全 方便地对外提供服务 其中数据是直接对外提供原始或加工的数据形式提供服务 如数据集文件 及或数据报告等形式 API 微服务或 SaaS 应用是对大数据进行应用加工 针对特定服务对象提供的数据服务 2 2 2 22 2 2 2 界面设计界面设计 2 2 2 32 2 2 3 流程说明流程说明 1 用户通过后台进行数据文件的发布 下架 2 用户通过后台进行 API 的发布 下架 编辑 3 用户通过后台进行微应用的发布 下架 编辑 2 2 2 42 2 2 4 输入数据结构输入数据结构 数据的发布与编辑 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1serviceObjectString否服务对象 如果多个以英文 分隔 2scopeString否范围 系统开发项目 详细设计 31 3orgIdInt否机构 ID 4categoryIdInt否分类 ID 5tagIdString否标签 ID 多个以 分隔 6chargeTypeString否收费类型 01 免费 02 收费 7keywordString否关键字 8orderByString否排序字段 不传为默认排序 1 为开放 顺序 2 为访问量 9pageInt否需要查询的页面 默认为 0 10pageSizeInt否每页显示数量 默认为 10 HEADER1mscx area codeString是区域 ID 云接口的发布与编辑 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数1scopeString是服务范围 2cnameString是服务名称 3nameString是服务标识 4descriptionString否服务简介 5imageUriString是服务图标 6categoryIdInteger是服务分类 7tagsString是标签 多个用逗号分隔 8rtnCodeString是服务返回码 9serviceObjectString是服务对象 10chargeSetJsonString否套餐 JSON 字符串 见下文说明 收费 套餐必填 11apiListJsonString是API 列表 JSON 字符串 见下文说明 12imageKeyString是Ali 图片 key 13chargeTypeString是收费类型 01 免费 02 收费 14typeString是Api 服务类型 Header1mscx area codeString是区域 ID 2mscx user dataString是当前用户信息 云服务的发布与编辑 参数说明参数说明 序号序号参数参数数据类数据类 型型 是否必填是否必填参数说明参数说明 输入参数输入参数 1appJSONOb ject 是 identifyString 是微服务标识 系统开发项目 详细设计 32 nameString是微服务名称 categoryIdInteger是分类 id tagsString是标签 id 列表 多个 id 以英文逗号隔开 imageKeyString 是图片 key serviceObjectString是根据字典表传 code 多个以逗号隔开 scopeString是服务范围 demoUriString是演示地址 uriString是访问地址 demoKey1String否文件 key demoKey2String否文件 key demoKey3String否文件 key descriptionString 是微服务描述 2 2 2 52 2 2 5 处理过程处理过程 发布类处理过程发布类处理过程 请求报文 service publishServiceApi do Headers mscx user data name admin userId 10000 mscx area code 440100 RequestBody 响应报文 code 000000 message success result 1 status OK 获取信息类处理过程获取信息类处理过程 成功响应报文 code 000000 message success result area 440100 updatedTime 1481533936000 dataId 53 系统开发项目 详细设计 33 price 10 name 数据 1 chargeType 02 description 数据描述 1 status 0 area 440100 updatedTime 1481535787000 dataId 54 name xxx chargeType 01 description xxx status 1 status OK 失败报文 code 999999 message result status ERROR 系统开发项目 详细设计 34 2 2 2 62 2 2 6 输出数据结构输出数据结构 输出参数输出参数 Response 值说明值说明 序号序号参数参数参数说明参数说明 1 code 返回码 详见下方 返回码 返回信息说明 2 message 返回信息 3 status 返回状态 OK 成功 ERROR 失败 4 result 用户业务信息 详见下方 result 说明 2 2 2 72 2 2 7 接口设计接口设计 具体接口 具体接口 开发数据发布与编辑接口 云接口发布与编辑接口 云服务发布与编辑接口 相关规范 相关规范 访问方式 GET 返回码 返回信息说明 000000 本次请求成功 999999 请求失败 2 2 2 82 2 2 8 备注备注 2 2 32 2 3 资源图谱资源图谱 2 2 3 12 2 3 1 概述概述 一 资源管理 目录维护 目录维护功能是由运营管理人员维护图谱内的子类 资源等子节点的 页面 根据目录维护的子类和资源关系 生成资源画像图谱 资源维护 资源维护功能是由运营管理人员维护资源各类属性的页面 根据维护 的资源属性 生成资源属性图谱 系统开发项目 详细设计 35 关系管理 关系管理功能是由运营管理人员维护各类资源间调用关系的页面 手 工维护本资源需要调用哪些其它资源 自动匹配本资源由哪些资源调用 由哪些用户调用 由哪些用户曾经调用 根据以上关系 生成资源调用关 系图谱 场景管理 场景管理功能记录资源筛选功能中 所有人员生成的场景资源列表 用户生成的场景列表 可做为运营管理人员定义目录子类的参考依据 二 资源图谱 资源全景 资源全景功能将平台已有资源生成资源图表 平台使用者可通过搜索 高级搜索等功能 寻找到所需资源 资源画像 资源画像功能将平台已维护的生成