John Garbutt cf44f0ab7d docs: re-organise the API concept docs

This moves material from 2.0_general_info into the index to make an
improved index page.

Some details from the general_info have been moved into the server
concepts, where that information is a better fit.

The general_info page has been expanded with TODOs so we are clear
about some the missing details.

Co-Authored-By: Ed Leafe <ed@leafe.com>

Change-Id: I2a878586d6a073026d1f997e6f0f7ee87a01f726

2015-10-06 14:17:52 +00:00

2.8 KiB

Raw Blame History

Compute API

OpenStack Nova has a ReSTful HTTP service called the OpenStack Compute API. Through this API, Nova 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.

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 web services
HTTP/1.1
JSON data serialization formats

Versions and Extensions

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

/ - list of available versions
/v2.0 - the first version of the Compute API, uses extensions
/v1.1 - an alias for v2.0 for backwards compatibility
/v2.1 - same API, except uses microversions

For more information on how to make use the API, how to get the endpoint from the keystone service catalog and pick what version of the API to use, please read:

versions extensions microversions

Key API Concepts

The following documents go into more details about the key concepts of the OpenStack Compute API:

2.0_general_info 2.0_server_concepts authentication faults limits links_and_references paginated_collections polling_changes-since_parameter request_and_response_formats

Full Reference

For a full reference listing for the OpenStack Compute API, please see:

2.8 KiB Raw Blame History