OpenStack API Documentation

OpenStack API ドキュメント

OpenStack API を使用すると、OpenStack クラウドにおいて、サーバーインスタンスの起動、イメージの作成、インスタンスやイメージへのメタデータの割り当て、ストレージコンテナーやオブジェクトコンテナーの作成、他の操作などを実行できます。


The links below are grouped according to the API status that reflects the state of the endpoint on the service.

  • 'Current' indicates a stable version that is up-to-date, recent, and might receive future versions. This endpoint should be prioritized over all others.

  • 'Supported' is a stable version that is available on the server. However, it is not likely the most recent available and might not be updated or might be deprecated at some time in the future.

  • 'Deprecated' is a stable version that is still available but is being deprecated and might be removed in the future.

  • 'Experimental' is not a stable version. This version is under development or contains features that are otherwise subject to change.

For more information about API status values and version information, see Version Discovery.

The notation '(microversions)' next to the link to an API reference 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 バージョン

Acceleration API v1

`アプリケーションカタログAPI v1 <>`__

Application Container Service API (microversions)

Backup API v1

Bare Metal API v1 (マイクロバージョン)

Block Storage API v3 (マイクロバージョン)


Block Storage API v3 は、Block Storage API v2 と同じ機能を提供します。将来の API v3 マイクロバージョン、v3.1 などは、API v2 と異なります。

Clustering API v1

Compute API (マイクロバージョン)

Container Infrastructure Management API (マイクロバージョン)

Data Processing v1.1

Data Protection Orchestration v1

Database Service API v1.0

Domain Name Server (DNS) API v2

EC2 API Service

Function Engine

Identity API v3

Identity API v3 extensions

Image service API v2

Key Manager API v1

Load Balancer API v2

Messaging API v2

Networking API v2.0

NFV Orchestration API v1.0

Object Storage API v1

Orchestration API v1

Placement API (microversions)

Resource Optimization API v1

Search API v1

Shared File Systems API v2 (microversions)


Shared File Systems API v2 は、Shared File Systems API v1 と同じ機能を提供します。将来の API v2 マイクロバージョン、v2.1 などは、API v1 と異なります。

サポート API バージョン

非推奨 API バージョン

Block Storage API v2


Block Storage API v3 は、Block Storage API v2 と同じ機能を提供します。将来の API v3 マイクロバージョン、v3.1 などは、API v2 と異なります。

Identity API v2.0 extensions

API クイックスタートの例

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

Identity 経由で認証した後、他の OpenStack API を使用して、 OpenStack クラウドにリソースを作成したり管理したりできます。 Compute API や openstack コマンドラインクライアントを用いて、イメージからインスタンスを起動し、メタデータをインスタンスに割り当てることができます。

API リクエストを送信するには、以下の方法のいずれかを使用します。

  • cURL

    HTTP リクエストを送信し、レスポンスを受信できるコマンドラインツール。OpenStack API を参照してください。

  • OpenStack コマンドラインクライアント

    OpenStack の各プロジェクトは、使いやすいコマンドから API にアクセスできるコマンドラインクライアントを提供しています。 OpenStack コマンドラインクライアント を参照してください。

  • REST クライアント

    Both Mozilla and Google provide browser-based graphical interfaces for REST. For Firefox, see RESTClient. For Chrome, see rest-client.

  • OpenStack Python Software Development Kit (SDK)

    SDK を使って、OpenStack クラウドでリソースの作成や管理を自動化する Python ツールを作成できます。この SDK は OpenStack API への Python バインディングの実装で、これを使うことで、直接 REST コールを発行するのではなく、Python オブジェクトに対する呼び出しで Python で自動化タスクを実行できます。すべての OpenStack コマンドラインツールは Python SDK を使用して実装されています。OpenStack エンドユーザーガイドOpenStack Python SDK を参照してください。

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.