openstack/nova
Code Issues Proposed changes
nova/api-guide/source/index.rst
Takashi NATSUME ddf7c6e370 Improve formats of the Compute API guide 
Replace the 'NOTE' and 'TODO' words with
the note and todo directives in the Compute API guide.

Improve some format in the guide.
e.g. Fix unnecessary bold characters.

Change-Id: I7e9d6b8a5228886fd5de03d12482481d2b652666
Closes-Bug: #1558459
2018-11-07 04:01:40 +00:00

2.8 KiB
Raw Blame History

Compute API

The nova project has a RESTful HTTP service called the OpenStack Compute API. Through this API, the service provides massively scalable, on demand, self-service access to compute resources. Depending on the deployment those compute resources might be Virtual Machines, Physical Machines or Containers.

This guide covers the concepts in the OpenStack Compute API. For a full reference listing, please see: Compute API Reference.

We welcome feedback, comments, and bug reports at bugs.launchpad.net/nova.

Intended audience

This guide assists software developers who want to develop applications using the OpenStack Compute API. To use this information, you should have access to an account from an OpenStack Compute provider, or have access to your own deployment, and you should also be familiar with the following concepts:

  • OpenStack Compute service
  • RESTful HTTP services
  • HTTP/1.1
  • JSON data serialization formats

End User and Operator APIs

The Compute API includes all end user and operator API calls. The API works with keystone and oslo.policy to deliver RBAC (Role-based access control). The default policy file gives suggestions on what APIs should not be made available to most end users but this is fully configurable.

API Versions

Following the Mitaka release, every Nova deployment should have the following endpoints:

  • / - list of available versions
  • /v2 - the first version of the Compute API, uses extensions (we call this Compute API v2.0)
  • /v2.1 - same API, except uses microversions

While this guide concentrates on documenting the v2.1 API, please note that the v2.0 is (almost) identical to first microversion of the v2.1 API and are also covered by this guide.

Contents

users versions microversions general_info server_concepts authentication faults limits links_and_references paginated_collections polling_changes request_and_response_formats

extra_specs_and_properties