GB/T 31915-2015 信息技术 弹性计算应用接口
- 名 称：GB/T 31915-2015 信息技术 弹性计算应用接口 - 下载地址1
- 下载地址：[下载地址1]
- 提 取 码：
- 浏览次数：3
发表评论 加入收藏夹 错误报告目录| 新闻评论（共有 0 条评论） |
资料介绍
ICS 35. 100. 05 L 79
中 华 人 民 共 和 国 国 家 标 准
GB/T 31915—2015
信息技术 弹性计算应用接口
Information technology—Elasticcomputing application interface
2015-09-11发布 2016-05-01实施
中华人民共和国国家质量监督检验检疫总局中 国 国 家 标 准 化 管 理 委 员 会
发
布
GB/T 31915—2015
GB/T 31915—2015
前 言
本标准按照 GB/T 1. 1—2009给出的规则起草 。
请注意本文件的某些内容可能涉及专利 。本文件的发布机构不承担识别这些专利的责任 。
本标准由全国信息技术标准化技术委员会(SAC/TC28)提出并归 口 。
本标准起草单位 : 中国移动通信有限公司研究院 、华为技术有限公 司 、中 国 电 子 技 术 标 准 化 研 究院 、浪潮(北京)电子信息产业有限公司 、东软集团股份有限公司 、上海计算机软件技术开发中心 、深圳市金蝶中间件有限公司 、阿里云计算有限公司 、中兴通讯股份有限公司 、中标软件有限公司 、用友软件股份有限公司 、北京华胜天成科技股份有限公司 、北京航空航天大学 。
本标准主要起草人 : 段 翔 、李 海 波 、寇 欣 、余 祥 、王 洁 萍 、唐 廷 芳 、陈 岭 、颜 秉 珩 、何 光 宇 、蔡 立 志 、林琳 、李战园 、楚 俊 生 、安 宁 、胡 捷 、白 占 来 、田 忠 、秦 习 庆 、王 国 伟 、赵 江 、梁 钢 、赵 海 、陈 志 峰 、杨 丽 蕴 、王卫国 、丛培勇 。
信息技术 弹性计算应用接口
1 范围
本标准给出了弹性计算体系结构 ,规定了弹性计算应用接口通用要求和接口定义 。
本标准适用于弹性计算应用接口的设计 、开发和服务提供 。
2 规范性引用文件
下列文件对于本文件的应用是必不可少的 。凡是注 日期的引用文件 ,仅注 日期的版本适用于本文件 。凡是不注日期的引用文件 ,其最新版本(包括所有的修改单)适用于本文件 。
GB/T 7408—2005 数据元和交换格式 信息交换 日期和时间表示法
RFC2616 超文本传输协议[HypertextTransferProtocol(HTTP) 1.1Specification]
3 术语、定义和缩略语
3. 1 术语和定义
下列术语和定义适用于本文件 。
3. 1. 1
虚拟机 virtualmachine
一种虚拟的数据处理系统 ,它看起来是在某个特定用户的独占使用下 ,但其功能是通过共享真实数据处理系统的各种资源得以实现的 。
[GB/T 5271. 1—2000,定义 01. 01. 50] 3. 1.2
虚拟机镜像 virtualmachine image
虚拟机对应的文件系统镜像 ,包括操作系统及虚拟机运行需要的软件 。
3. 1.3
虚拟机模板 virtualmachine template
配置虚拟机所需的元数据集合 ,包括 CPU数量 、内存大小和磁盘大小等 。
注 : 虚拟机模板用于方便地生成虚拟机 。
3. 1.4
安全组 securitygroup
防火墙规则的集合 。
3.2 缩略语
下列缩略语适用于本文件 。
HTTP 超文本传输协议(HyperTextTransferProtocol)
ID 标识符(Identifier)
LB 负载均衡(Load Balance)
SSH 安全外壳协议(Secure Shell)
GB/T 31915—2015
URL 统一资源定位符(UniversalResource Locator)
VM 虚拟机(VirtualMachine)
4 弹性计算体系结构
弹性计算体系结构如图 1所示 。
图 1 弹性计算体系结构
弹性计算是指以按需 、动态可伸缩 、多租户的方式为用户提供虚拟主机及其空间等相关资源的租赁服务的计算模式 。 弹性计算体系结构包括 3个部分 :服务层 、接口层和应用层 。服务层是由弹性计算服务提供商提供的用于虚拟机及相关资源管理的各类服务的总称 。接口层定义了不同弹性计算服务均应遵循的统一接 口 。应用层包括各类信息系统 。
5 弹性计算应用接口通用要求
5. 1 概述
弹性计算应用接口通用要求规定了弹性计算服务所使用的数据类型 、接口协议 。
5.2 数据类型
5.2. 1 日期与时间表示
日期和时间表示包括以下两个部分 :
a) 日期与时间
日期与时间的表示应遵循 GB/T 7408—2005,具体见表 1。
表 1 日期与时间的表示
表 1 (续)
b) 日期与时间分隔符
日期与时间分隔符的表示应遵循 GB/T 7408—2005,具体见表 2。
表 2 日期与时间分隔符的表示
示例 :
2005年 12月 9 日 21时 01分 39秒表示为 :2005-12-09 21:01:39。
5.2.2 参数类型表示
三类参数类型的表示如下 :
a) Int:十进制的整数型 ;
b) String:由字符组成的字符串 ;
c) List<> :包含一个或多个参数的列表 。
5.3 HTTP协议
5.3. 1 概述
弹性计算应用平台向用户提供的应用接口可采用 HTTP(见 RFC2616)中规定的 GET方法传输。通信双方采用一问一答的通讯机制 , 即一次应答对应于一次请求 。
注: GET方法是 HTTP协议中规定的获取信息的命令。
HTTP协议的请求接口 URL由三部分组成:
a) 目的服务器 ;
b) 公共参数 :每条查询请求都应包含的参数 ;
c) 特有参数 :各接口的特有参数 。该参数由弹性计算平台提供者规定并实现 。
5.3.2 公共参数
公共参数包含弹性计算应用接口中所有查询接口的公共参数 ,详见表 3。
表 3 公共参数
5.3.3 用户身份鉴别和消息完整性验证
至少应选用 HTTP协议的以下机制:
a) 用户身份鉴别机制 ,保证使用弹性计算应用平台的用户身份的合法性 ;
b) 消息完整性验证,保证用户和弹性计算平台之间传输的 HTTP消息的完整性。
6 弹性计算应用接口定义
6. 1 概述
弹性计算应用接口包括以下 7类功能接 口 :
a) 虚拟机租赁接 口
包括虚拟机的创建 、启动 、停止 、重启 、挂起 、恢复 、删除 、查询和修改的功能接 口 ;
b) 虚拟机镜像管理接 口
包括虚拟机镜像的创建 、删除 、导入 、导出和查询 ;
c) 卷管理接 口
包括卷的创建 、删除 、查询 、加载和卸载 ;
d) 公网 IP地址管理接 口
包括公网 IP地址的申请 、释放 、查询 、绑定和解绑定 ;
e) 负载均衡器管理接 口
包括负载均衡器的创建 、删除 、查询 、挂载 、删除和修改 ;
f) 安全组管理接 口
包括安全组的创建 、删除和查询 , 以及安全规则的添加和删除 ;
g) 密钥管理接 口
包括密钥的创建 、删除和查询 。
6.2 出错处理方式
弹性计算应用接口在返回操作执行结果时 ,宜采用统一的出错处理方式 :如果操作执行失败 , 弹性计算应用接口应返回出错信息 。 出错信息描述见表 4。
表 4 出错信息描述
6.3 虚拟机租赁接口
6.3. 1 虚拟机状态
虚拟机租赁包括对虚拟机全生命周期的管理 。虚拟机的全生命周期从虚拟机创建动作发起开始 ,到完成该虚拟机的删除命令结束 。在虚拟机的全生命周期内均可查询状态 。虚拟机全生命周期内包括10个状态 ,分别为 :创建中 、创建完成 、删除中 、停止 、启动中 、运行 、挂起中 、挂起 、恢复中 、停止中 。这 10个状态之间的转换如图 2所示 。
图 2 虚拟机状态转换
图 2 中虚拟机创建完成后 ,虚拟机可能的状态迁移通过虚线以下的部分表示 。 虚拟机状态包括两类 :稳定状态和中间状态 。
6.3. 1. 1 稳定状态
虚拟机稳定状态包括 4类 ,具体如下 :
a) 创建完成状态 :用户具备使用所申请资源的使用权限的状态 ;
b) 运行状态 :用户所申请的虚拟机处于可提供正常服务的状态 ;
c) 停止状态 :用户所申请的虚拟机处于停止服务的状态 ;
d) 挂起状态 :用户所申请的虚拟机处于暂停服务的状态并保证当前运行状态下的数据不丢失 。
6.3. 1.2 中间状态
虚拟机中间状态包括 6类 ,具体如下 :
a) 创建中 :虚拟机从无到创建完成状态转换的中间状态 ;
b) 删除中 :虚拟机从创建完成状态到结束转换的中间状态 ;
c) 启动中 :虚拟机从停止状态向运行状态转换的中间状态 ;
d) 挂起中 :虚拟机从运行状态向挂起状态转换的中间状态 ;
e) 停止中 :虚拟机从运行状态向停止状态转换的中间状态 ;
f) 恢复中 :虚拟机从挂起状态向运行状态转换的中间状态 。
6.3. 1.3 虚拟机状态迁移操作
虚拟机不同状态之间的迁移通过以下 7类操作实现 :
a) 创建操作 :该操作完成虚拟机的硬件 、软件等资源的申请 ,操作完成之后弹性计算平台赋予用户相应资源的使用权限 ;
b) 删除操作 :该操作完成释放用户已申请虚拟机的硬件 、软件等资源 ;
c) 启动操作 :该操作完成将用户所申请的虚拟机从停止服务状态转换到运行状态 ;
d) 停止操作 :该操作完成将用户所申请的虚拟机从运行状态转换到停止服务状态 ;
e) 挂起操作 :该操作完成将用户所申请的虚拟机从运行状态转换到挂起状态 ;
f) 恢复操作 :该操作完成将用户所申请的虚拟机从挂起状态转换到运行状态 ;
g) 重启操作 :该操作完成将用户所申请的虚拟机从运行状态经过再次启动回到运行状态 。
6.3.2 创建虚拟机(CreateVM)
6.3.2. 1 接口功能
该接口根据用户指定的参数完成虚拟机的创建 。
如果操作成功 ,应返回已创建的虚拟机信息列表 ;如果操作失败 ,应返回出错信息(见表 4) 。
6.3.2.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :CreateVMReq
请求消息见表 5。
表 5 请求消息
表 5 (续)
表 5 中 ,PrivateIP见表 6。
表 6 PrivateIP
b) 应答消息 :CreateVMResp
应答消息见表 7。
表 7 应答消息
表 7 中 ,VMInfo见表 8。
表 8 VMInfo
表 8 (续)
6.3.3 启动虚拟机(StartVM)
6.3.3. 1 接口功能
该接口启动处于创建完成或停止状态的一个或多个虚拟机 。
如果操作成功 ,返回虚拟机状态信息列表 ;如果操作失败 ,应返回信息见表 4。
6.3.3.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :StartVMReq
请求消息见表 9。
表 9 请求消息
b) 应答消息 :StartVMResp
应答消息见表 10。
表 10 应答消息
表 10 中 ,VMStateChange见表 11。
表 11 VMStateChange
6.3.4 停止虚拟机(StopVM)
6.3.4. 1 接口功能
该接口停止处于运行状态的一个或多个虚拟机 。
如果操作成功 ,返回虚拟机状态信息列表 ;如果操作失败 ,应返回信息见表 4。
6.3.4.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :StopVMReq
请求消息见表 12。
表 12 请求消息
b) 应答消息 :StopVMResp
应答消息见表 13。
表 13 应答消息
表 13中 ,VMStateChange见表 14。
表 14 VMStateChange
6.3.5 重启虚拟机(RestartVM)
6.3.5. 1 接口功能
该接口重启处于运行状态的一个或多个虚拟机 。
如果操作成功 ,返回虚拟机状态信息列表 ;如果操作失败 ,应返回信息见表 4。
6.3.5.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :RestartVMReq
请求消息见表 15。
表 15 请求消息
b) 应答消息 :RestartVMResp
应答消息见表 16。
表 16 应答消息
表 16中 ,VMStateChange见表 17。
表 17 VMStateChange
6.3.6 挂起虚拟机(SuspendVM)
6.3.6. 1 接口功能
该接口挂起处于运行状态的一个或多个虚拟机 。
如果操作成功 ,返回虚拟机状态信息列表 ;如果操作失败 ,应返回信息见表 4。本接口在公有云部署场景中可选 。
6.3.6.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :SuspendVMReq
请求消息见表 18。
表 18 请求消息
b) 应答消息 :SuspendVMResp应答消息见表 19。
表 19 应答消息
表 19中 ,VMStateChange见表 20。
表 20 VMStateChange
6.3.7 恢复虚拟机(RestoreVM)
6.3.7. 1 接口功能
该接口恢复处于挂起状态的一个或多个虚拟机 。
如果操作成功 ,返回虚拟机状态信息列表 ;如果操作失败 ,应返回信息见表 4。本接口在公有云部署场景中可选 。
6.3.7.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :RestoreVMReq
请求消息见表 21。
表 21 请求消息
b) 应答消息 :RestoreVMResp
应答消息见表 22。
表 22 应答消息
表 22 中 ,VMStateChange见表 23。
表 23 VMStateChange
6.3. 8 删除虚拟机(DeleteVM)
6.3. 8. 1 接口功能
该接口删除一个或多个虚拟机 。
如果操作成功 ,不返回任何信息 ;如果操作失败 ,应返回信息见表 4。
6.3. 8.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :DeleteVMReq
请求消息见表 24。
表 24 请求消息
b) 应答消息 :DeleteVMResp无应答消息 。
6.3.9 查询虚拟机状态(QueryVMState)
6.3.9. 1 接口功能
该接口通过虚拟机唯一标识返回虚拟机状态 。
如果操作成功 ,返回虚拟机状态 ;如果操作失败 ,应返回信息见表 4。
6.3.9.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 : QueryVMStateReq
请求消息见表 25。
表 25 请求消息
b) 应答消息 :QueryVMStateResp应答消息见表 26。
表 26 应答消息
6.3. 10 查询虚拟机列表(QueryVMList)
6.3. 10. 1 接口功能
用户不指定过滤条件时 ,该接口返回该用户所有的虚拟机列表 。用户指定过滤条件时 ,该接口返回该用户满足过滤条件的虚拟机列表 。
如果操作成功 ,返回虚拟机列表 ;如果操作失败 ,应返回信息见表 4。
6.3. 10.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 : QueryVMListReq
请求消息见表 27。
表 27 请求消息
其中 ,过滤器 Filter的定义见表 28。
表 28 过滤器定义
b) 应答消息 :QueryVMListResp应答消息见表 29。
表 29 应答消息
表 29中 ,VM(虚拟机)信息见表 30。
表 30 虚拟机(VM)信息
6.3. 11 查询虚拟机信息(QueryVMInfo)
6.3. 11. 1 接口功能
该接口查询单个虚拟机信息 。
如果操作成功 ,返回虚拟机信息 ;如果操作失败 ,应返回信息见表 4。
6.3. 11.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 : QueryVMInfoReq
请求消息见表 31。
表 31 请求消息
b) 应答消息 :QueryVMInfoResp应答消息见表 32。
表 32 应答消息
6.3. 12 修改虚拟机信息(SetVMInfo)
6.3. 12. 1 接口功能
该接口修改单个虚拟机的配置信息 。
如果操作成功 ,无返回消息 ;如果操作失败 ,应返回信息见表 4。
6.3. 12.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 : SetVMInfoReq
请求消息见表 33。
表 33 请求消息
b) 应答消息 :SetVMInfoResp无应答消息 。
6.3. 13 查询虚拟机模板(QueryVMTemplate)
6.3. 13. 1 接口功能
该接口用于用户查询符合条件的虚拟机模板列表 。
如果操作成功 ,返回符合条件的虚拟机的模板列表 ;如果操作失败 ,应返回信息见表 4。
6.3. 13.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 : QueryTemplateReq
请求消息见表 34。
表 34 请求消息
b) 应答消息 :QueryTemplateResp应答消息见表 35。
表 35 应答消息
其中 ,VMTemplate见表 36。
表 36 VMTemplate
6.4 虚拟机镜像管理接口
6.4. 1 创建虚拟机镜像(CreateImage)
6.4. 1. 1 接口功能
该接口以用户指定的虚拟机为源 ,为弹性计算应用平台生成一个新的镜像 。在创建镜像的过程中 ,源虚拟机应停止运行 。镜像创建完成后 ,用户可以继续启动并使用虚拟机 。镜像创建完毕后 ,可供后续创建虚拟机使用 。
如果操作成功 ,返回结果应包含新创建镜像的唯一标识 ;如果操作失败 ,应返回信息见表 4。
6.4. 1.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :CreateImageReq
请求消息见表 37。
表 37 请求消息
b) 应答消息 :CreateImageResp应答消息见表 38。
表 38 应答消息
6.4.2 删除虚拟机镜像(DeleteImage)
6.4.2. 1 接口功能
该接口删除一个镜像 ,删除成功后用户将无法使用该镜像创建虚拟机 。如果操作成功 ,无返回参数 ;如果操作失败 ,应返回信息见表 4。
6.4.2.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :DeleteImageReq
请求消息见表 39。
表 39 请求消息
b) 应答消息 :DeleteImageResp无应答消息 。
6.4.3 导入虚拟机镜像(ImportImage)
6.4.3. 1 接口功能
该接口以用户指定的路径为源 ,在弹性计算应用平台内部生成一个新的镜像 。镜像导入完毕即对系统可见 ,可供后续创建虚拟机使用 。
如果操作成功 ,返回结果应包含新镜像唯一标识 ;如果操作失败 ,应返回信息见表 4。
6.4.3.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :ImportImageReq
请求消息见表 40。
表 40 请求消息
b) 应答消息 :ImportImageResp应答消息见表 41。
表 41 应答消息
6.4.4 导出虚拟机镜像(ExportImage)
6.4.4. 1 接口功能
本接口根据用户指定的镜像唯一标识 ,保存镜像的一个副本到用户指定的存储路径 。如果操作成功 ,无需返回参数 ;如果操作失败 ,应返回信息见表 4。
6.4.4.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :ExportImageReq
请求消息见表 42。
表 42 请求消息
b) 应答消息 :ExportImageResp无应答消息 。
6.4.5 查询虚拟机镜像(QueryImage)
6.4.5. 1 接口功能
当指定镜像唯一标识时 ,该接口查询该镜像的描述信息 。如果不指定镜像标识 ,则返回当前用户全部可用的镜像描述列表 。
如果操作成功 ,返回结果应包括镜像描述列表 ;如果操作失败 ,应返回信息见表 4。
6.4.5.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :QueryImageReq
请求消息见表 43。
表 43 请求消息
b) 应答消息 :QueyImageResp
应答消息见表 44。
表 44 应答消息
表 44中 ,ImageInfo见表 45。
表 45 ImageInfo
6.5 卷管理接口
6.5. 1 创建卷(CreateVolume)
6.5. 1. 1 接口功能
该接口用于创建指定大小的卷 。
如果操作成功 ,返回新创建的卷信息 ;如果操作失败 ,应返回信息见表 4。
6.5. 1.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :CreateVolumeReq
请求消息见表 46。
表 46 请求消息
b) 应答消息 :CreateVolumeResp应答消息见表 47。
表 47 应答消息
6.5.2 删除卷(DeleteVolume)
6.5.2. 1 接口功能
该接口用于删除指定编码的卷 。
如果操作成功 ,无返回信息 ;如果操作失败 ,应返回信息见表 4。
6.5.2.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :DeleteVolumeReq
请求消息见表 48。
表 48 请求消息
b) 应答消息 :DeleteVolumeResp无应答消息 。
6.5.3 查询卷(QueryVolume)
6.5.3. 1 接口功能
该接口用于查询指定卷的状态和其他属性信息 。
如果操作成功 ,返回卷的动态和静态属性 ;如果操作失败 ,应返回信息见表 4。
6.5.3.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :QueryVolumeReq
请求消息见表 49。
表 49 请求消息
b) 应答消息 :QueryVolumeResp应答消息见表 50。
表 50 应答消息
6.5.4 加载卷(AttachVolume)
6.5.4. 1 接口功能
该接口用于将卷加载到虚拟机上 。
如果操作成功 ,返回加载卷的时间 ;如果操作失败 ,应返回信息见表 4。
6.5.4.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :AttachVolumeReq
请求消息见表 51。
表 51 请求消息
b) 应答消息 :AttachVolumeResp应答消息见表 52。
表 52 应答消息
6.5.5 卸载卷(DetachVolume)
6.5.5. 1 接口功能
该接口用于将卷从虚拟机上卸载 。
如果操作成功 ,返回卷的卸载时间 ;如果操作失败 ,应返回信息见表 4。
6.5.5.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :DetachVolumeReq
请求消息见表 53。
表 53 请求消息
b) 应答消息 :DetachVolumeResp应答消息见 54。
表 54 应答消息
6.6 公网 IP地址管理接口
6.6. 1 申请公网 IP(ApplyPublicIP)
6.6. 1. 1 接口功能
该接口用于申请一个公网 IP地址 。
如果操作成功 ,返回公网 IP地址 ;如果操作失败 ,应返回信息见表 4。
6.6. 1.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :ApplyPublicIPReq无参数 。
b) 应答消息 :ApplyPublicIPResp应答消息见表 55。
表 55 应答消息
6.6.2 释放公网 IP(ReleasePublicIP)
6.6.2. 1 接口功能
该接口用于释放公网 IP地址 。
如果操作成功 ,无返回信息 ;如果操作失败 ,应返回信息见表 4。
6.6.2.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :ReleasePublicIPReq
请求消息见表 56。
表 56 请求消息
b) 应答消息 :ReleasePublicIPResp无应答消息 。
6.6.3 查询公网 IP(QueryPublicIP)
6.6.3. 1 接口功能
该接口查询返回该用户的所有公网 IP地址列表 ,其中每个公网 IP地址是一个字符串 。如果操作成功 ,返回公网 IP列表 ;如果操作失败 ,应返回信息见表 4。
6.6.3.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :QueryPublicIPReq无参数 。
b) 应答消息 :QueryPublicIPResp应答消息见表 57。
表 57 应答消息
其中 ,IP见表 58。
表 58 IP
6.6.4 绑定公网 IP(BindingPublicIP)
6.6.4. 1 接口功能
该接口用于绑定公网 IP地址和虚拟机 ,或用于绑定公网 IP与负载均衡器 。
如果操作成功 ,无应答消息 ;如果操作失败 ,应返回信息见表 4。
注 : 在创建负载均衡器后 ,需要与公网 IP进行绑定 , 因此该接 口 目前存在两种场景 :将公网 IP 与虚机绑定 ,将公网IP与负载均衡器绑定 。考虑到公网 IP可以是 IDC运营商的一项收费服务 ,故将 LB/VM建立 、与 IP地址绑定分成两个独立的步骤进行操作 。
6.6.4.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :BindingPublicIPReq
请求消息见表 59。
表 59 请求消息
b) 应答消息 :BindingPublicIPResp无应答消息 。
6.6.5 解绑定公网 IP(UnbindPublicIP)
6.6.5. 1 接口功能
该接口用于解除公网 IP地址和虚拟机的绑定 。
用户应指定所需要解除绑定的一个公网 IP地址,用户宜指定其对应的虚拟机编码或负载均衡器名称 。
如果操作成功 ,无应答消息 ;如果操作失败 ,应返回信息见表 4。
6.6.5.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :UnbindPublicIPReq
请求消息见表 60。
表 60 请求消息
b) 应答消息 :UnbindPublicIPResp
无应答消息 。
6.7 负载均衡器管理接口
6.7. 1 创建负载均衡器(CreateLB)
6.7. 1. 1 接口功能
该接口用于创建负载均衡器 。
如果操作成功 ,返回负载均衡器唯一标识 ;如果操作失败 ,应返回信息见表 4。
6.7. 1.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :CreateLBReq
请求消息见表 61。
表 61 请求消息
b) 应答消息 :CreateLBResp
应答消息见表 62。
表 62 应答消息
6.7.2 删除负载均衡器(DeleteLB)
6.7.2. 1 接口功能
该接口用于删除指定标识的负载均衡器 。
如果操作成功 ,无应答消息 ;如果操作失败 ,应返回信息见表 4。
6.7.2.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :DeleteLBReq
请求消息见表 63。
表 63 请求消息
b) 应答消息 :DeleteLBResp无应答消息 。
6.7.3 查询负载均衡器(QueryLB)
6.7.3. 1 接口功能
该接口用于查询指定标识的负载均衡器状态和其他属性信息 。
如果操作成功 ,返回负载均衡器状态和其他属性信息 ;如果操作失败 ,应返回信息见表 4。
6.7.3.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :QueryLBReq
请求消息见表 64。
表 64 请求消息
b) 应答消息 :QueryLBResp
应答消息见表 65。
表 65 应答消息
表 65 中 ,虚拟机端口号(VMIDPort)见表 66。
表 66 虚拟机端口号(VMIDPort)
6.7.4 挂载负载均衡器(RegisterVMWithLB)
6.7.4. 1 接口功能
该接口用于将指定标识的虚拟机挂载到负载均衡器上 。
如果操作成功 ,返回挂载成功的虚拟机列表 ;如果操作失败 ,应返回信息见表 4。
6.7.4.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :RegisterVMWithLBReq
请求消息见表 67。
表 67 请求消息
表 67中 ,VM见表 30。
b) 应答消息 :RegisterVMWithLBResp应答消息见表 68。
表 68 应答消息
表 68中 ,VM见表 30。
6.7.5 解挂载负载均衡器(DeregisterVMFromLB)
6.7.5. 1 接口功能
该接口用于将已挂载在负载均衡器上的指定标识的虚拟机解除挂载 。
如果操作成功 ,返回解挂载成功的虚拟机列表 ;如果操作失败 ,应返回信息见表 4。
6.7.5.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :DeregisterVMFromLBReq
请求消息见表 69。
表 69 请求消息
表 69中 ,VM见表 30。
b) 应答消息 :DeregisterVMFromLBResp应答消息见表 70。
表 70 应答消息
表 70 中 ,VM见表 30。
6.7.6 修改负载均衡器信息(SetLBInfo)
6.7.6. 1 接口功能
该接口用于修改指定标识的负载均衡器的相关信息 。
如果操作成功 ,无返回信息 ;如果操作失败 ,应返回信息见表 4。
6.7.6.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :SetLBInfoReq
请求消息见表 71。
表 71 请求消息
b) 应答消息 :SetLBInfoResp
无应答消息 。
6. 8 安全组管理接口
6. 8. 1 概述
弹性计算服务平台通过安全组配置防火墙规则 ,实现对进出虚拟机的网络流量的控制 。任何一个
虚拟机都应属于一个或多个安全组 。一个安全组可包含多个虚拟机 。用户可以创建自有安全组 。如果用户在创建虚拟机时没有指定自有安全组 ,平台将为该虚拟机自动生成并分配一个默认安全组 。
本标准不提供变更一个虚拟机所属的安全组的接 口 。
用户 自有安全组和默认安全组的初始设置是 :
a) 允许所有外出的网络流 ;
b) 禁止所有进入的网络流 ;
c) 允许安全组内的虚拟机互相访问 。
用户可以通过添加或删除安全规则的方式修改用户 自有安全组和默认安全组 。
6. 8.2 创建安全组(CreateSG)
6. 8.2. 1 接口功能
该接口用于创建安全组 。
如果操作成功 ,返回新创建安全组的信息 ;如果操作失败 ,应返回信息见表 4。
6. 8.2.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :CreateSGReq
请求消息见表 72。
表 72 请求消息
b) 应答消息 :CreateSGResp
应答消息见表 73。
表 73 应答消息
6. 8.3 删除安全组(DeleteSG)
6. 8.3. 1 接口功能
该接口用于删除安全组 。
如果操作成功 ,无返回信息 ;如果操作失败 ,应返回信息见表 4。
6. 8.3.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :DeleteSGReq
请求消息见表 74。
表 74 请求消息
b) 应答消息 :DeleteSGResp无应答消息 。
6. 8.4 查询安全组信息(QuerySG)
6. 8.4. 1 接口功能
指定查询条件时 ,该接口用于查询指定编码的安全组的属性信息 ;不指定查询条件时 ,该接口返回当前用户所有可见的安全组 。
如果操作成功 ,返回安全组的属性信息 ;如果操作失败 ,应返回信息见表 4。
6. 8.4.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :QuerySGReq
请求消息见表 75。
表 75 请求消息
b) 应答消息 :QuerySGResp
应答消息见表 76。
表 76 应答消息
表 76中 ,Permission见表 77。
表 77 Permission
表 77中 ,IPRange见表 78。
表 78 IpRange
6. 8.5 添加安全规则(AddSGRules)
6. 8.5. 1 接口功能
该接口用于在安全组中添加一个安全规则 。
如果操作成功 ,返回结果应包含安全组编码和安全组内的安全规则编码 ;如果操作失败 ,应返回信息见表 4。
6. 8.5.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :AddSGRulesReq
请求消息见表 79。
表 79 请求消息
b) 应答消息 :AddSGRulesResp应答消息见表 80。
表 80 应答消息
6. 8.6 删除安全规则(DeleteSGRules)
6. 8.6. 1 接口功能
该接口用于在安全组中删除一个安全规则 。
如果操作成功 ,无返回信息 ;如果操作失败 ,应返回信息见表 4。
6. 8.6.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :DeleteSGRulesReq
请求消息见表 81。
表 81 请求消息
b) 应答消息 :DeleteSGRulesResp
无应答消息 。
6.9 密钥管理接口
6.9. 1 概述
当用户采用 SSH 的方式访问安装 Linux/Unix操作系统的虚拟机时 ,密钥管理为用户提供通过密钥认证登录虚拟机的方式 。
6.9.2 创建密钥对(CreateKeyPair)
6.9.2. 1 接口功能
该接口用于申请一个密钥对 。
如果操作成功 ,返回密钥信息 ;如果操作失败 ,应返回信息见表 4。
6.9.2.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :CreateKeyPairReq
请求消息见表 82。
表 82 请求消息
b) 应答消息 :CreateKeyPairResp应答消息见表 83。
表 83 应答消息
6.9.3 删除密钥对(DeleteKeyPair)
6.9.3. 1 接口功能
该接口用于删除密钥对 。
如果操作成功 ,无返回信息 ;如果操作失败 ,应返回信息见表 4。
6.9.3.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :DeleteKeyPairReq
请求消息见表 84。
表 84 请求消息
b) 应答消息 :DeleteKeyPairResp无应答消息 。
6.9.4 查询密钥对(QueryKeyPair)
6.9.4. 1 接口功能
该接口用于查询密钥信息 。
如果操作成功 ,无返回信息 ;如果操作失败 ,应返回信息见表 4。
6.9.4.2 接口消息
请求消息和应答消息如下 :
a) 请求消息 :QueryKeyPairReq请求消息见表 85。
表 85 请求消息
b) 应答消息 :QueryKeyPairResp应答消息见表 86。
表 86 应答消息
表 86中 ,密钥消息见表 87。
表 87 密钥消息
