OpenStack API 文档

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

注意

以下链接根据 API 状态分组,该状态反映了服务上端点的状态。

  • “当前”表示一个稳定版本,该版本是最新的、最新的,并且可能接收未来版本。应优先使用此端点,而不是其他所有端点。

  • “受支持”是一个稳定的版本,可在服务器上使用。但是,它可能不是最新的可用版本,并且可能在未来被更新或弃用。

  • “已弃用”是一个稳定的版本,该版本仍然可用,但正在被弃用,并且将来可能会被删除。

  • “实验性”不是一个稳定的版本。此版本正在开发中,或包含以其他方式可能发生更改的功能。

有关 API 状态值和版本信息的更多信息,请参阅 版本发现

链接旁边的“(微版本)”表示 API 遵循 计算服务建立的模式,以便在资源的基础上对 API 进行小的、有文档记录的更改。

当前 API 版本

加速 API v2

Admin Logic API

应用目录 API v1

应用容器服务 API (微版本)

备份 API v2

裸机 API v1 (微版本)

块存储 API v3 (微版本)

注意

块存储 API v3 在功能上与块存储 API v2 相同。后续 API v3 微版本,例如 v3.1,与 API v2 不同。

集群 API v1

计算 API (微版本)

容器基础设施管理 API (微版本)

数据处理 v1.1

数据保护编排 v1

数据库服务 API v1.0

域名服务器 (DNS) API v2

EC2 API 服务

函数引擎

身份验证 API v3

身份验证 API v3 扩展

镜像服务 API v2

密钥管理 API v1

负载均衡器 API v2

消息传递 API v2

网络 API v2.0

NFV 编排 API v2.0

对象存储 API v1

编排 API v1

Placement API (微版本)

资源优化 API v1

搜索 API v1

共享文件系统 API v2 (微版本)

注意

共享文件系统 API v1 在功能上与共享文件系统 API v2 相同。后续 API v2 微版本,例如 v2.1,与 API v1 不同。

受支持的 API 版本

NFV 编排 API v1.0

已弃用的 API 版本

块存储 API v2

注意

块存储 API v3 在功能上与块存储 API v2 相同。后续 API v3 微版本,例如 v3.1,与 API v2 不同。

身份验证 API v2.0 扩展

API 快速入门示例

使用 TryStack OpenStack 安装,这些服务在安装的后台协同工作,并且许多这些示例在 TryStack 上有效。

在您通过身份验证进行身份验证后,可以使用其他 OpenStack API 来创建和管理 OpenStack 云中的资源。您可以通过计算 API 或 openstack 命令行客户端从镜像启动实例并为实例分配元数据。

要开始发送 API 请求,请使用以下方法之一

  • cURL

    一种命令行工具,可让您发送 HTTP 请求并接收响应。请参阅名为 OpenStack API 的部分。

  • OpenStack 命令行客户端

    OpenStack 项目提供了一个命令行客户端,使您能够通过易于使用的命令访问 API。请参阅名为 OpenStack 命令行客户端 的部分。

  • REST 客户端

    Mozilla 和 Google 都提供基于浏览器的 REST 图形界面。对于 Firefox,请参阅 RESTClient。对于 Chrome,请参阅 rest-client

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

    使用此 SDK 编写 Python 自动化脚本,以创建和管理 OpenStack 云中的资源。SDK 实现了 Python 对 OpenStack API 的绑定,使您能够通过在 Python 对象上进行调用而不是直接进行 REST 调用来在 Python 中执行自动化任务。所有 OpenStack 命令行工具都是使用 Python SDK 实现的。请参阅《OpenStack End User Guide》中的 OpenStack Python SDK