OpenStack API Documentation

OpenStack API文档

在你的OpenStack云中,使用OpenStack API来启动服务器云主机,创建镜像、给实例和镜像分配元数据、创建存储容器和对象以及完成其他相关的动作。

当前API 版本

应用目录API v1

Application Container Service API (microversions)

备份API v1

裸机API v1 (微版本)

`块存储API v3 <https://developer.openstack.org/api-ref/block-storage/v3/>`__(微版本)

注解

块存储API v3在功能上等同于块存储API v2。随后的API v3微版本与API v2不同,比如v3.1。

集群API v1

`计算服务API v1 <https://developer.openstack.org/api-ref/compute/>`__(微版本)

`容器基础设施管理API <https://developer.openstack.org/api-ref/container-infrastructure-management/>`__(微版本)

数据处理 v1.1

数据保护编配 v1

数据库服务API v1.0

域名解析服务(DNS) API v2

EC2 API服务

身份认证API v3

身份认证API v3扩展

镜像服务API v2

负载均衡API v2

Messaging API v2

Networking API v2.0

NFV编配API v1.0

Object Storage API v1

编配API v1

搜 API v1

Shared File Systems API v2 (microversions)

注解

共享文件系统API v1版本与 v2版本在功能上是一致的。随后的API v2微版本,例如v2.1,与API v1是不同的。

支持的API版本

不支持的API版本

块存储API v2

注解

块存储API v3在功能上等同于块存储API v2。随后的API v3微版本与API v2不同,比如v3.1。

身份认证API v2.0

身份认证管理API v2.0

身份认证API v2.0 扩展

镜像服务API v1

API的状态反应了服务端点的状态。

  • Current代表一个稳定的版本,它保持更新的,最新的,可能会接纳未来的版本。它应该优先域所有其他版本。
  • Supported是在服务器上可用的稳定版本。然而,它可能是最新可用,并且可能不会更新或者在未来某一时刻不赞成使用。
  • Deprecated是一个仍然可用稳定版本,但是不推荐使用,在将来可能会被删除。
  • Experimental不是一个稳定版本。这种版本还在开发中或者包含很有可能发生变化的特性。有关API状态和版本的更多信息,请参考`版本揭秘 <https://wiki.openstack.org/wiki/VersionDiscovery>`__。
  • Microversions指示API遵从`计算服务模式建立 <https://developer.openstack.org/api-guide/compute/microversions.html>`,以便在逐个资源的基础上对API做小的、文档类型的改变。

API 快速入门示例

在`TryStack <http://www.trystack.org/>`__ OpenStack安装过程中,这些服务在安装的背景下协同工作, 许多这些例子在TryStack下工作。

当你通过认证服务认证后,你可以使用其他的 OpenStack API 来创建和管理你OpenStack云环境下的资源。你可以通过计算服务API或者 OpenStack 命令行客户端启动用镜像创建的实例以及为云主机配置参数。

使用如下的方法之一发送 API 请求:

  • cURL

    命令行工具可以让你发送HTTP请求和接收响应。请参考`openstack_API_quick_guide`部分。

  • OpenStack命令行客户端

    OpenStack工程提供了一个能够让你通过简单命令去访问APIs的命令行客户端,请参考`client-intro`。

  • REST客户端

    Mozilla和Google都为REST提供了基于浏览器的图形接口。对于Firefox浏览器,请参看`RESTClient <https://addons.mozilla.org/en-US/firefox/addon/restclient/>`。对于Chrome浏览器,请参看`rest-client <http://code.google.com/p/rest-client/>`。

  • OpenStack Python软件开发工具包(SDK)

    你可以使用SDK编写自动化Python脚本,用于创建和管理你的Openstack云环境中的资源。SDK实现了Python绑定OpenStack API,这能够让你使用Python实现自动化任务通过调用Python对象,而不用直接调用REST接口。所有的OpenStack命令行工具都可以使用Python SDK实现。在*OpenStack Python SDK *中查看`OpenStack Python SDK <https://docs.openstack.org/user-guide/sdk.html>`。

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.