• Bare Metal Server

bms
  1. Help Center
  2. Bare Metal Server
  3. API Reference
  4. API
  5. API Version Query (Native OpenStack API)
  6. Querying an API Version (Native OpenStack API)

Querying an API Version (Native OpenStack API)

Function

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

To support function extension, Nova APIs can be distinguished by version. There are two types of versions:

  • Major version: independent URL
  • Microversion: Used by the HTTP request header X-OpenStack-Nova-API-Version. Since microversion 2.27, the new microversion header OpenStack-API-Version has been supported.

URI

GET /{api_version}

Table 1 lists the parameters.

Table 1 Parameter description

Parameter

Mandatory

Description

api_version

Yes

Specifies the API version, for example v2.

Request Message

  • Example request
    GET /v2

Response Message

  • Example response
    {
        "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"
        }
    }

Returned Values

See section Common Returned Values.