• Native OpenStack API

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

Getting Version

Function Description

This interface is used to get the information of a specified version.

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

/{api_version}

Gets the information of a specified version.

Request Example

GET /v2

Response Parameters

Parameter

Type

Mandatory

Description

version

String

Yes

API version

links

Array

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

version

String

No

If the API micro version is supported, this parameter indicates the maximum micro version number. Otherwise, the value is an empty character string.

min_version

String

No

If the API micro version is supported, this parameter indicates the minimum micro version number. Otherwise, the value is an empty character string.

updated

String

No

This parameter has no actual meaning and may be removed in later versions.

Media-types

Array

No

This parameter has no actual meaning and may be removed in later versions.

Response Example

{
  "version": {
    "min_version": "",
    "media-types": [
      {
        "type": "application/vnd.openstack.compute+json;version=2",
        "base": "application/json"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://ecs.service.domain.com:443/v2/"
      },
      {
        "rel": "describedby",
        "href": "http://docs.openstack.org/",
        "type": "text/html"
      }
    ],
    "id": "v2.0",
    "updated": "1999-02-20T11:33:21Z",
    "version": "",
    "status": "SUPPORTED"
  }
}