云海IaaS开放API设计思路-v0.711

云海 IaaS 对外开放 API 设计思路

简介

欢迎使用云海 IaaS 云弹性计算服务。用户可以使用本文档介绍的 API 对云海 IaaS 云服

务进行相关操作。

术语表

对云海 IaaS 开放 API 接口调用是通过向 API 的服务器端地址发送 HTTP 或者 HTTPS 请求，

并按照接口说明在请求中加入相应请求参数来完成的；根据请求的处理情况，系统返回处理

结果。

流程设计

第三方应用调用云海 IaaS 开放 API 接口发送 HTTPS 请求给 API-Server，API-Server 完成认

证鉴权后，调用 resource-scheduler，进而根据请求动作，实现相应的功能。具体流程图如下：

当请求处理完成得到成功返回结果后，云平台根据相应的请求动作，根据用户选定的计费方

式对部分操作进行扣费处理，扣费成功后，用户方可正常使用云主机。具体流程图如下：

支持通过 HTTP 或 HTTPS 通道进行请求通信。为了获得更高的安全性，推荐您使用

HTTPS 通道发送请求。

支持 HTTP GET 方法发送请求，这种方式下请求参数需要包含在请求的 URL 中。

每个请求都需要指定要执行的操作，即 Action 参数（例如 CreateInstance），以及每个操作

都需要包含的公共请求参数和指定操作所特有的请求参数。

请求及返回结果都使用 UTF-8 字符集进行编码。

返回结果

第三方应用在调用开放接口时，API-Server 需要对第三方请求进行认证鉴权，所以无论是使

用 HTTP 还是 HTTPS 协议提交请求，都需要在请求中包含签名（Signature）信息。云海 IaaS

是通过使用 APPKey 和 APPKeySecret 进行对称加密的方法来验证请求的发送者身份。

APPKey 和 APPKeySecret 是由云海 IaaS 平台提供给第三方的，其中 APPKey 用于标识云海

IaaS 平台开放接口；APPKeySecret 是用于加密签名字符串和 API-Server 进行验证签名字符

串的密钥，必须严格保密，只有云海和第三方知道。

第三方在访问时，按照下面的方法对请求进行签名处理：

1.

计费管理

API 概览

APPKEY 和 SECRETKEY 获取接口（/common）

示例：

${baseUrl}/common/gainAppkey?Version=2015-10-

20&AccessToken=fdf17d3081b449298e5c323cee2f0cb6&UserEmail=free@free4lab.com

返回：

实例相关接口

镜像相关接口