• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Nova
  5. API Information
  6. Listing Versions

Listing Versions

Function Description

This interface is used to query all available versions of Nova.

To support function extension, Nova APIs support distinction by version number. There are two types of version numbers:

  • Major version: independent URL
  • Micro version: requested using the X-OpenStack-Nova-API-Version header or the OpenStack-API-Version header since micro version 2.27.

Interface Format

Method

URI

Description

GET

/

Queries all available versions.

Request Example

GET /

Response Parameters

Parameter

Type

Mandatory

Description

versions

List<version>

Yes

Available API versions

links

List<link>

No

Description of the version. For details, see http://developer.openstack.org/api-guide/compute/links_and_references.html.

id

String

No

Common name of the version. The parameter has no special meaning.

status

String

No

API version status. Available values include:

CURRENT: preferred API version

SUPPORTED: earlier but still supported API version

DEPRECATED: outdated API version that will be removed soon

min_version

String

Yes

If the API micro version is supported, the supported earliest micro version is returned. If the API micro version is not supported, an empty character string is returned.

updated

String

Yes

The value is a fixed character string. For version 2.0, the value is 2011-01-21T11:33:21Z. For version 2.1, the value is 2013-07-23T11:33:21Z.

version

String

Yes

If the API micro version is supported, the supported latest micro version is returned. If the API micro version is not supported, an empty character string is returned.

Response Example

{
  "versions": [
    {
      "links": [
        {
          "rel": "self",
          "href": "https://192.168.82.231:443/v2/"
        }
      ],
      "id": "v2.0",
      "updated": "2001-09-21T12:33:21Z",
      "status": "SUPPORTED"
    }
  ]
}