GB/T 33780.3-2017 基于云计算的电子政务公共平台技术规范 第3部分：系统和数据接口

　　ICS 35 . 240 . 0 1 L 67

　　中 华 人 民 共 和 国 国 家 标 准

　　GB/T 33780 . 3—2017

　　基于云计算的电子政务公共平台技术规范 第 3 部分：系统和数据接口

　　Technicalspecificationofelectronicgovernmentcommonplatform basedon

　　cloudcomputing—part3：Interfacebetweensystem anddata

　　2017-05-31 发布 2017-12-01 实施

　　中华人民共和国国家质量监督检验检疫总局中 国 国 家 标 准 化 管 理 委 员 会

　　发

　　布

　　GB/T 33780 . 3—20 17

　　GB/T 33780 . 3—20 17

　　前 言

　　GB/T 33780《基于云计算的电子政务公共平台技术规范》预计分为以下 6 个部分：

　　— 第 1 部分：系统架构;

　　— 第 2 部分：功能和性能;

　　— 第 3 部分：系统和数据接口;

　　— 第 4 部分：操作系统基本要求;

　　— 第 5 部分：信息资源开放共享系统架构;

　　— 第 6 部分：服务测试。

　　本部分为 GB/T 33780 的第 3 部分。

　　本部分按照 GB/T 1 . 1—2009 给出的规则起草。

　　请注意本文件的某些内容可能涉及专利。 本文件的发布机构不承担识别这些专利的责任。

　　本部分由中华人民共和国工业和信息化部提出。

　　本部分由中华人民共和国工业和信息化部(通信)归口 。

　　本部分起草单位：西安未来国际信息股份有限公司、浙江建达科技股份有限公司、湖南科创信息技术股份有限公司、北京中软国际信息技术有限公司、中国信息通信研究院、中国移动通信集团有限公司、曙光信息产业股份有限公司、神州数码系统集成服务有限公司。

　　本部分主要起草人：王茜、葛新、刘守仓、何舰、邵云华、段延辉、马飞、王凤、张晓辉、郑颖。

　　GB/T 33780 . 3—20 17

　　引

　　言

　　电子政务发展正处于转变发展方式、深化应用和突出成效的关键转型期。 政府职能转变和服务型政府建设对电子政务发展提出了更新更高要求。 以云计算为代表的新兴信息技术、产业、应用不断涌现，深刻改变了电子政务发展技术环境及条件。 构建基于云计算的电子政务公共平台可以充分发挥既有资源的作用和新兴信息技术潜能，加快电子政务发展创新，提高应用支撑服务能力，增强安全保障能力，减少重复建设、避免各自为政和信息孤岛。

　　在电子政务公共平台建设过程中客观形成了物理上分布、功能相互独立的基础设施资源和应用系统等信息系统资源。 基于云计算的电子政务公共平台要充分利用这些信息系统资源，通过虚拟化等云计算技术，形成逻辑上统一的“资源池”和面向用户的“服务交付渠道”，在此过程中产生了各种类型应用系统之间的接口关系。 本部分主要解决应用系统迁移、分布部署的电子政务公共平台通过互联互通形成更大范围的资源服务池过程中出现的技术接口问题。 因此，在电子政务公共平台资源和服务构成要素中，网络、主机、存储、操作系统、数据库管理系统、应用服务器中间件等已经具有的接口技术规范和相互之间已经具有的接口技术规范，在本部分中将加以引用;在与应用系统实施系统集成、部署、迁移过程中产生的接口需求，本部分将提出系统和数据访问接口的接口功能、访问协议、访问方式等技术要求。

　　本部分不规定接口的具体实现，也不规定接口的应用指南。 公共平台服务提供机构可依据本部分提出的系统和数据接口技术规范实施接口实例，公布接口应用方法。

　　GB/T 33780 . 3—20 17

　　基于云计算的电子政务公共平台技术

　　规范 第 3 部分：系统和数据接口

　　1 范围

　　GB/T 33780 的本部分规定了电子政务公共平台之间的系统和数据接口的接口功能、访问协议、访问方式等技术要求。

　　本部分适用于基于云计算的电子政务公共平台。

　　注：除非特殊说明，以下各章中“电子政务公共平台”和“公共平台”均指“基于云计算的电子政务公共平台”。

　　2 规范性引用文件

　　下列文件对于本文件的应用是必不可少的。 凡是注 日期的引用文件，仅注 日期的版本适用于本文件 。凡是不注日期的引用文件，其最新版本(包括所有的修改单)适用于本文件。

　　GB/T 21062—2007 政务信息资源交换体系

　　GB/T 21063—2007 政务信息资源目录体系

　　GB/T 34078 . 1—2017 基于云计算的电子政务公共平台总体规范 第 1 部分：术语和定义

　　3 术语、定义和缩略语

　　3 . 1 术语和定义

　　GB/T 34078 . 1—2017 界定的术语和定义适用于本文件。

　　3 . 2 缩略语

　　下列缩略语适用于本文件。

　　API：应用程序编程接口(Application Programming Interface)

　　B/S：浏览器/服务器模式(Browser/Server)

　　DHCP：动态主机配置协议(Dynamic Host Configuration Protocol)

　　DNAT：动态地址转换(DynamicNet Address Trancelate)

　　DNS：域名系统(Domain Name System)

　　FTP：文件传输协议(File Transfer Protocol)

　　HTTP：超文本传送协议(Hypertext Transfer Protocol)

　　IP：网络之间互联的协议(Internet Protocol)

　　iSCSI：小型计算机系统接 口 (Internet Small Computer System Interface)

　　JMS:Java 消息服务(Java Message Service)

　　JSON：轻量级的数据交换格式(JavaScript Object Notation)

　　MAN：城域网(Metropolitan Area Network)

　　NAT：网络地址转换(Network Address Translation)

　　NFS：网络文件系统(Network File System)

　　OTN：光传送网(Optical Transport Network)

　　GB/T 33780 . 3—20 17

　　PIN：个人识别密码(Personal Identification Number)

　　PPP：点对点协议(Point to Point Protocol)

　　RESTful：一个架构样式的网络系统(Representional State Transter)

　　SNAT：静态地址转换(StaticNet Address Trancelate)

　　SDH：同步数字体系(Synchronous Digital Hierarchy)

　　SOAP：简单对象访问协议(Simple Object Access Protocol)

　　SONET：同步光纤网络(Synchronous Optical Network)

　　SQL：结构化查询语言(Structured Query Language)

　　TCP：传输控制协议(Transmission Control Protocol)

　　URL：统一资源定位符(Uniform Resource Locator)

　　VLAN：虚拟局域网(Virtual Local Area Network)

　　WSDL：描述 Web 服务和通信的 XML语言(Web Services Description Language)

　　XML：可扩展标记语言(Extensible Markup Language)

　　4 概述

　　为满足应用系统集成、部署、迁移和运行的需求，根据公共平台管理对象的划分，电子政务公共平台和应用系统应提供网络系统互联互通接口、主机系统接口、数据库版本转换接口、数据共享接口 、应用系统与应用服务器中间件接口、应用服务器互操作接口、应用系统互操作调用接口、公共平台资源服务管理接口 。 系统和数据接口应封装操作过程实现细节，只向外暴露访问方式和输入参数。

　　根据电子政务公共平台管理对象之间的关联关系，主机系统接口包括虚拟主机与网络系统接口 、虚拟主机与存储设备接口 、虚拟主机与应用服务器接口 、虚拟主机和应用系统接口 。

　　电子政务公共平台之间的资源管理、调度和监控通过资源服务管理接口完成，公共平台之间不能直接进行互操作。

　　系统与数据接口关系图参见附录 A。

　　5 网络系统互联互通接口

　　网络系统互联互通接口的要求如下：

　　a) 接口名称：pt1。

　　b) 协议：以太网、PPP。

　　c) 接口功能：应基于通信运营商或自建传输网所提供的 SDH、OTN、裸光纤等不同传输协议的传输线路，通过局域网络接入标准，骨干传输网接入标准达到互联互通，具体包括：

　　1) 局域网络接入接口：应支持电口或光口两种，其中电口应支持 100 M 和 1 000 M。 100 M以太网电口，应基于 5 类双绞电缆连接，距离不超过 100 m ; 1 000 M 以太网电口，应基于6 类双绞电缆连接，距离不超过 100 m;光 口，应基于综合布线室内光缆连接，末端接口应支持 LC、SC、FC等不同的光纤接口类型。

　　2) 骨 干 传 输 网 接 入 接 口：应 基 于 SDH 传 输 协 议，支 持 E1 接 口 或 CPOS 接 口，应 提 供2 M/4 M/8 M~155 M等带宽需求;基于波分协议传输，应支持电口或光口，可提供最低100 M~1 000 M等带宽需求。 电口接口标准参照局域网接入接口电口标准，光口接口标准参照局域网接入接口光口标准;基于裸光纤传输，应支持 LC、SC接口，可提供大于等于千兆带宽，接口标准参照局域网接入接口光口标准。

　　3) 局域网接入接口和骨干传输网接入接口应适应随着网络带宽不断增加而产生的接口类型

　　GB/T 33780 . 3—20 17

　　变化。

　　d) 接口方法：参见附录 B 中的 B. 1 。

　　6 主机系统接口

　　6 . 1 虚拟主机与网络系统接口

　　虚拟主机与网络系统接口的要求如下：

　　a) 接口名称：pt2_1。

　　b) 协议：http/https。

　　c) 调用参数：输入{操作上下文，路由名称，路由标识，代理标识，外部网关端口，接口名称，外部网关无类间路由，接口信息，网络标识，主机标识，网络名称，子网，租户标识，端口标识，浮动 IP,防火墙规则，防火墙规则 ID,防火墙策略｝。

　　d) 返回值：{逻辑值 true/false, 网络信息，路由信息，防火墙信息｝。

　　e) 接口功能 ：

　　1) 网络系统应为虚拟主机提供高速存储网络;

　　2) 网络系统应为虚拟主机提供可靠管理网络;

　　3) 网络系统应为虚拟主机提供高速虚拟网络;

　　4) 网络系统应为虚拟主机提供高速公共网络;

　　5) 虚拟主机应提供基于 L3 层虚拟路由功能;

　　6) 虚拟主机应提供基于 DHCP协议的 IP分配功能;

　　7) 虚拟主机应提供基于 DNS协议的域名解析功能;

　　8) 虚拟主机应提供基于 L2 层虚拟链接交换功能;

　　9) 虚拟主机应提供基于 iptable 的 NAT转发功能;

　　10) 虚拟主机应提供基于 L4-7 层虚拟防火墙策略功能;

　　11) 虚拟主机应提供基于虚拟设备(虚拟网卡)与虚拟主机之间的映射功能。

　　f) 接口方法：参见 B. 2 . 1 。

　　6 . 2 虚拟主机与应用服务器中间件接口

　　虚拟主机与应用服务器中间件接口的要求如下：

　　a) 接口名称：pt2_2。

　　b) 协议：http/https。

　　c) 调用参数：输入{主机 IP 或域名，端口，用户名，密码，登录上下文，源文件，目标，校验和｝。

　　d) 返回值：{逻辑值 true/false,成功/失败｝。

　　e) 接口功能 ：

　　1) 虚拟主机应为应用服务器中间件提供软件包本地上传与下载功能;

　　2) 虚拟主机应为应用服务器中间件提供软件包校验与防病毒;

　　3) 虚拟主机应为应用服务器中间件提供软件包在线更新与下载功能;

　　4) 虚拟主机应为应用服务器中间件提供版本管理功能;

　　5) 虚拟主机与应用服务器中间件提供编排功能。

　　f) 接口方法：参见 B. 2 . 2 。

　　6 . 3 虚拟主机与应用系统接口

　　虚拟主机与应用系统接口的要求如下：

　　GB/T 33780 . 3—20 17

　　a) 接口名称：pt2_3。

　　b) 协议：http/https/FTP。

　　c) 调用参数：输入{主机 IP 或域名，端口，用户名，密码，登录上下文，源文件，目标，校验和，虚拟主机 ID, 目标服务器，资源池名称，资源池描述，提供者，子网，协议，轮询方法｝。

　　d) 返回值：{逻辑值 true/false,成功/失败｝。

　　e) 接口功能 ：

　　1) 虚拟主机应为应用系统软件包提供本地上传与下载功能;

　　2) 虚拟主机应为应用系统软件包提供校验与防病毒功能;

　　3) 虚拟主机应为与应用系统提供整体在线迁移功能;

　　4) 虚拟主机应为应用系统提供负载均衡功能。

　　f) 接口方法：参见 B. 2 . 3 。

　　6 . 4 虚拟主机与存储设备接口

　　虚拟主机与存储设备接口的要求如下：

　　a) 接口名称：pt2_4。

　　b) 协议：http/https。

　　c) 调用参数：输入{操作上下文，云硬盘 id, 云主机 ID,主机名，挂载点｝。

　　d) 返回值：{逻辑值 true/false,成功/失败｝。

　　e) 接口功能 ：

　　1) 虚拟主机应提供存储设备的挂载与卸载;

　　2) 虚拟主机应提供存储设备创建与销毁;

　　3) 虚拟主机应提供存储设备备份与恢复。

　　f) 接口方法：参见 B. 2 . 4 。

　　7 数据库版本转换接口

　　数据库版本转换接口要求如下：

　　a) 接口名称：pt3。

　　b) 接口协议：SOAP/Webservice。

　　c) 调用参数：输入{源数据库类型，源数据库版本，源数据库 IP 地址，源数据库服务端 口，源数据库名称，源数据库待迁移数据表列表，源数据库访问用户名，源数据库访问用户的密码，目标数据库类型，目标数据库版本，目标数据库 IP 地址，目标数据库服务端口，目标数据库名称，目标数据库数据迁移表列表，目标数据库访问用户名，目标数据库访问用户的密码，待适配和转换SQL语句｝。

　　d) 返回值：{逻辑值 true/false,适配和转换后的 SQL语句｝。

　　e) 接口功能：提供应用系统在异构数据库和相同数据库不同版本之间的数据部署和迁移接口 。

　　1) 应提供在关系数据库管理系统、大数据系统等异构系统之间，实现 API 级的数据迁移和数据转换;

　　2) 应提供在相同数据库管理系统不同版本之间，实现 SQL语言的适配和转换;

　　3) 应提供在异构数据库管理系统之间，实现不同数据类型的适配和转换;

　　4) 应提供在相同数据库管理系统不同版本之间，实现不同数据类型的适配和转换;

　　5) 应以 XML/JSON 等格式文件为中间媒介，实现在异构数据库管理系统和相同数据库管理系统不同版本之间的数据转换。

　　GB/T 33780 . 3—20 17

　　f) 接口方法：参见 B. 3 。

　　8 数据共享接口

　　数据共享接口要求如下：

　　a) 接口名称：pt4 。

　　b) 接口协议：JMS/SOAP/Webservice。

　　c) 调用参数：输入{ 目录编号，目录元数据和值，目录名称，目录分类编号，目录内容，数据交换发送方路由编号，待交换的数据 ，数据交换接收方路由编号，认证信息｝。

　　d) 返回值：{逻辑值 true/false}。

　　e) 接口功能：应提供数据资源目录服务接口、数据交换接口、数据转换接口和数据服务接口，实现不同应用系统之间的数据共享。

　　1) 目录服务接口应提供数据资源的发现、注册、编 目 、发布和检索的功能，接口技术要求参考GB/T 21062—2007 。

　　2) 数据交换接口应提供结构化、半结构化和非结构化数据的交换功能，接口技术要求参考GB/T 21063—2007 。

　　3) 数据转换接口应提供将非标准格式数据转换为标准格式数据的功能。

　　4) 数据服务接口应提供将数据资源封装为数据服务，并实现数据服务的调度和管理的功能。

　　f) 接口方法：参见 B. 4 。

　　9 应用系统与应用服务器中间件接口

　　应用系统与应用服务器中间件接口要求如下：

　　a) 接口名称：pt5 。

　　b) 接口协议：http/Soap/RESTful。

　　c) 调用参数：输入{源系统描述数据体， 目标系统描述数据体，转换等级，系统的 目标部署环境描述数据体，目标部署系统描述数据体，部署参数数据体，需要进行迁移的系统描述数据体，需要转换的目标部署系统描述数据体，迁移参数数据体==需要进行监控的系统描述数据体，业务系统监控管理适配器，监控、管理参数数据体，源业务系统服务描述数据体， 目标业务系统服务描述数据体，接口转换参数描述数据体｝。

　　d) 返回值：{转换结果，部署结果，迁移结果，适配结果，服务接口转换结果｝。

　　e) 接口功能：应提供应用系统与不同的应用服务器以及相同的应用服务器不同版本之间的打包、部署、迁移和服务接口 。

　　1) 打包接口应提供应用系统基于不同应用服务器中间件及相同应用服务器中间件不同版本之间的打包和转换功能;

　　2) 部署接口应提供应用系统基于不同应用服务器中间件及相同应用服务器中间件不同版本之间的部署功能;

　　3) 迁移接口应提供应用系统基于不同应用服务器中间件及相同应用服务器中间件不同版本之间的迁移功能;

　　4) 服务接口应提供应用系统基于不同应用服务器中间件及相同应用服务器中间件不同版本之间运行的管理、监控等服务功能;

　　5) 应为应用系统提供跨运行平台、跨开发语言的服务调用接口 。

　　f) 接口方法：参见 B. 5 。

　　GB/T 33780 . 3—20 17

　　10 应用服务器中间件互操作接口

　　应用服务器中间件互操作接口要求如下：

　　a) 接口名称：pt6。

　　b) 协议：http/https/Soap/RESTful。

　　c) 调用参数：无。

　　d) 返回值：无。

　　e) 接口功能：应提供异构应用服务器中间件之间的互操作与应用集群管理。

　　1) 提供同构应用服务器中间件之间的互操作功能，跨异构应用服务器中间件的互操作具备运行平台无关性和编程语言无关性;

　　2) 提供应用系统集群接口，同一应用系统的不同实例可跨同构应用服务器中间件实现集群部署;

　　3) 提供分布式部署接口，应用系统的不同构件可分布部署在异构的应用服务器中间件中。

　　f) 接口方法：参见 B. 6 。

　　1 1 应用系统互操作调用接口

　　应用系统互操作调用接口如下：

　　a) 接口名称：pt7。

　　b) 接口协议：http/Soap/RESTful/Socket。

　　c) 调用参数：输入{远程网络地址，远程服务端口，通信内容，本地监听端口，用户唯一标识符，用户 口令，数字证书唯一识别码，数字证书 PIN 码｝。

　　d) 返回值：{通信完成状态标识，身份认证结果标识｝。

　　e) 接口功能：应提供应用系统与不同的中间件以及相同的中间件不同版本之间的打包、部署、迁移和服务接口 。

　　1) 应提供应用系统之间互调用的方法和参数，支持跨平台、跨编程语言的访问方式;

　　2) 应支持同步、异步消息通讯的调用方式;

　　3) 应支持应用系统之间互调用的身份认证和单点登录。

　　f) 接口方法：参见 B. 7 。

　　12 公共平台资源服务管理接口

　　公共平台资源服务管理接口要求如下：

　　a) 接口名称：pt8。

　　b) 协议：http/https。

　　c) 调用参数：输入{用户唯一识别身份编码，用户身份口令，数字证书识别码，资源域编码，模板id,资源名称，内存和 CPU,资源个数，服务时间，资源 id,平台服务 ip,系统报文｝。

　　d) 返回值：{认证成功或失败，用户授权可访问信息，资源 id 和名称｝。

　　e) 接口功能：公共平台应提供跨区域的主机、存储、支撑软件、运维监控、安全保障等服务资源共享与调度访问接口 。

　　1) 应提供远程租户与用户访问的认证与授权功能，通过提供身份认证 key,验证该调用方身份和权限，并获用户账号下可用的服务资源授权清单;

　　GB/T 33780 . 3—20 17

　　2) 应提供虚拟主机资源远程管理与访问功能;

　　3) 应提供对存储远程管理与操作功能;

　　4) 应提供支撑软件远程管理功能;

　　5) 应提供对应用系统的管理与监控功能;

　　6) 应提供监控信息项跨区域推送功能;

　　7) 应提供安全支撑服务远程管理功能;

　　8) 应提供公共平台计算资源地址、数据库资源地址、数据共享资源地址、中间件资源地址的功能。

　　f) 接口方法：参见 B. 8 。

　　GB/T 33780 . 3—20 17

　　附 录 A

　　(资料性附录)

　　系统和数据接口关系图

　　A.1 公共平台系统和数据接口关系

　　图 A.1 公共平台系统和数据接口关系图

　　如图 A. 1 所示，公共平台之间的接口是资源服务管理接口层(公共平台资源服务管理接口)。公共平台内的资源和服务共享接口模型从底层到上层应用服务依次是网络接口层(网络系统互联互通接口)，存储接口层和虚拟主机接口层(主机系统接口)、应用服务器接口层(应用系统与应用服务器接 口 、应用服务器互操作接口)和数据接口层(数据库版本转换接口、数据共享接口)以及应用系统接口层(应用系统互操作接口);每个接口层的接口按照业务系统部署、迁移和资源服务共享需求定义接口功能、访问协议、访问方法，并遵循国家已发布的相关接口规范。

　　A.2 主机系统功能接口对照表

　　A.2 . 1 虚拟主机与网络功能接口的对照关系见表 A. 1~表 A. 5 。

　　表 A.1 基于 L3 层虚拟路由方法

　　GB/T 33780 . 3—20 17

　　表 A.1(续)

　　表 A.2 基于 L3 层虚拟路由方法

　　表 A.3 基于 L2 层虚拟链接交换方法

　　GB/T 33780 . 3—20 17

　　表 A.4 基于 iptable的 NAT转发方法

　　表 A.5 基于 L4-7 层虚拟防火墙策略方法

　　A.2 . 2 虚拟主机与应用服务器中间件接口对照关系见表 A. 6 。

　　表 A.6 虚拟主机与应用服务器中间件接口功能对照表

　　A.2 . 3 虚拟主机与应用系统接口对照关系见表 A. 7 。

　　GB/T 33780 . 3—20 17

　　表 A.7 虚拟主机与应用系统接口功能对照表

　　A.2 . 4 虚拟主机与存储设备接口对照关系表 A. 8 。

　　表 A.8 虚拟主机与存储设备接口功能对照表

　　A.3 数据库版本转换功能接口对照关系

　　数据库版本转换功能接口对照关系见表 A. 9 。

　　表 A.9 数据库版本转换功能接口对照表

　　GB/T 33780 . 3—20 17

　　表 A.9(续)

　　A.4 数据共享接口对照关系

　　数据共享接口对照关系见表 A. 10 。

　　表 A.10 数据共享接口对照表

　　A.5 应用服务与应用服务器中间件接口对照关系

　　应用服务与应用服务器中间件接口对照关系参见表 A. 11 。

　　表 A.11 应用服务与应用服务器中间件接口功能对照表

　　GB/T 33780 . 3—20 17

　　A.6 应用系统互操作接口对照关系

　　应用系统互操作接口对照关系参见表 A. 12 。

　　表 A.12 应用系统互操作接口功能对照表

　　A.7 公共平台资源服务管理接口对照关系

　　公共平台资源服务管理接口对照关系参见表 A. 13 。

　　表 A.13 公共平台资源服务管理接口功能对照表

　　GB/T 33780 . 3—20 17

　　附 录 B

　　(资料性附录)接口方法描述

　　B.1 网络系统互连互通接口

　　网络系统互连互通接口的详细要求如下：

　　a) 局域网终端接入。 局域网终端用户接口方法，可使用千兆电口直接接入终端，例如：PC、网络打印机、网络传真等。

　　b ) 局域网内设备间接入。 局域网内设备间互联，应根据两端设备提供的接口介质进行接入，例如：一端设备提供 LC光接口，另一端设备提供 SC 光接 口，两端设备连接需要采用 LC-SC 的光纤进行连接;若两端设备都提供千兆电 口，两端需要使用标准的 6 类双绞线(网线)进行互联。

　　c) 骨干传输网互联接入。 骨干传输网互联，应根据两端设备提供的接口介质进行接入，例如：一端设备提供 E1 接 口，另一端设备提供 CPOS业务光接 口(接口类型 LC),两端设备连接需要运营商采用 SDH 传输协议提供线路，CPOS 接口要提供 LC 光纤接入;若两端设备都只能提供电口接入，运营商在接入末端需要增加直接提供电口的传输设备，利用双绞线直接接入网络设备;若两端设备可提供光口接入，运营商在接入末端需要提供可直接接入网络设备的光接口类型接入，例如直接提供 LC、SC接口类型的光纤接入网络设备。

　　B.2 主机系统接口

　　B.2 . 1 虚拟主机与网络系统接口

　　虚拟主机与网络系统接口实现的示例如下：

　　a) 基于 L3 层虚拟路由方法：

　　1) 创建路由方法：

　　【方法原型】router_added (router_id, router)。

　　【方法功能】创建一个新的本地路由。

　　【参数说明】router_id：路由 ID;

　　route：路由名称。

　　【返回值】成功/失败。

　　【使用方法】接口运行在远程服务器上，发起者调用该接口，传递参数，创建路由。

　　【提示】创建成功/失败。

　　2) 删除路由方法：

　　【方法原型】router_deleted (context, router_id)。

　　【方法功能】删除路由方法。

　　【参数说明】context：操作上下文;

　　router_id：路由 ID。

　　【返回值】成功/失败。

　　GB/T 33780 . 3—20 17

　　【使用方法】接口运行在远程服务器上，发起者调用该接口，传递参数，删除路由。

　　【提示】删除成功/失败。

　　3) 添加路由到代理方法：

　　【方法原型】add_router_to_l3_agent(context, id, router_id)。

　　【方法功能】添加路由至 L3 代理。

　　【参数说明】context：操作上下文;

　　id：代理 ID ;

　　router_id：路由 ID。

　　【返回值】成功/失败。

　　【使用方法】接口运行在远程服务器上，发起者调用该接口，传递参数，返回添加路由结果。 【提示】添加成功/失败。

　　4) 从代理中删除路由方法：

　　【方法原型】remove_router_from_l3_agent (context, l3_agent, router_id)。

　　【方法功能】从 L3 代理中删除路由。

　　【参数说明】context：操作上下文;

　　l3_agent：代理 ID;

　　router_id：路由 ID。

　　【返回值】成功/失败。

　　【使用方法】接口运行在远程服务器上，发起者调用该接口，传递参数，删除代理中的路由。 【提示】删除成功/失败。

　　5) 设置外部网关方法：

　　【方法原型】external_gateway_added (ri , ex_gw_port, interface_name, internal_cidrs)。

　　【方法功能】设置路由的外部网关。

　　【参数说明】ri：路由信息;

　　Ex_gw_port：外部网关端 口;

　　Interface_name：接口名称;

　　Internal_cidrs：外部网关无类间路由。

　　【返回值】成功/失败。

　　【使用方法】接口运行在远程服务器上，发起者调用该接口，传递参数，设置外部网关。

　　【提示】设置外部网关成功/失败。

　　6) 删除外部网关方法：

　　【方法原型】external_gateway_removed (ri , ex_gw_port,interface_name, internal_cidrs)。

　　【方法功能】从路由器中删除一个外部网关。

　　【参数说明】ri：路由信息;

　　Ex_gw_port：外部网关端 口;

　　Interface_name：接口名称;

　　Internal_cidrs：外部网关无类间路由。

　　【返回值】成功/失败。

　　【使用方法】接口运行在远程服务器上，发起者调用该接口，传递参数，删除外部网关。

　　【提示】外部网关删除成功/失败。

　　7) 添加路由接口方法：

　　【方法原型】add_router_interface (context, router_id, interface_info)。

　　【方法功能】为路由器添加一个内部网关。

　　GB/T 33780 . 3—20 17

　　【参数说明】context：操作上下文;

　　Route_id：路由 ID;

　　Interface_info：接口信息。

　　【返回值】router_iface_info：路由接口信息。

　　【使用方法】接口运行在远程服务器上，发起者调用该接口，传递参数，添加路由接口信息。 【提示】接口添加/成功。

　　8) 移除路由接口方法：

　　【方法原型】remove_router_interface (context, router_id, interface_info)。

　　【方法功能】从路由器内移除一个内部网关。

　　【参数说明】context：操作上下文;

　　Route_id：路由 ID;

　　Interface_info：接口信息。

　　【返回值】del_ret：删除结果。

　　【使用方法】接口运行在远程服务器上，发起者调用该接口，传递参数，删除路由接口 。

　　【提示】删除接口成功/失败。

　　b) 基于 DHCP协议的 IP分配方法：

　　1) 列出所有网络 DHCP代理方法：

　　【方法原型】list_dhcp_agents_hosting_network(context, network_id)。

　　【方法功能】列出所选网络的 DHCP代理。

　　【参数说明】context：操作上下文;

　　network_id：网络 id。

　　【返回值】包含列出代理的字典。

　　【使用方法】发起者调用该接口，传递参数，将会返回包含列出代理的字典。

　　【提示】无。

　　2) 为网络添加代理方法：

　　【方法原型】network_added_to_agent(context, network_id, host)。

　　【方法功能】为网络添加 DHCP代理。

　　【参数说明】context：操作上下文;

　　network_id：网络 id;

　　host：主机 。

　　【返回值】成功/失败。

　　【使用方法】发起者调用该接口，传递参数，将为网络添加指定代理。

　　【提示】添加代理成功/失败。

　　3) 为网络删除代理方法：

　　【方法原型】network_removed_from_agent(context, network_id, host)。

　　【方法功能】为网络删除 DHCP代理。

　　【参数说明】context：上下文 ;

　　network_id：网络 id;

　　host：主机 。

　　【返回值】成功/失败。

　　【使用方法】发起者调用该接口，传递参数，将删除网络中的指定代理。

　　【提示】删除代理成功/失败。

　　4) 列出 DHCP代理所有网络方法：

　　GB/T 33780 . 3—20 17

　　【方法原型】list_networks_on_dhcp_agent(context, id)。

　　【方法功能】列出拥有 DHCP代理的所有网络。

　　【参数说明】context：上下文 ;

　　id：网络 id。

　　【返回值】包含网络信息的字典。

　　【使用方法】发起者调用该接口，传递参数，将会得到有 DHCP代理的网络字典。

　　【提示】无。

　　c) 基于 L2 层虚拟链接交换方法：

　　1) 创建网络方法：

　　【方法原型】create_network(context, network)。

　　【方法功能】为租户创建网络。

　　【参数说明】context：上下文 ;

　　network：网络名。

　　【返回值】net：网络信息。

　　【使用方法】发起者调用该接口，传递参数，将会得到新创建的网络信息。

　　【提示】创建网络成功/失败。

　　2) 删除网络方法：

　　【方法原型】delete_network(context, id)。

　　【方法功能】删除网络。

　　【参数说明】context：上下文 ;

　　id：网络 id。

　　【返回值】成功/失败。

　　【使用方法】发起者调用该接口，传递参数，将会删除该网络。

　　【提示】删除成功/失败。

　　3) 列出网络方法：

　　【方法原型】：get_networks(context, filters=None, fields=None, sorts= None, limit= None, marker=None, page_reverse=False)。

　　【方法功能】列出网络。

　　【参数说明】context：上下文 ;

　　filters=None：过滤;

　　fields=None：字段;

　　sorts=None：排序;

　　limit=None：限制;

　　marker=None：标记;

　　page_reverse=False：倒退页面。

　　【返回值】包含所请求网络信息的列表。

　　【使用方法】发起者调用该接口，传递参数，获得满足需求的网络信息列表。

　　【提示】获取成功/失败。

　　4) 显示网络详情方法：

　　【方法原型】get_network(context, id, fields=None)。

　　【方法功能】显示网络详细信息。

　　【参数说明】context：上下文 ;

　　id：网络 id;

　　GB/T 33780 . 3—20 17

　　fields=None：字段。

　　【返回值】所请求网络详细信息。

　　【使用方法】发起者调用该接口，传递参数，获得该网络的详细信息。

　　【提示】获取成功/失败。

　　5) 更新网络方法：

　　【方法原型】update_network(context, id, network)。

　　【方法功能】更新网络信息。

　　【参数说明】context：上下文 ;

　　id：网络 id;

　　network：网络信息。

　　【返回值】net：更新结果。

　　【使用方法】发起者调用该接口，传递参数，执行更新。

　　【提示】更新成功/失败。

　　6) 创建子网方法：

　　【方法原型】create_subnet(context, subnet)。

　　【方法功能】为租户创建一个子网。

　　【参数说明】context：上下文 ;

　　subnet：子网名称。

　　【返回值】新创建子网信息。

　　【使用方法】发起者调用该接口，传递参数，创建子网。

　　【提示】创建成功/失败。

　　7) 删除子网方法：

　　【方法原型】delete_subnet(context, id)。

　　【方法功能】删除一个指定的子网。

　　【参数说明】context：上下文 ;

　　id：子网 id。

　　【返回值】成功/失败。

　　【使用方法】发起者调用该接口，传递参数，删除该子网。

　　【提示】删除成功/失败。

　　8) 列出子网方法：

　　【方法原型】get_subnets(context, filters = None, fields = None, sorts = None, limit = None, marker=None, page_reverse=False)。

　　【方法功能】列出所给租户的全部子网。

　　【参数说明】context：上下文 ;

　　filters=None：过滤;

　　fields=None：字段;

　　sorts=None：排序;

　　limit=None：限制;

　　marker=None：标记;

　　page_reverse=False：倒退页面。

　　【返回值】返回子网信息列表。

　　【使用方法】发起者调用该接口，传递参数，返回子网信息列表。

　　【提示】获取成功/失败。

　　GB/T 33780 . 3—20 17

　　9) 显示指定子网方法：

　　【方法原型】get_subnet(context, id, fields=None)。

　　【方法功能】显示指定子网的详细信息。

　　【参数说明】context：上下文 ;

　　id：子网 id;

　　fields=None：字段。

　　【返回值】返回该子网信息。

　　【使用方法】发起者调用该接口，传递参数，返回该子网信息。

　　【提示】获得成功/失败。

　　10) 更新子网方法：

　　【方法原型】update_subnet(context, id, subnet)。

　　【方法功能】更新子网的详细信息。

　　【参数说明】context：上下文 ;

　　id：子网 id;

　　Subnet：子网信息。

　　【返回值】成功/失败。

　　【使用方法】发起者调用该接口，传递参数，更新子网。

　　【提示】更新成功/失败。

　　11) 创建端口方法：

　　【方法原型】create_port。

　　【方法功能】为指定租户创建端口 。

　　【参数说明】context：上下文 ;

　　port：端口名 。

　　【返回值】返回端口信息。

　　【使用方法】发起者调用该接口，传递参数，返回关口信息。

　　【提示】创建成功/失败。

　　12) 删除端口方法：

　　【方法原型】port_delete(context, port_id)。

　　【方法功能】删除指定端口 。

　　【参数说明】context：上下文 ;

　　port_id：端 口 id。

　　【返回值】成功/失败。

　　【使用方法】发起者调用该接口，传递参数，删除该端口 。

　　【提示】删除成功/失败。

　　13) 获取端口方法：

　　【方法原型】get_ports( context, filters = None, fields = None, sorts = None, limit = None, marker=None, page_reverse=False)。

　　【方法功能】列出指定租户的全部端口 。

　　【参数说明】context：上下文 ;

　　filters=None：过滤;

　　fields=None：字段;

　　sorts=None：排序;

　　limit=None：限制;

　　GB/T 33780 . 3—20 17

　　marker=None：标记。

　　【返回值】返回端口列表信息。

　　【使用方法】发起者调用该接口，传递参数，返回端口列表。

　　【提示】获得信息成功/失败。

　　14) 获取指定端口方法：

　　【方法原型】get_port(context, id, fields=None)。

　　【方法功能】显示指定端口的详细信息。

　　【参数说明】context：上下文 ;

　　id：端 口 id;

　　fields=None：字段。

　　【返回值】返回指定端口信息。

　　【使用方法】发起者调用该接口，传递参数，返回指定端口信息。 【提示】获取成功/失败。

　　15) 更新端口方法：

　　【方法原型】update_port(context, id, port)。

　　【方法功能】更新端口的信息。

　　【参数说明】context：上下文 ;

　　id：端 口 id;

　　port：端口名 。

　　【返回值】成功/失败。

　　【使用方法】发起者调用该接口，传递参数，更新端口 。

　　【提示】更新成功/失败。

　　16) 设定端口方法：

　　【方法原型】set_port_status(session, port_id, status)。

　　【方法功能】强制更改端口状态。

　　【参数说明】session：会话 ;

　　port_id：端 口 id;

　　status：状态。

　　【返回值】成功/失败。

　　【使用方法】发起者调用该接口，传递参数，设置端口状态。

　　【提示】设置成功/失败。

　　d) 基于 iptable 的 NAT转发方法：

　　1) 创建浮动 IP方法：

　　【方法原型】create_floatingip(context, floatingip)。

　　【方法功能】为指定租户创建浮动 IP。

　　【参数说明】context：上下文 ;

　　floatingip：浮动 IP 名;

　　ID：浮动 IP标识。

　　【返回值】成功/失败。

　　【使用方法】发起者调用该接口，传递参数，返回创建结果。

　　【提示】创建成功/失败。

　　2) 删除浮动 IP方法：

　　【方法原型】delete_floatingip(context, id)。

　　GB/T 33780 . 3—20 17

　　【方法功能】为指定租户删除浮动 IP。

　　【参数说明】context：上下文 ;

　　id：浮动 IP 的 id号 。

　　【返回值】成功/失败。

　　【使用方法】发起者调用该接口，传递参数，返回删除结果。

　　【提示】删除成功/失败。

　　3) 获取浮动 IP列表方法：

　　【方法原型】get_floatingips(context, filters=None, fields=None, sorts=None, limit= None, marker=None, page_reverse=False)。

　　【方法功能】列出所有可用浮动 IP。

　　【参数说明】context：上下文 ;

　　filters=None：过滤;

　　fields=None：字段;

　　sorts=None：排序;

　　limit=None：限制;

　　marker=None：标记。

　　【返回值】返回该浮动 IP。

　　【使用方法】发起者调用该接口，传递参数，返回该浮动 IP。

　　【提示】获取成功/失败。

　　4) 获取浮动 IP详细信息方法：

　　【方法原型】get_floatingip(context, id, fields=None)。

　　【方法功能】显示浮动 IP 的详细信息。

　　【参数说明】context：上下文 ;

　　id：浮动 IP 的 id号 ;

　　fields=None：字段。

　　【返回值】返回浮动 IP详细信息。

　　【使用方法】发起者调用该接口，传递参数，返回详细信息。

　　【提示】获取成功/失败。

　　5) 更新浮动 IP方法：

　　【方法原型】update_floatingip(context, id, floatingip)。

　　【方法功能】更新浮动 IP 的信息。

　　【参数说明】context：上下文 ;

　　id：浮动 IP 的 id号 ;

　　floatingip：浮动 IP 名。

　　【返回值】返回浮动 IP列表信息。

　　【使用方法】发起者调用该接口，传递参数，更新浮动 IP。

　　【提示】更新成功/失败。

　　e) 基于 L4-7 层虚拟防火墙策略方法：

　　1) 创建防火墙规则方法：

　　【方法原型】create_firewall_rule(context, firewall_rule)。

　　【方法功能】创建一个防火墙规则。

　　【参数说明】context：上下文 ;

　　firewall_rule：防火墙规则。

　　GB/T 33780 . 3—20 17

　　【返回值】返回防火墙规则。

　　【使用方法】发起者调用该接口，传递参数，返回防火墙规则。

　　【提示】创建成功/失败。

　　2) 删除防火墙规则方法：

　　【方法原型】delete_firewall_rule(context, id)。

　　【方法功能】删除一个防火墙规则。

　　【参数说明】context：上下文 ;

　　id：防火墙规则的 id。

　　【返回值】成功/失败。

　　【使用方法】发起者调用该接口，传递参数，返回删除结果。

　　【提示】删除成功/失败。

　　3) 列出所有防火墙规则方法：

　　【方法原型】get_firewall_rules(context, filters=None, fields=None)。

　　【方法功能】列出所有防火墙规则。

　　【参数说明】context：上下文 ;

　　filters=None：过滤;

　　fields=None：字段。

　　【返回值】返回包含防火墙规则的字典。

　　【使用方法】发起者调用该接口，传递参数，返回防火墙规则列表。

　　【提示】获取成功/失败。

　　4) 显示防火墙规则方法：

　　【方法原型】get_firewall_rule(context, id, fields=None)。

　　【方法功能】显示防火墙规则的详细信息。

　　【参数说明】context：上下文 ;

　　id：防火墙规则的 id;

　　fields=None：字段。

　　【返回值】防火墙规则信息。

　　【使用方法】发起者调用该接口，传递参数，返回防火墙规则信息。

　　【提示】获取成功/失败。

　　5) 更新防火墙规则方法：

　　【方法原型】update_firewall_rule(context, id, firewall_rule)。

　　【方法功能】更新防火墙规则。

　　【参数说明】context：上下文 ;

　　id：防火墙规则的 id;

　　firewall_rule：防火墙规则。

　　【返回值】防火墙规则字典。

　　【使用方法】发起者调用该接口，传递参数，返回防火墙规则字典。

　　【提示】更新成功/失败。

　　6) 创建防火墙策略方法：

　　【方法原型】create_firewall_policy(context, firewall_policy)。

　　【方法功能】创建一个防火墙策略。

　　【参数说明】context：上下文 ;

　　firewall_policy：防火墙策略。

　　GB/T 33780 . 3—20 17

　　【返回值】防火墙策略信息。

　　【使用方法】发起者调用该接口，传递参数，返回防火墙策略信息。

　　【提示】创建成功/失败。

　　7) 删除防火墙策略方法：

　　【方法原型】delete_firewall_policy(context, id)。

　　【方法功能】删除一个指定的防火墙策略。

　　【参数说明】context：上下文 ;

　　id：防火墙策略的 id。

　　【返回值】成功/失败。

　　【使用方法】发起者调用该接口，传递参数，删除防火墙策略。

　　【提示】删除成功/失败。

　　8) 添加防火墙规则方法：

　　【方法原型】insert_rule( context, id, rule_info)。

　　【方法功能】为防火墙策略添加一个防火墙规则。

　　【参数说明】context：上下文 ;

　　id：防火墙策略 id;

　　rule_info 防火墙规则信息。

　　【返回值】成功/失败。

　　【使用方法】发起者调用该接口，传递参数，添加防火墙规则。

　　【提示】添加成功/失败。

　　9) 获取防火墙策略方法：

　　【方法原型】get_firewall_policies(context, filters=None, fields=None)。

　　【方法功能】列出租户所有的全部防火墙策略。

　　【参数说明】context：上下文 ;

　　filters=None：过滤;

　　fields=None：字段。

　　【返回值】防火墙策略信息。

　　【使用方法】发起者调用该接口，传递参数，返回防火墙策略信息。

　　【提示】获取成功/失败。

　　10) 删除防火墙规则方法：

　　【方法原型】remove_rule(context, id, rule_info)。

　　【方法功能】为指定防火墙策略删除一条防火墙规则。

　　【参数说明】context：上下文 ;

　　id：防火墙策略 id;

　　rule_info：防火墙规则信息。

　　【返回值】成功/失败。

　　【使用方法】发起者调用该接口，传递参数，删除防火墙规则。

　　【提示】删除成功/失败。

　　11) 获取防火墙策略方法：

　　【方法原型】get_firewall_policy(context, id, fields=None)。

　　【方法功能】显示所给出的防火墙策略的详细信息。

　　【参数说明】context：上下文 ;

　　id：防火墙策略 id;

　　GB/T 33780 . 3—20 17

　　fields=None：字段。

　　【返回值】防火墙策略信息。

　　【使用方法】发起者调用该接口，传递参数，获取防火墙策略信息。

　　【提示】获取成功/失败。

　　12) 更新防火墙策略方法：

　　【方法原型】update_firewall_policy(context, id, firewall_policy)。

　　【方法功能】更新防火墙策略。

　　【参数说明】context：上下文 ;

　　id：防火墙策略 id;

　　firewall_policy：防火墙策略。

　　【返回值】防火墙策略信息。

　　【使用方法】发起者调用该接口，传递参数，更新防火墙策略。

　　【提示】更新成功/失败。

　　B.2 . 2 虚拟主机与应用服务器中间件接口

　　虚拟主机与应用服务器中间件接口的详细要求如下：

　　a) 软件包本地上传与下载方法：

　　1) 登录虚拟主机方法：

　　【方法原型】webssh2 (host, port, username, password)。

　　【方法功能】远程登录虚拟主机。

　　【参数说明】host：主机 IP 或域名;

　　port: ssh端 口;

　　username：登录名称;

　　password：登录密码。

　　【返回值】登录成功/失败。

　　【使用方法】接口运行在远程服务器上，发起者调用该接口，传递参数，登录虚拟主机。

　　【 提示】Port：默认为 21 和 22,防火墙要开放此端口 。

　　2) 上传文件方法：

　　【方法原型】upload (context, sourcefile, targetdiectory)。

　　【方法功能】上传文件到虚拟机指定目录。

　　【参数说明】context：登录信息上下文;

　　sourcefile：上传源文件;

　　targetdiectory：目的 目录。

　　【返回值】上传成功/失败。

　　【使用方法】接口运行在远程服务器上，发起者调用该接 口，传递参数，上传文件到虚拟主机的指定目录。

　　【提示】源文件可以是任何单文件。

　　3) 下载文件方法：

　　【方法原型】download (context, sourcefile)。

　　【方法功能】从远程虚拟主机上下载文件到本地。

　　【参数说明】context：登录信息上下文;

　　sourcefile：要下载的文件名称。