OpenStack API Documentation

OpenStack API文档

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

当前API 版本

裸金属 API v1 <https://developer.openstack.org/api-ref/baremetal/>`__ (微版本)

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

注解

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

Clustering API v1

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

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

Data Processing v1.1

Data Protection Orchestration v1

Database Service API v1.0

Domain Name Server (DNS) API v2

EC2 API Service

Identity API v3

Identity API v3 extensions

Image service API v2

Messaging API v2

Networking API v2.0

NFV Orchestration API v1.0

Object Storage API v1

Orchestration API v1

Search API v1

`共享文件系统API v2<https://developer.openstack.org/api-ref/shared-file-systems>`__(微版本)

注解

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

支持的API版本

Block Storage API v2

不支持的API版本

Block Storage API v1

Identity API v2.0

Identity admin API v2.0

Identity API v2.0 extensions

Image service API v1

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

  • Current indicates a stable version that is up-to-date, recent, and might receive future versions. This endpoint should be prioritized over all others.
  • 支持的是在服务器上可用的稳定版本。它不会在最近不可用,并且被更新或者在将来某一时刻不被推荐使用。

  • 不推荐的选项在稳定版本中仍然可用,但是不推荐使用,在将来可能会被删除。

  • 实验性质的版本不是稳定版本。这种版本还在开发中或者包含很有可能发生变化的特性。有关API状态和版本的更多信息,请参考版本揭秘 <https://wiki.openstack.org/wiki/VersionDiscovery>。

  • Microversions indicates that the API follows a pattern established by the Compute service to enable small, documented changes to the API on a resource-by-resource basis.

API 快速入门示例

With the TryStack OpenStack installation, these services work together in the background of the installation, and many of these examples work on TryStack.

当你通过认证服务认证后,你可以使用其他的OpenStack APIs 来创建和管理你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软件开发工具包。

    Use this SDK to write Python automation scripts that create and manage resources in your OpenStack cloud. The SDK implements Python bindings to the OpenStack API, which enables you to perform automation tasks in Python by making calls on Python objects rather than making REST calls directly. All OpenStack command-line tools are implemented by using the Python SDK. See OpenStack Python SDK in the OpenStack End User Guide.

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.