FusionSphere北向接口SDK技术白皮书

1、华为华为 fusionspherefusionsphere北向接口北向接口 sdksdk 技术白皮书技术白皮书概述符号约定前言前言本文档介绍 fusionsphere 产品北向开放接口 sdk 技术。在本文中可能出现下列标志，它们所代表的含义如下。符号说明用于警示紧急的危险情形，若不避免，将会导致人员死亡或严重的人身伤害。用于警示潜在的危险情形，若不避免，可能会导致人员死亡或严重的人身伤害。用于警示潜在的危险情形，若不避免，可能会导致中度或轻微的人身伤害。用于传递设备或环境安全警示信息，若不避免，可能会导致设备损坏、数据丢失、设备性能降低或其它不可预知的结果。“注意”不涉及人身伤害。用于突出重

2、要/关键信息、最佳实践和小窍门等。“说明”不是安全警示信息， 不涉及人身、设备及环境伤害信息。目录目录前言前言. . ii. ii1 1 开放能力总览开放能力总览. .4 41.1 文档介绍. 41.2 整体结构. 51.3 配套版本. 52 2 开放集成场景开放集成场景. .6 62.1 被第三方云管理系统集成. 62.1.1 集成场景概述. 62.1.2 典型应用场景. 72.2 被第三方备份软件集成. 172.2.1 集成场景概述. 172.2.2 典型应用场景. 182.3 被第三方防病毒软件等安全产品集成 . 272.3.1 集成场景概述. 27典型应用场景 . 282.4 被 cl

3、oudstack 集成 . 292.4.1 集成场景概述. 292.4.2 典型应场景. 292.5 命令行运维. 323 3 开放能力清单开放能力清单. .3 33 33.1 fusionmanager 云管理北向接口 sdk. 333.1.1 开放接口清单. 333.2 fusioncompute 云操作系统北向接口 sdk. 383.2.1 开放接口清单. 383.3 fusioncompute 虚拟磁盘管理接口 sdk. 413.3.1 backup&restore 虚拟磁盘管理接口 . 423.3.2 fusioncompute 虚拟机备份相关接口 sdk . 423.4 f

4、usioncompute 云操作系统 powershell 命令行 . 424 4 术语表术语表. .4 44 41 11.1 文档介绍第三方应用开放能力总览开放能力总览openstack apifusionsphere apifusionsphereopenstack3 资源池rdfusionsphere资源池fusionsphere 解决方案旨在向其用户提供iaas 层服务，相应的，fusionsphere 对外开放了 iaas 接口供用户更为灵活的使用iaas 层服务。目前我们对外提供两套接口：openstack api：此接口保持和开源openstack 租户接口完全兼容，以帮助客户避

5、免厂商锁定问题。fusionsphere api： fusionsphere 解决方案提供了管理多资源池的能力， 云服务提供商可以方便的采用多资源池构建其服务。与此同时，为了避免云服务提供商的（最终） 用户直接面临多资源池接口的复杂性， 我们也提供了 “统一” 的fusionsphere api。此接口对外削弱了资源池特有接口、 参数的影响， 提供了归一的 “资源” 操作接口。目前 fusionsphere api按照业界主流的方式提供了rest 接口供第三方访问，详情可参阅版本接口文档。用户除了直接使用fusionsphere rest api之外，我们也提供了java/python/c#

6、等多语言 sdk 以供 isv 快速开发之用。1.2 整体结构1、 fusionspherefusionsphere 开放点全景图开放点全景图2 2、开放点：、开放点：1.application software2.virtual appliance3.server4.storage(包含灾备)5.management6.networking & security1.3 配套版本fusionsphere v100r005c102 22.1 被第三方云管理系统集成2.1.1 集成场景概述开放集成场景开放集成场景随着企业信息化建设的不断深入进行，信息系统已成为企业业务的重要支撑，信息设备数

7、量随之高速增长，各 it 基础实施供应商提供的资源和服务也各异。在资源利用和管控方面出现了服务器资源整体利用效率不高、缺乏资源使用统一管控、硬件资源投资缺乏量化决策依据等问题。利用云计算技术实现数据中心资源集约化管理、统一使用和动态调配，降低运行成本，提高资源利用率，有必要建设信息系统统一资源池，从而实现信息系统硬件资源统一管理、精确量化、共享利用、按需分配、动态调度能力，充分发挥设备效率、降低运营成本和能耗。fusioncompute 是云操作系统软件，主要由虚拟化基础平台和云基础服务平台组成，主要负责硬件资源的虚拟化，以及对虚拟资源、业务资源、用户资源的集中管理。它采用虚拟计算、 虚拟存储

8、、 虚拟网络等技术， 完成计算资源、 存储资源、 网络资源的虚拟化。同时通过统一的接口， 对这些虚拟资源进行集中调度和管理， 从而降低业务的运行成本，保证系统的安全性和可靠性，协助运营商和企业构筑安全、绿色、节能的云数据中心能力。sdk 向第三方业务系统开放华为云操作系统的部分功能， 降低业务定制开发难度， 提高产品快速被集成能力。目前提供java/python/c#多语言 sdk 包，主要提供虚拟机管理、虚拟存储管理、虚拟网络管理、虚拟资源监控等管理接口。2.1.2 典型应用场景虚拟机管理场景虚拟机管理业务场景是基于项目实施过程中，已在fusioncompute 的管理 portal 完成了

9、初始化的操作。创建虚拟机虚拟机管理顶层包:管理员模板管理虚拟机管理包括创建虚拟机、虚拟机管理、模板管理三个主要的应用场景。其中创建虚拟机又分为直接创建虚拟机和根据模板创建虚拟机； 虚拟机管理包括重启、 暂停、 恢复、迁移、 挂载卷、 添加网关等场景； 模板管理包括了导入导出模板、 自定义虚拟机配置等。如下主要说明虚拟机创建。1、创建虚拟机场景查询站点下集群在集群或主机上创建虚拟机查询集群下主机查看创建虚拟机进度判断是基于卷还是基于数据存储创建基于数据存储虚拟机基于卷挂载光驱查询主机下数据存储创建卷（见卷创建场景）安装操作系统查询主机下虚拟交换机重启虚拟机查询虚拟交换机下端口组挂载tools流程

10、说明流程说明步骤 1：查询站点下的集群信息，调用clustermanager 类的 queryclusters 方法步骤 2：根据步骤 1 返回的集群标识查询集群下的主机，调用hostmanager 的queryhostlist 方法步骤 3：判断基于数据存储还是基于卷创建虚拟机。如果是基于数据存储，根据步骤2返回的主机标识查询主机下的数据存储，调用datastoragemanager的 querydatastores方法；否则要先创建卷，创建卷的流程见3.3 章节。步骤 4：根据步骤 2 返回的主机标识查询主机下的虚拟交换机，调用dvswitchmanager的 queryalldvswit

11、chs 方法步骤 5：根据步骤 4 返回的虚拟交换机标识查询端口组，调用portgroupmanager 的queryalldvsportgroups方法步骤 5：在集群或主机创建虚拟机，调用vmmanager 类的 createvm 方法。步骤 6：根据步骤 5 返回的任务标识查看虚拟机创建的进度，调用taskmanager 类的querytask 方法步骤 7：在步骤 5 中，如果参数中选择了自动启动虚拟机，则创建完成后虚拟机会自动启动，无需调用接口，否则调用vmmanager 类的 startvm 方法步骤 8：虚拟机创建完成后， 挂载虚拟机光驱， 用于远程挂载 iso 文件，安装操作系

12、统，调用 vmmanager 类的 attachcdrom 方法。步骤 9：虚拟机创建完成后， 挂载虚拟机光驱， 用于远程挂载 iso 文件，安装操作系统，调用 vmmanager 类的 attachcdrom 方法。步骤 10：挂载虚拟机光驱后，调用vmmanager 类的 rebootvm 方法重启虚拟机。步骤 11：重启后按操作系统的指示安装操作系统，安装完成后调用vmmanager 类的installtools 方法挂载 tools。至此虚拟机的创建步骤完成。2、模板创建虚拟机场景导入模板判断是要创建和模板一样的虚拟机n自定义虚拟机配置y判断是否需要虚拟机的指定集群或主机y查询主机或集

13、群nn根据模板创建虚拟机流程说明流程说明步骤 1： 导入文件模板， 用于创建虚拟机， 调用 vmmanager 类的 importtemplate 方法。步骤 2：判断是否要创建和模板一样的虚拟机还是需要自定义一些虚拟机参数，如果需要自定义虚拟机参数，则创建自定义的虚拟机配置，调用vmmanager 类的createvmcustomization方法，否则跳过本步骤。步骤 3：根据模板创建虚拟机时默认同原模板的集群或主机。若要指定集群或主机，则需要查询主机或集群。 查询站点下的集群信息， 调用 clustermanager 类的 queryclusters方法；根据返回的集群标识查询集群下的主

14、机，调用hostmanager 的 queryhostlist 方法。步骤 4： 根据模板 （配置、 集群或主机） 创建虚拟机， 调用 vmmanager 类的 vmclonetemp方法备注：1.以上三个步骤是完整的根据模板生成虚拟机的流程，其中步骤2 是可选步骤，不执行步骤 2，则在部署虚拟机时采用模板默认的配置。还可以直接执行步骤3，虚拟机克隆为虚拟机。虚拟存储管理场景查询存储设备数据存储创建数据存储查询数据存储顶层包:管理员创建/修改卷卷管理删除卷查询卷挂载卷存储设备：表示存储资源中的管理单元，类似lun、 advanced san 存储池、nas 共享目录等。数据存储：表示系统中可管

15、理、操作的存储逻辑单元，一个数据存储和一个存储设备对应；数据存储承载了具体的虚拟机业务，例如创建磁盘等。卷：虚拟机上的逻辑磁盘分区。运营人员在存储管理中，可以查看指定主机的存储设备；基于存储设备创建数据存储，查询已创建的数据存储；基于数据存储可以创建卷、查询、修改、删除已创建的卷，并挂载卷至已创建的虚拟机下。下面是虚拟存储管理的完整流程说明。1、虚拟存储管理应用场景查询站点下集群信息查询集群下主机信息n数据存储是否已创建y查询主机下存储设备查询主机下数据存储在存储设备上创建数据存储在数据存储上创建卷根据主机或集群查询虚拟机挂载卷至虚拟机场景说明场景说明步骤 1：查询站点下的集群信息，调用clu

16、stermanager 类的 queryclusters 方法。步骤 2：根据步骤 1 返回的集群标识查询集群下的主机，调用hostmanager 的queryhostlist 方法。步骤 3：判断是否已经创建数据存储，如果没有，则根据主机标识查询和主机关联的存储设备，调用 storageunitmanager 类的 querystorageunit方法；如果已经创建， 则查询主机下的数据存储，调用storageunitmanager 类的 querydatastores 方法，并跳过步骤4。步骤 4：在步骤 3 查询得到存储设备上创建数据存储，调用datastoragemanager 类的c

17、reatedatastore 方法。步骤 5：在步骤 4 创建的数据存储上创建卷，调用volumemanager 类的 createvolume的方法。步骤 6：根据主机标识查询虚拟机，调用vmmanager 类的 queryvm 的方法。步骤 7：挂载卷至虚拟机，调用vmmanager 类的 attachvolume 的方法。虚拟网络管理场景u uc use case modelc use case model物理网络平面管理物理网络平面管理创建创建 dvswitchdvswitch添加上行链路添加上行链路增加网络增加网络 vlanvlandvswitchdvswitch 管理管理增加网络增

18、加网络 vxlanvxlan更新更新 vxlanvxlanvtepvtep系统管理员系统管理员查询查询 portgroupportgroupportgroupportgroup管理管理创建创建 portgroupportgroup删除删除 portgroupportgroup查询查询 vspvspvspvsp 管理管理配置配置 ipip和和macmac1 1、物理网络平面管理、物理网络平面管理物理网络平面承载业务相关的虚拟网络，不同的虚拟网络需要选择创建在不同的物理网络平面。物理网络平面的管理主要指计算/网络节点物理网络接口的管理 （对应到虚拟交换机或分布式虚拟交换机的端口管理） 。物理网络接

19、口管理，需要解决“依据业务的物理网络拓扑连接”与“租户逻辑网络”的承载关系映射，即 i 层物理网络管理需要理解物理网络连接平面拓扑，来建立物理网络到业务承载网络的映射管理。物理网络配置管理主要由系统管理员在开局时在fusionsphere 平台上进行配置，暂不对外开放创建物理网络等接口。物理网络接口管理主要场景描述：1）业务管理员根据云平台层的部署和业务规划，通过fusionsphere 平台创建物理网络（physicalnetwork） 。业务管理员根据业务需求所创建的虚拟网络，需要指定具体的物理网络来承载；2）业务管理员添加物理网络接口（uplink 口）到指定的物理网络（physical

20、 network）中，主机完成物理网络与外部物理网络的互联。至此，虚拟网络创建以后，可直接打通与其他主机或物理网络设备虚拟网络的连接。2 2、分布式虚拟交换机（、分布式虚拟交换机（dvswitchdvswitch）管理）管理dvs 服务向系统管理员提供分布式虚拟交换管理， 实现网络资源的规划和维护。 系统管理员通过创建dvs，规划主机节点的物理端口（uplinkport）或物理端口聚合组（uplinkportaggr）在不同的分布式虚拟交换平面，实现跨物理主机的物理网络通信平面的管理。同时，dvs 需要实现对系统接口（systemintf）的管理，包含接口的 ip 地址、路由信息、vlan 等

21、相关配置。3 3、分布式虚拟交换端口组（、分布式虚拟交换端口组（portgroupportgroup）管理）管理分布式虚拟端口组是分布式虚拟交换机虚拟端口的集合。连接在同一端口组的虚拟机网卡，具有相同的网络属性（如：带宽限速、vlan/subnet、dhcp 隔离、ip 和 mac 绑定等） 。管理员可以通过对端口组的集中管理和配置，简化对虚拟机端口属性的设置。4 4、虚拟交换端口（、虚拟交换端口（vspvsp）管理）管理虚拟交换机提供基本的虚拟机交换机能力，为fusioncompute 的网络模块提供新的虚拟交换模式，具备 vlan、dhcp 隔离、带宽限速及优先级设置的基本功能，同时，有良

22、好的功能扩展性。虚拟交换机作为主机上的虚拟交换，部署在主机上。主机节点的系统接口（hnic）及虚拟机的虚拟网卡（vnic）分别于虚拟交换机的虚拟端口连接，通过虚拟交换机实现与外部网络的数据传输。虚拟交换机使用主机节点的物理网卡作为虚拟网络总的出口。每个虚拟交换机具有多个虚拟端口， 每个虚拟端口具有各自的属性 （带宽 qos、 2 层安全属性、 vlan等） 。可根据端口查询网络中有多少虚拟机，配置vm 网卡 ip 和 mac 地址绑定。虚拟网络管理业务场景：虚拟网络管理业务场景：虚拟网络管理提供创建分布式交换机和端口组等网络资源的功能，支持对网络资源进行调整和配置。物理网络管理是否已有可用分布

23、式虚拟交换机否是创建分布式虚拟交换机添加上行链路添加vlan池（可选）添加子网（可选）配置vtep（可选）创建端口组流程说明流程说明步骤步骤 1 1、创建分布式虚拟交换机、创建分布式虚拟交换机：分布式交换机的功能类似于普通的物理交换机，每台主机都连接到分布式交换机中。分布式交换机的一端是与虚拟机相连的虚拟端口，另一端是与虚拟机所在主机上的物理以太网适配器相连的上行链路。 通过它可以连接主机和虚拟机，实现系统网络互通。调用“创建 dvswitch”接口。步骤步骤 2 2、添加上行链路、添加上行链路：在已创建的分布式交换机中添加上行链路，为虚拟机提供网络资源。上行链路为服务器的物理网口，可在添加之前对其进行端口绑定（主备或负荷分担） 。上行链路的添加需要根据所在节点上vm 的需要灵活配置。一般的，上行链路可分为管理，存储和业务三个平面。调用“增加 dvswitch 服务器”接口。步骤步骤 3 3、配置、配置 vlanvlan 池池：按照规划添加 vlan 池，为创建端口组提供vlan 资源。当端口组选择连接方式为vlan 池，需要用户手动配置vm 的 ip 地址。调用“增加dvswitch 的 vlans”接口。步骤步骤 4 4、配置子网配置子网