信息技术弹性计算应用接口

信息技术弹性计算应用接口

国家标准 GB/T31915一2015 信息技术弹性计算应用接口 lnformatiotechnology一EMastiecomputingapplieationinterfaee 2015-09-11发布 2016-05-01实施 国家质量监督检验检疫总局 发布 国家标准化管理委员会国家标准
GB/I31915一2015 目 次 前言 范围 规范性引用文件 术语、定义和缩略语 3.1术语和定义 3.2缩略语 弹性计算体系结构 弹性计算应用接口通用要求 5.1 概述 5.2数据类型 5.3HTTP协议 弹性计算应用接口定义 6.1概述 6.2出错处理方式 6.3虚拟机租赁接口 虚拟机镜像管理接口 S 6.4 6.5卷管理接口 19 6.6公网IP地址管理接口 22 负载均衡器管理接口 6.7 25 6.8安全组管理接口 28 6.9密钥管理接口 32
GB/T31915一2015 前 言 本标准按照GB/T1.1一2009给出的规则起草 请注意本文件的某些内容可能涉及专利 本文件的发布机构不承担识别这些专利的责任 本标准由全国信息技术标准化技术委员会(SAC/TC28)提出并归口 本标准起草单位:移动通信有限公司研究院、华为技术有限公司、电子技术标准化研究 院、浪潮(北京)电子信息产业有限公司、东软集团股份有限公司、上海计算机软件技术开发中心,深圳市 金蝶中间件有限公司、阿里云计算有限公司、中兴通讯股份有限公司、中标软件有限公司、用友软件股份 有限公司、北京华胜天成科技股份有限公司、北京航空航天大学 本标准主要起草人，段翔、李海波.寇欣.余样.王请牌.,唐廷芳、陈岭、颜秉宥,何光宇、猴立志 林琳、李战园、楚俊生、安宁、胡捷、白占来、田忠、秦习庆、王国伟、赵江、梁钢、赵海、陈志峰、杨丽荔、 王卫国、丛培勇
GB/T31915一2015 信息技术弹性计算应用接口 范围 本标准给出了弹性计算体系结构,规定了弹性计算应用接口通用要求和接口定义 本标准适用于弹性计算应用接口的设计、开发和服务提供 规范性引用文件 下列文件对于本文件的应用是必不可少的 凡是注日期的引用文件,仅注日期的版本适用于本文 件 凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件 GB/T7408一2005数据元和交换格式信息交换日期和时间表示法 RFC2616超文本传输协议[HypertextTransferProtocol(HTTP)1.1Speeifiea ationJ 术语、定义和缩略语 3.1 术语和定义 下列术语和定义适用于本文件 3.1.1 虚拟机virtualmachine 一种虚拟的数据处理系统,它看起来是在某个特定用户的独占使用下,但其功能是通过共享真实数 据处理系统的各种资源得以实现的 GB/T5271.l2000,定义01.01.50] 3.1.2 虚拟机镜像virtualmachineimage 虚拟机对应的文件系统镜像,包括操作系统及虚拟机运行需要的软件 3.1.3 虚拟机模板xirtualmachinetemplate 配置虚拟机所需的元数据集合,包括cPU数量、内存大小和磁盘大小等 洼;虚拟机模板用于方便地生成虚拟机 3.1.4 安全组securitygroup 防火墙规则的集合 3.2缩略语 下列缩略语适用于本文件 HTTP 超文本传输协议(HyperTextTransferProtocol) ID 标识符(Identifier) LB 负载均衡(LoadBalance SSH 安全外壳协议(SecureShell
GB/T31915一2015 URL lResourceLocator 统一资源定位符(Universal VM 虚拟机(VirtualMachine) 弹性计算体系结构 弹性计算体系结构如图1所示 应用系统1 应用系统 应用系统N 应用层 按口1 接口2 按口N 接口层 弹性计算服务1 弹性计算服务M 服务层 图1弹性计算体系结构 弹性计算是指以按需,动态可伸缩、多租户的方式为用户提供虚拟主机及其空间等相关资源的租赁 服务的计算模式 弹性计算体系结构包括3个部分;服务层、接口层和应用层 服务层是由弹性计算服 务提供商提供的用于虚拟机及相关资源管理的各类服务的总称 接口层定义了不同弹性计算服务均应 遵循的统一接口 应用层包括各类信息系统 弹性计算应用接口通用要求 5.1概述 弹性计算应用接口通用要求规定了弹性计算服务所使用的数据类型、接口协议 5.2数据类型 5.2.1日期与时间表示 日期和时间表示包括以下两个部分 日期与时间 a 日期与时间的表示应遵循GB/T7408一2005,具体见表1 表1日期与时间的表示 日期/时间 表示 年 yyyy mm Dd
GB/T31915一2015 表1(续 日期/时间 表示 时 hh(24小时制 nn 秒 日期与时间分隔符 b 日期与时间分隔符的表示应遵循GB/T7408一2005,具体见表2 表2日期与时间分隔符的表示 分隔符类别 表示 日期分隔符 时间分隔符 日期与时间分隔符 -个半角空格 示例 2005年12月9日21时01分39秒表示为;2005-12-092l:01:39 5.2.2 参数类型表示 三类参数类型的表示如下 Int:十进制的整数型; a b String;由字符组成的字符串; List(;包含一个或多个参数的列表 c 5.3HP协议 概述 5.3.1 弹性计算应用平台向用户提供的应用接口可采用HTTP(见RFC2616)中规定的GET方法传输 通信双方采用一问一答的通讯机制,即一次应答对应于一次请求 注:GET方法是HTTP协议中规定的获取信息的命令 HTTP协议的请求接口URL由三部分组成: 目的服务器; a 公其参数了每条查询请求都应包含的参数 b 特有参数;各接口的特有参数 该参数由弹性计算平台提供者规定并实现 5.3.2公共参数 公共参数包含弹性计算应用接口中所有查询接口的公共参数,详见表3
GB/T31915一2015 表3公共参数 参数名 数据类型 约束 说明 Action String 必选 动作名称,如创建虚拟机为CreatVM Version String 必选 接口版本 Timestamp String 必选 请求发起时间,格式为yyyy-mm-ddhh:mm:ss 用户访问密钥ID,用户注册后平台分配给用户的安全访问密钥对应的 AccessKeyld String 可选 一标识 唯一 可选 签名算法名称,关于签名算法的使用应参考国家相关规定和标准 SignatureMethod String 可选 根据签名算法生成的签名 Signature String 5.3.3用户身份鉴别和消息完整性验证 至少应选用HTTP协议的以下机制: 用户身份鉴别机制,保证使用弹性计算应用平台的用户身份的合法性 a b)消息完整性验证,保证用户和弹性计算平台之间传输的HTTP消息的完整性 弹性计算应用接口定义 6.1 概述 弹性计算应用接口包括以下7类功能接口: 虚拟机租赁接口 包括虚拟机的创建、启动、停止、重启、挂起,恢复、删除,查询和修改的功能接口; b 虚拟机镜像管理接口 包括虚拟机镜像的创建,删除,导人、导出和查询; 卷管理接口 包括卷的创建、删除、查询、加载和卸载， 公网IP地址管理接口 包括公网IP地址的申请、释放,查询,绑定和解绑定 负载均衡器管理接口 包括负载均衡器的创建、删除、查询、挂载、删除和修改; 安全组管理接口 包括安全组的创建、删除和查询,以及安全规则的添加和删除; 密钥管理接口 包括密钥的创建、删除和查询 6.2出错处理方式 弹性计算应用接口在返回操作执行结果时,宜采用统一的出错处理方式:如果操作执行失败,弹性 计算应用接口应返回出错信息 出错信息描述见表4
GB/T31915一2015 表4出错信息描述 字段名 类型 说明 约束 必选 操作失败后的出错信息 Faultstring String 6.3 虚拟机租赁接口 6.3.1虚拟机状态 虚拟机租赁包括对虚拟机全生命周期的管理 虚拟机的全生命周期从虚拟机创建动作发起开始 到完成该虚拟机的删除命令结束 在虚拟机的全生命周期内均可查询状态 虚拟机全生命周期内包括 10个状态,分别为创建中,创建完成、,删除中停止、启动中,运行、挂起中,挂起,恢复中,停止中 这10 个状态之间的转换如图2所示 用户可查询状态 开始 创建-创建中 创建完成 刑除-刑除中 结束 重启 停止 -启动-启动中 运行 -挂起-挂起中 挂起 停止 停止巾 恢复中 -恢复 图2虚拟机状态转换 图2中虚拟机创建完成后,虚拟机可能的状态迁移通过虚线以下的部分表示 虚拟机状态包括两 类:稳定状态和中间状态 6.3.1.1稳定状态 虚拟机稳定状态包括4类,具体如下 创建完成状态,用户具备使用所申请资源的使用权限的状态 a 运行状态;用户所申请的虚拟机处于可提供正常服务的状态 b 停止状态,用户所申请的虚拟机处于停止服务的状态; c) d)挂起状态;用户所申请的虚拟机处于暂停服务的状态并保证当前运行状态下的数据不丢失
GB/T31915一2015 6.3.1.2中间状态 虚拟机中间状态包括6类,具体如下 a)创建中;虚拟机从无到创建完成状态转换的中间状态; b删除中:虚拟机从创建完成状态到结束转换的中间状态; 启动中:虚拟机从停止状态向运行状态转换的中间状态; c d)挂起中;虚拟机从运行状态向挂起状态转换的中间状态; 停止中:虚拟机从运行状态向停止状态转换的中间状态 f 恢复中;虚拟机从挂起状态向运行状态转换的中间状态 6.3.1.3虚拟机状态迁移操作 虚拟机不同状态之间的迁移通过以下7类操作实现 创建操作;该操作完成虚拟机的硬件.软件等资源的申请,操作完成之后弹性计算平台赋予用 户相应资源的使用权限; b删除操作;该操作完成释放用户已申请虚拟机的硬件、软件等资源 启动操作;该操作完成将用户所申请的虚拟机从停止服务状态转换到运行状态; d)停止操作;该操作完成将用户所申请的虚拟机从运行状态转换到停止服务状态; 挂起操作;该操作完成将用户所申请的虚拟机从运行状态转换到挂起状态; 恢复操作;该操作完成将用户所申请的虚拟机从挂起状态转换到运行状态; f 重启操作;该操作完成将用户所申请的虚拟机从运行状态经过再次启动回到运行状态 6.3.2创建虚拟机(CreateVM 6.3.2.1接口功能 该接口根据用户指定的参数完成虚拟机的创建 如果操作成功,应返回已创建的虚拟机信息列表;如果操作失败,应返回出错信息(见表4) 6.3.2.2接口消息 请求消息和应答消息如下 a)请求消息.CreateVMReg 请求消息见表5 表5请求消息 字段名 类型 约束 说明 VMTemplatelID String 必选虚拟机模板唯一标识 CPU核数,单位为核(与VNMTemplatelD不能同时出现在创建 CoreCount nt 必选 虚拟机的请求中,否则返回出错信息 内存大小,单位为MB(与VMTemplatelI不能同时出现在创建 MemorySize lnt 必选 虚拟机的请求中,否则返回出错信息) 磁盘大小,单位为MB(与VMTemplatelD不能同时出现在创建 DiskSize 必选 Int 虚拟机的请求中,否则返回出错信息)
GB/T31915一2015 表5(续 类型 字段名 约束 说明 lmageID String 必选虚拟机镜像唯一编码 必选创建虚拟机的个数 Count nt List(VMPassword 可选虔拟机管理员的随机口令,由用户指定 长度为1或者c VMPasswords Count BsID5 ListGB/T31915一2015 表8(续 字段名 类型 约束 说明 AepTme 可选虚报机受理时同mmhm3s String VMNatme 可选用户自定义或者系统分配的虚拟机名称 String VMState String 必选虚拟机当前状态 6.3.3启动虚拟机(StartVM 6.3.3.1接口功能 该接口启动处于创建完成或停止状态的一个或多个虚拟机 如果操作成功,返回虚拟机状态信息列表;如果操作失败,应返回信息见表4 6.3.3.2接口消息 请求消息和应答消息如下 请求消息StartVMReg 请求消息见表9 表9请求消息 字段名 类型 约束 说明 VMID5 List(VMIDy 必选虚拟机唯一标识列表 b 应答消息;StartVMResl 应答消息见表10. 表10应答消息 字段名 类型 约束 说明 VMStates List(VMStateChange必选虚拟机当前状态 表10中,VMStateChange见表11 表11VMStateChange 字段名 类型 约束 说明 VMID String 必选虚拟机唯一标识 VMState String 必选虚拟机当前状态 6.3.4停止虚拟机(SopVM 6.3.4.1接口功能 该接口停止处于运行状态的一个或多个虚拟机 如果操作成功,返回虚拟机状态信息列表;如果操作失败,应返回信息见表4
GB/T31915一2015 6.3.4.2接口消息 请求消息和应答消息如下 请求消息:StopVMReqg a 请求消息见表12 表12请求消息 字段名 类型 约束 说明 VMIDs List(VMIDy 必选虚拟机唯一标识列表 应答消息:StopVMResp 应答消息见表13 表13应答消息 字段名 类型 约束 说明 List(VMstatChange必选虚拟机当前状态列表 VMStates 表13中,VMStateChange见表14 表14VMStateChange 类型 说明 字段名 约束 必选虚拟机唯一标识 VMID sirimg VMState String 必选虚拟机当前状态 6.3.5重启虚拟机Restart\M) 6.3.5.1接口功能 该接口重启处于运行状态的一个或多个虚拟机 如果操作成功,返回虚拟机状态信息列表;如果操作失败,应返回信息见表4 6.3.5.2接口消息 请求消息和应答消息如下: 请求消息RestartVMReg a 请求消息见表15 表15请求消息 字段名 类型 约束 说明 VMID5 List(VMIDy 必选虚拟机唯一标识列表 b)应答消息;RestartVMResp 应答消息见表16
GB/T31915一2015 表16应答消息 类型 说明 字段名 约束 VMStates List(VMStateCha1 必选虚拟机当前状态列表 hange 表16中,VMStateChange见表17 表17VMStateChange 字段名 类型 约束 说明 必选虚拟机唯一标识 VMID String Msae 必选虚拟机当前状态 String 6.3.6挂起虚拟机(SuspendVM) 6.3.6.1接口功能 该接口挂起处于运行状态的一个或多个虚拟机 如果操作成功,返回虚拟机状态信息列表;如果操作失败,应返回信息见表4 本接口在公有云部署场景中可选 6.3.6.2接口消息 请求消息和应答消息如下 请求消息:SuspendVMReg a 请求消息见表18 表18请求消息 字段名 类型 约束 说明 VMIDs List(VMID 必选虚拟机唯一标识列表 b)应答消息:SuspendVMResp 应答消息见表19 表19应答消息 字段名 类型 约束 说明 VMStates List(VMStateChange>必选虚拟机当前状态列表 表19中,VMStateChange见表20 表20VNIs StateChange 字段名 类型 约束 说明 VMID 必选虚拟机唯一标识 String VMState 必选虚拟机当前状态 String 10o
GB/T31915一2015 6.3.7恢复虚拟机(RestoreVN 6.3.7.1接口功能 该接口恢复处于挂起状态的一个或多个虚拟机 如果操作成功,返回虚拟机状态信息列表;如果操作失败,应返回信息见表4 本接口在公有云部署场景中可选 6.3.7.2接口消息 请求消息和应答消息如下 请求消息RestoreVMReg a 请求消息见表21 表21请求消息 字段名 类型 约束 说明 VMIDs List(VMIDy 必选虚拟机唯一标识列表 b应答消息;RestoreVMIResp 应答消息见表22 表22应答消息 字段名 类型 约束 说明 VMStates List(VMStateCha 必选虚拟机当前状态列表 hange 表22中,VMStateChange见表23 表23VMStateChange 字段名 类型 约束 说明 VMID 必选虚拟机唯一标识 String VMState string 必选虚拟机当前状态 6.3.8删除虚拟机(DeleteVM) 6.3.8.1接口功能 该接口删除一个或多个虚拟机 如果操作成功,不返回任何信息;如果操作失败,应返回信息见表4 6.3.8.2接口消息 请求消息和应答消息如下 请求消息.;DtleeVMRe 请求消息见表24 11
GB/T31915一2015 表24请求消息 类型 字段名 约束 说明 VMIDs List(VMIDy 必选虚拟机唯一标识列表 b)应答消息;DeleteVMResp 无应答消息 6.3.9查询虚拟机状态(oueryIState) 6.3.9.1接口功能 该接口通过虚拟机唯一标识返回虚拟机状态 如果操作成功,返回虚拟机状态;如果操作失败,应返回信息见表4 6.3.9.2接口消息 请求消息和应答消息如下 请求消息:QueryVMStateReq 请求消息见表25 表25请求消息 字段名 类型 约束 说明 VMID 必选虚拟机唯一标识 String b)应答消息:QueryVMStateResp 应答消息见表26 表26应答消息 字段名 类型 约束 说明 VMState String 必选虚拟机当前状态 6.3.10查询虚拟机列表(QueryVNML.ist) 6.3.10.1接口功能 用户不指定过滤条件时,该接口返回该用户所有的虚拟机列表 用户指定过滤条件时,该接口返回 该用户满足过滤条件的虚拟机列表 如果操作成功,返回虚拟机列表;如果操作失败,应返回信息见表4 6.3.10.2接口消息 请求消息和应答消息如下 请求消息 QueryVMListReg 请求消息见表27 12
GB/T31915一2015 表27请求消息 类型 字段名 约束 说明 Filters List(Filter 可选过滤器列表 其中,过滤器Filter的定义见表28 表28过滤器定义 字段名 类型 约束 说明 过滤器名称可以是虚拟机名称,虚拟机模板D或虚拟机镜 Name String 可选 像D 过滤器的值是过滤器名称相对应的值,Value支持通配符,“ 可选 Value String 代表一个或多个字符,“?"代表单个字符 b)应答消息:QueryVMListResp 应答消息见表29 表29应答消息 字段名 类型 约束 说明 VMList List(VM 必选虚拟机信息列表 表29中,VM虚拟机)信息见表30 表30虚拟机(VM)信息 字段名 类型 约束 说明 必选虚拟机唯一标识 VMD String VMName 必选虚拟机名称 String VMTemplatelID 必选虚拟机模板唯一标识 Srme" lmmageID String 必选虚拟机镜像唯一标识 VL.anlD String 必选虚拟网络唯一标识 PrivateIP String 可选虚拟机私网IP 可选密钥名称 KeyName String 可选虚拟机受理时间yyymmrdhh;mn;s AcceptTime String PublielIP 可选虚拟机公网P bring LBID Strir 可选虚拟机所属的负载均衡器唯一标识 ring BSID String 可选虚拟机挂载的块存储唯一标识 VMState String 可选虚拟机当前状态 SGName String 可选安全组名称 sGID String 可选安全组唯一标识 13
GB/T31915一2015 6.3.11查询虚拟机信息(QueryVMnfo) 6.3.11.1接口功能 该接口查询单个虚拟机信息 如果操作成功,返回虚拟机信息;如果操作失败,应返回信息见表4 6.3.11.2接口消息 请求消息和应答消息如下 请求消息:QueryVMInfoReg 请求消息见表31 表31请求消息 字段名 类型 约束 说明 VMID 必选虚拟机唯一标识 String b)应答消息:QueryVMInfoResp 应答消息见表32 表32应答消息 字段名 类型 约束 说明 必选虚拟机唯一标识 VMID String 必选虚拟机名称 VMName String VMTe 必选虚拟机模板唯一标识 IemplatelD String Strir 必选虚拟机镜像唯一标识 hmslD ring VI.anlD String 必选虚拟网络唯一标识 String 可选虚拟机私网IP PrivateIP KeyName String 可选密钥名称 AcceptTime String 可选虚拟机受理时间:yyyy-mm-ddhh:nn:ss 可选虚拟机公网P PublielP String LBD 可选虚拟机所属的负载均衡器唯一标识 String BSID sring 可选虚拟机挂载的块存储唯一标识 VMState String 可选虚拟机当前的状态 R sGName String 可选安全组名称 SGI String 可选安全组唯一标识 6.3.12修改虚拟机信息(SetVMlnfo 6.3.12.1接口功能 该接口修改单个虚拟机的配置信息 如果操作成功,无返回消息;如果操作失败,应返回信息见表4 14
GB/T31915一2015 6.3.12.2接口消息 请求消息和应答消息如下 请求消息:SetVMInfoReq a 请求消息见表33 表33请求消息 类型 说明 字段名 约束 VMID String 必选虚拟机唯一标识 VMNewName String 可选新的虚拟机名称 CoreCount nt 可选CPU核数(与VMTemplateID不能同时出现,否则响应错误 内存大小,单位为MB(与VMTe TemplatelD不能同时出现,否则 MemorySize 可选 nt 响应错误 硬盘大小,单位为MB(与VMTemplatelD不能同时出现,否则 DiskSize nt 可选 响应错误 VMTemplatelID 可选虚拟机模板唯一标识 Int 应答消息:SetVMnfoRee 无应答消息 6.3.13查询虚拟机模板(QueryVMlemplate) 6.3.13.1接口功能 该接口用于用户查询符合条件的虚拟机模板列表 如果操作成功.返回符合条件的虚拟机的模板列表;如果操作失败,应返回信息见表4 6.3.13.2接口消息 请求消息和应答消息如下 请求消息:QueryTemplateReg a 请求消息见表34 表34请求消息 字段名 类型 约束 说明 查询指定标识的模板信息 如果没有指定模板ID,应返回当前 VMTemplatelID String 可选 用户所有可见的模板 模板名称查询条件,可用通配符 如果没有指定模板名称,应 VMTemplateName String 可选 返回当前用户所有可见的模板 VMTemplateType String 可选模板类型包含平台模板和用户模板 b 应答消息.QueryTemplaeRe esp 应答消息见表35 15
GB/T31915一2015 表35应答消息 类型 说明 字段名 约束 VMTemplateList List(VMTemplate 必选虚拟机模板列表 其中,VMTemplate见表36 表36VMIemplate 字段名 类型 约束 说明 VMTemplatelID Str 必选虚拟机模板标识 tring VMTemplateName String 必选虚拟机模板名称 VMTemplateDescription 必选虚拟机模板描述信息 String CoreCount nt 必选CPU核数 必选内存大小 MemorySize Int DiskSize nt 必选磁盘大小 VMTemplateTy String 必选虚拟机模板类型 Te 6.4虚拟机镜像管理接口 6.4.1创建虚拟机镜像(Createlmage) 6.4.1.1接口功能 该接口以用户指定的虚拟机为源,为弹性计算应用平台生成一个新的镜像 在创建镜像的过程中， 源虚拟机应停止运行 镜像创建完成后,用户可以继续启动并使用虚拟机 镜像创建完毕后,可供后续 创建虚拟机使用 如果操作成功,返回结果应包含新创建镜像的唯一标识;如果操作失败,应返回信息见表4 6.4.1.2接口消息 请求消息和应答消息如下: 请求消息.CreatelmageRee a 请求消息见表37 表37请求消息 字段名 类型 约束 说明 VMID String 必选用于创建镜像的虚拟机唯一标识 必选镜像文件的名称 Name String 镜像类型,常用文件类型包括raw,ghost,Iso,vmdkvdi，ami ImageFormat String 可选 qcow2,VHD等 可选镜像描述 lmageDeseription String b)应答消息.CreatelmageResp 应答消息见表38 16
GB/T31915一2015 表38应答消息 字段名 类型 约束 说明 必选操作成功后的镜像唯一标识 lmagelD String 6.4.2删除虚拟机镜像(Deletelmage) 6.4.2.1接口功能 该接口删除一个镜像,删除成功后用户将无法使用该镜像创建虚拟机 如果操作成功,无返回参数;如果操作失败,应返回信息见表4. 6.4.2.2接口消息 请求消息和应答消息如下 请求消息:;DeletelmageReg a 请求消息见表39 表39请求消息 字段名 类型 约束 说明 lmageID String 必选待删除镜像唯一标识 应答消息;DeletelmageResp 无应答消息 6.4.3导入虚拟机镜像(ImportImage) 6.4.3.1接口功能 该接口以用户指定的路径为源,在弹性计算应用平台内部生成一个新的镜像 镜像导人完毕即对 系统可见,可供后续创建虚拟机使用 如果操作成功,返回结果应包含新镜像唯一标识;如果操作失败,应返回信息见表4 6.4.3.2接口消息 请求消息和应答消息如下 a)请求消息:lmportlmageReg 请求消息见表40. 表40请求消息 类型 字段名 约束 说明 ImportlmagePath String 必选源镜像路径 ImageName String 必选新镜像名称 源镜像类型,常用文件类型包括raw,ghost,Iso,vmdk,vd ImageFormat String 可选 qgcow2.VHD等 aml， String 可选新镜像描述 lmageDescription
GB/T31915一2015 b应答消息:lmportImageResp 应答消息见表41 表41应答消息 字段名 类型 约束 说明 必选操作成功后的新镜像唯一标识 lmagelID String 6.4.4导出虚拟机镜像(ExportImage 6.4.4.1接口功能 本接口根据用户指定的镜像唯一标识,保存镜像的一个副本到用户指定的存储路径 如果操作成功,无需返回参数;如果操作失败,应返回信息见表4 6.4.4.2接口消息 请求消息和应答消息如下 请求消息;ExportlmageReg 请求消息见表42 表42请求消息 字段名 类型 约束 说明 lmagelID String 必选待导出镜像唯一标识 ExportlmagePath String 必选导出镜像的存储路径 b)应答消息;ExportlmageResp 无应答消息 6.4.5查询虚拟机镜像(Qerlage 6.4.5.1接口功能 当指定镜像唯一标识时,该接口查询该镜像的描述信息 如果不指定镜像标识,则返回当前用户全 部可用的镜像描述列表 如果操作成功,返回结果应包括镜像描述列表;如果操作失败,应返回信息见表4 6.4.5.2接口消息 请求消息和应答消息如下 请求消息:QuerymageReg a 请求消息见表43 表43请求消息 字段名 类型 约束 说明 可选镜像唯一标识 ImD String 18
GB/T31915一2015 b应答消息:QueylmageResp 应答消息见表44 表44应答消息 字段名 类型 约束 说明 必选镜像描述列表 lmageList List(lmagelnfo 表44中,Imagelnfo见表45 表45Imagelnfo 字段名 类型 约束 说明 必选镜像唯一标识 lmagelD String 必选镜像名称 lmageName String ,ISO,vnmdlkvdi，ami 镜像类型,常用文件类型包括; ;rawghost lmageFormat String 必选 临 gcow2,VHD 可选镜像存储路径 lmagePath String lmage(OSType String 可选源镜像操作系统描述 ImmageDescription String 可选镜像描述 ImageSize String 可选镜像大小 镜像的状态 ！: 创建中; ImageState 必选 String 2 可用; 失败 3 6.5卷管理接口 6.5.1创建卷(Createvolume) 6.5.1.1接口功能 该接口用于创建指定大小的卷 如果操作成功,返回新创建的卷信息;如果操作失败,应返回信息见表4 6.5.1.2接口消息 请求消息和应答消息如下 请求消息:CreateVolumeReg 请求消息见表46 表46请求消息 字段名 类型 约束 说明 VolumeSize String 必选卷的大小 可选卷的名称 VolumeName String 19
GB/T31915一2015 b 应答消息:CreateVolumeResp 应答消息见表47 表47应答消息 字段名 类型 约束 说明 VolumeID String 必选卷唯一标识 VolumeName String 可选卷的名称 VolumeSize String 可选卷的大小,单位兆字节MB CreateTime String 可选卷的创建时间 6.5.2删除卷(DeleteVolwme 6.5.2.1接口功能 该接口用于删除指定编码的卷 如果操作成功,无返回信息;如果操作失败,应返回信息见表4 6.5.2.2接口消息 请求消息和应答消息如下 请求消息:DeleteVolumeReg 请求消息见表48 表48请求消息 字段名 类型 约束 说明 Volumel[D String 必选要删除的卷唯一标识 应答消息:DeleteVolunmeResp b 无应答消息 6.5.3查询卷(QueryVoume 6.5.3.1接口功能 该接口用于查询指定卷的状态和其他属性信息 如果操作成功,返回卷的动态和静态属性;如果操作失败,应返回信息见表4 6.5.3.2接口消息 请求消息和应答消息如下 a 请求消息:QueryVolumeReq 请求消息见表49 心
GB/T31915一2015 表49请求消息 字段名 类型 约束 说明 卷唯一标识,如果没有指定卷ID,应返回当前用户所有可见 可选 VoumeID String 的卷 b)应答消息:QueryVolumeResp 应答消息见表50. 表50应答消息 字段名 类型 约束 说明 volumeName Str 可选卷名称 tring VolumeSize String 必选块存储大小,单位兆字节(MB) VolumeUsedSize String 必选卷已用大小,单位兆字节(MB 卷的状态 l;创建中; volumeState 必选 String 2:已挂载; 3,可用(未挂载 AtachTime String 可选卷的加载时间 CreateTime String 可选卷的创建时间 可选卷关联的虚拟机唯一标识 VMID String 6.5.4加载卷AttachVolume 6.5.4.1接口功能 该接口用于将卷加载到虚拟机上 如果操作成功,返回加载卷的时间;如果操作失败,应返回信息见表4 6.5.4.2接口消息 请求消息和应答消息如下: 请求消息:AttachvolunmeReg a 请求消息见表51 表51请求消息 字段名 类型 约束 说明 VolumeID String 必选卷编码 VMID String 必选要挂载卷的虚拟机唯一标识 b应答消息AtachVolumeResp 应答消息见表52. 21
GB/T31915一2015 表52应答消息 字段名 类型 约束 说明 AttaehTinme 可选加载卷操作时间 String 6.5.5卸载卷(Detacholume 6.5.5.1接口功能 该接口用于将卷从虚拟机上卸载 如果操作成功,返回卷的卸载时间;如果操作失败,应返回信息见表4 6.5.5.2接口消息 请求消息和应答消息如下 请求消息;DetachVolumeReg 请求消息见表53 表53请求消息 字段名 类型 约束 说明 必选卷唯一标识 VolumelID String VMID 可选卸载卷所关联的虚拟机唯一标识 String b应答消息,DetachvoluneRes9p 应答消息见54 表54应答消息 类型 约束 说明 字段名 DetachTime String 可选卸载卷的操作时间 6.6公网IP地址管理接口 6.6.1申请公网IP(ApplyPublieIPy 6.6.1.1接口功能 该接口用于申请一个公网IP地址 如果操作成功,返回公网IP地址;如果操作失败,应返回信息见表4 6.6.1.2接口消息 请求消息和应答消息如下: a 请求消息:ApplyPubieIPReg 无参数 b)应答消息:ApplyPublielIPResp 应答消息见表55 心
GB/T31915一2015 表58IP 类型 字段名 约束 说明 IP String 可选公网IP地址 6.6.4绑定公网IP(BindingPublieIP) 6.6.4.1接口功能 该接口用于绑定公网IP地址和虚拟机,或用于绑定公网IP与负载均衡器 如果操作成功,无应答消息;如果操作失败,应返回信息见表4. 注:在创建负载均衡器后,需要与公网IP进行绑定,因此该接口目前存在两种场景;将公网P与虚机绑定,将公网 IP与负载均衡器绑定 考虑到公网IP可以是IDC运营商的一项收费服务,故将LB/VM建立、与IP地址绑定 分成两个独立的步骤进行操作 6.6.4.2接口消息 请求消息和应答消息如下 请求消息;BindingPublielPReg 请求消息见表59 表59请求消息 字段名 类型 约束 说明 Ip String 必选公网lP地址 VMID 可选虚拟机唯一标识 String LBID 可选负载均衡器唯一标识 String 应答消息;BindingPublieIPResp b 无应答消息 6.6.5解绑定公网IP(UnbindPublieI) 6.6.5.1接口功能 该接口用于解除公网IP地址和虚拟机的绑定 用户应指定所需要解除绑定的一个公网IP地址,用户宜指定其对应的虚拟机编码或负载均衡器 名称 如果操作成功,无应答消息;如果操作失败,应返回信息见表4 6.6.5.2接口消息 请求消息和应答消息如下 请求消息;UnbindPublielPReq 请求消息见表60 24
GB/T31915一2015 表60请求消息 字段名 类型 约束 说明 IP String 必选公网IP地址 VMID String 可选虚拟机唯一标识 LBID String 可选负载均衡器唯一标识 b)应答消息;UnbindPubielPResp 无应答消息 6.7负载均衡器管理接口 6.7.1创建负载均衡器(CreateLB) 6.7.1.1接口功能 该接口用于创建负载均衡器 如果操作成功,返回负载均衡器唯一标识;如果操作失败,应返回信息见表4 6.7.1.2接口消息 请求消息和应答消息如下 请求消息:CreateLBReq a 请求消息见表61 表61请求消息 字段名 类型 约束 说明 LBNanme String 可选负载均衡器名称 LBPort String 必选负载均衡器监听端口号 负载均衡器的部署方法,包括四层负载均衡方法、七层服务器 LBMethod 可选 strimng 负载均衡方法 LBAlgorithm 可选负载均衡器的算法选择,如轮询、动态性能观察等 String 负责均衡器的健康状态检测方法包括lCMP、TCP、HT'TP请 LBHealthCheck 可选 String 求探测等 应答消息:CreateLBResp 应答消息见表62 表62应答消息 字段名 类型 约束 说明 LBID 必选负载均衡器唯一标识 String 6.7.2删除负载均衡器(DeleteL.B 6.7.2.1接口功能 该接口用于删除指定标识的负载均衡器 25
GB/T31915一2015 如果操作成功,无应答消息;如果操作失败,应返回信息见表4 6.7.2.2接口消息 请求消息和应答消息如下 请求消息:DeleteLBReq 请求消息见表63 表63请求消息 字段名 类型 约束 说明 必选要制除的负载均衡器唯一标识 1BID String 应答消息:DeletelLBResp b 无应答消息 6.7.3查询负载均衡器(QueryLB) 6.7.3.1接口功能 该接口用于查询指定标识的负载均衡器状态和其他属性信息 如果操作成功,返回负载均衡器状态和其他属性信息;如果操作失败,应返回信息见表4 6.7.3.2接口消息 请求消息和应答消息如下: 请求消息:QueryLBReg a 请求消息见表64 表64请求消息 字段名 类型 约束 说明 必选要查询的负载均衡器唯一标识 LBID String b应答消息;QueryLBResp 应答消息见表65 表65应答消息 字段名 类型 约束 说明 LBID String 必选负载均衡器唯一标识 LBName String 可选负载均衡器名称 可选创建时间 CreatTime String MIist 必选相关联的虚拟机端口号列表 List(VMIDPort 可选负载均衡器内网IP Privatelp String Publiclp 可选负载均衡器公网IP String 表65中,虚拟机端口号(VMIDPort)见表66 26
GB/T31915一2015 表66虚拟机端口号(VNDPort) 字段名 类型 约束 说明 VNMD 必选虚拟机D String Port 可选对应的端口号 String rVMIwithLB 6.7.4挂载负载均衡器(Register 6.7.4.1接口功能 该接口用于将指定标识的虚拟机挂载到负载均衡器上 如果操作成功,返回挂载成功的虚拟机列表;如果操作失败,应返回信息见表4 6.7.4.2接口消息 请求消息和应答消息如下 请求消息:RegisterVMwithLBRer 请求消息见表67 表67请求消息 字段名 约束 说明 类型 LBID 必选负载均衡器唯一标识 String VMList List(VM 必选需要挂载的虚拟机列表 表67中,VM见表30 b应答消息:RegisterVMIwithLBRe esp 应答消息见表68 表68应答消息 字段名 类型 约束 说明 vMIist List(vM 必选挂载成功的虚拟机列表 表68中,VM见表30. rVMFromLB 6.7.5解挂载负载均衡器(Deregister 6.7.5.1接口功能 该接口用于将已挂载在负载均衡器上的指定标识的虚拟机解除挂载 如果操作成功,返回解挂载成功的虚拟机列表;如果操作失败,应返回信息见表4 6.7.5.2接口消息 请求消息和应答消息如下 请求消息;DeregisterVMFromLBRe 请求消息见表69 27