没有合适的资源?快使用搜索试试~ 我知道了~
资源详情
资源评论
资源推荐
云海 IaaS 对外开放 API 设计思路
简介
欢迎使用云海 IaaS 云弹性计算服务。用户可以使用本文档介绍的 API 对云海 IaaS 云服
务进行相关操作。
术语表
术语
中文
说明
Instance
弹 性 计 算 服 务
实例,简称实例
是一个通过物理服务器,采用虚拟化技术虚拟出来的计算
机。
Region
地域
代表资源所在的地域,每个地域包含一组可用区。
Zone
可用区
同一地域内,电力和网络互相独立的物理区域。同一可用
区内的 ECS 实例网络延时更小。在同一地域内可用区与
可用区之间内网互通,可用区之间能做到故障隔离。
Image
镜像文件,简称
镜像
操作系统和应用软件都可以制作成镜像文件,用户可以选
择某镜像文件来初始化云服务器实例。
镜像是创建实例的必要条件。新创建实例的系统盘内容是
镜像内容的完全拷贝,包括操作系统,软件配置等内容。
因此,创建不同操作系统版本的实例需要选择不同的镜像
文件。
Disk
磁盘
实例所使用的存储设备。
Snapshot
快照
为磁盘创建的数据还原点,包含特定时刻磁盘的数据,可
以用于还原磁盘数据或创建自定义镜像。
IP
IP 地址
互联网上的公网 IP 地址。
SecurityGroup
安全组
实例相关的安全组,可以使用安全组制定安全策略,一个
实例必须属于某个安全控制组,也可以属于多个安全组,
组中的实例继承安全组的安全策略
CIDR
无 类 别 域 间 路
由选择
是互联网中一种新的寻址方式,与传统的 A 类、B 类和
C 类寻址模式相比,CIDR 在 IP 地址分配方面更为高效。
例如 IP 号段是 125.203.96.0 - 125.203.127.255,转化
cidr 格式就是找相同的前十九位:
125.203.0110 0000.0000 0000 到 125.203.0111 1111.1111
1111 可以写成 125.203.96.0/19
调用方式
对云海 IaaS 开放 API 接口调用是通过向 API 的服务器端地址发送 HTTP 或者 HTTPS 请求,
并按照接口说明在请求中加入相应请求参数来完成的;根据请求的处理情况,系统返回处理
结果。
流程设计
第三方应用调用云海 IaaS 开放 API 接口发送 HTTPS 请求给 API-Server,API-Server 完成认
证鉴权后,调用 resource-scheduler,进而根据请求动作,实现相应的功能。具体流程图如下:
功能调用
操作云主机
认证鉴权模块
IaaS门户 第三方应用
HTTP请求
应用
HTTP(s)请求
直接调用
RPC请求
API-Server
底层模块
图一 云海 IaaS 处理开放 API 流程图
当请求处理完成得到成功返回结果后,云平台根据相应的请求动作,根据用户选定的计费方
式对部分操作进行扣费处理,扣费成功后,用户方可正常使用云主机。具体流程图如下:
云平台
欠费
Api-server关机
成功
Account
扣费
返回
图二 调用开放 API 操作扣费流程
请求结构
服务地址
云海 IaaS 云 API 的服务接入地址一般根据第三方提供的域名而定,实验室 API 接入地址为:
iaasapi.free4lab.com
通信协议
支持通过 HTTP 或 HTTPS 通道进行请求通信。为了获得更高的安全性,推荐您使用
HTTPS 通道发送请求。
请求方法
支持 HTTP GET 方法发送请求,这种方式下请求参数需要包含在请求的 URL 中。
请求参数
每个请求都需要指定要执行的操作,即 Action 参数(例如 CreateInstance),以及每个操作
都需要包含的公共请求参数和指定操作所特有的请求参数。
字符编码
请求及返回结果都使用 UTF-8 字符集进行编码。
返回结果
调用 API 服务后返回数据采用统一格式,返回的 HTTP 状态码为 2xx,代表调用成功;
返回 4xx 或 5xx 的 HTTP 状态码代表调用失败。调用成功返回的数据格式主要有 XML
和 JSON 两种,外部系统可以在请求时传入参数来制定返回的数据格式,默认为 XML 格
式。本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换
行、缩进等处理的。
安全机制
第三方应用在调用开放接口时,API-Server 需要对第三方请求进行认证鉴权,所以无论是使
用 HTTP 还是 HTTPS 协议提交请求,都需要在请求中包含签名(Signature)信息。云海 IaaS
是通过使用 APPKey 和 APPKeySecret 进行对称加密的方法来验证请求的发送者身份。
APPKey 和 APPKeySecret 是由云海 IaaS 平台提供给第三方的,其中 APPKey 用于标识云海
IaaS 平台开放接口;APPKeySecret 是用于加密签名字符串和 API-Server 进行验证签名字符
串的密钥,必须严格保密,只有云海和第三方知道。
第三方在访问时,按照下面的方法对请求进行签名处理:
1.
计费管理
目前通过云海 IaaS 开放 API 开通的云主机统一采用“按需付费”的付费模式。用
户按需取用,按需付费,无需购买大量设备,随时开通和释放云主机。
云海云主机采用先充值,后按实际用量结算方式进行结算。以小时为单位,按实际
消费金额对账户余额进行扣费。“按需付费”云主机计费项包括:CPU、内存、数据盘、
公网带宽。用户开通云主机后,采用整点计费规则,直到云主机释放。整点扣费后,因
账户余额不足导致欠费的,定时进行通知。欠费虚拟机保存一周后自动释放。具体流程
如下:
API 概览
APPKEY 和 SECRETKEY 获取接口(/common)
API
描述
gainAppkey
创建云主机实例
示例:
${baseUrl}/common/gainAppkey?Version=2015-10-
20&AccessToken=fdf17d3081b449298e5c323cee2f0cb6&UserEmail=free@free4lab.com
返回:
实例相关接口
API
描述
CreateInstance
创建云主机实例
StartInstance
启动一个指定的云主机实例
StopInstance
停止一个指定的云主机实例
RebootInstance
重启指定的实例
DescribeInstanceStatus
批量获取当前用户所有实例的状态信息,也
可用于获取实
例列表
SuspendInstance
挂起云主机实例
ResumeInstance
恢复云主机实例
MigrateInstance
离线迁移云主机实例
OnlineMigrateInstance
在线迁移云主机实例
DeleteInstance
根据传入实例的名称来释放实例资源
ModifyInstanceAttribute
修改实例密码、实例名称、安全组等属性信
息
ModifyInstanceResource
修改云主机资源配置
ModifyInstanceChargeType
修改云主机付费方式
ModifyInstanceSecurityGroup
修改示例安全组
ResetInstance
重置云主机
IsoDetach
云主机 ISO 安装
IsoBoot
云主机 ISO 启动
DescribeInstanceMonitorData
查看云服务器实例的监控信息
磁盘相关接口
API
描述
CreateDisk
创建云磁盘
AttachDisk
挂载云磁盘
DetachDisk
卸载磁盘
DeleteDisk
删除磁盘
ResetDisk
快照回滚磁盘
DescribeDisks
查询磁盘
镜像相关接口
API
描述
CreateImage
创建镜像
DeleteImage
删除镜像
ModifyImageAttribute
修改镜像基本属性
GetImageDetail
获取镜像信息
DescribeImages
按条件查询镜像
快照相关接口
API
描述
CreateSnapshot
对指定的磁盘存储设备创建快照
剩余90页未读,继续阅读
大头蚊香蛙
- 粉丝: 17
- 资源: 317
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0