openstack/nova
Code Issues Proposed changes
cccc937554
nova/api-guide/source/index.rst
Ken'ichi Ohmichi 1c6076a2fb Fix the endpoint of /v2 on concept doc 
As the folloing content of etc/nova/api-paste.ini, legacy v2
endpoint is /v2, not /v2.1.

 /v1.1: openstack_compute_api_v21_legacy_v2_compatible
 /v2: openstack_compute_api_v21_legacy_v2_compatible
 /v2.1: openstack_compute_api_v21

So this patch fixes the endpoint.

Partially implements blueprint complete-todo-in-api-concept-doc

Change-Id: I6d9346ced38f522c516778cadae217d1d5c9cff1
2015-12-08 12:50:54 +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 Liberty 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)

  • /v1.1 - an alias for v2.0 for backwards compatibility
  • /v2.1 - same API, except uses microversions

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

Contents

versions extensions microversions general_info server_concepts authentication faults limits links_and_references paginated_collections polling_changes-since_parameter request_and_response_formats