• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Cinder V3 Interfaces
  5. Volumes
  6. Show V3 Version

Show V3 Version

Function Description

This interface is used to query the V3 API versions.

Interface Format

Method

URI

Description

GET

/v3/

Queries the V3 API versions.

Restrictions

None

Expanded Interface

None

Request Parameter

None

Response Parameter

Parameter

Type

Mandatory

Remarks

min_version

string

Yes

Specifies the minimum API version.

media-types

List< Dict >

Yes

Specifies the request message type of the API version.

links

list< Dict >

Yes

Specifies the URI of the API version.

id

string

Yes

Specifies the ID of the API version.

updated

string

Yes

Specifies the last time when the API version is updated.

version

string

Yes

Specifies the sub-version of the API version.

status

string

Yes

Specifies the API version status.

media-types parameter description

Parameter

Type

Mandatory

Remarks

type

string

Yes

Specifies the response type.

base

string

Yes

Specifies the text type.

links parameter description

Parameter

Type

Mandatory

Remarks

rel

string

Yes

Specifies the domain name description.

href

string

Yes

Specifies the domain name.

type

string

Yes

Specifies the response type.

Request Example

GET https://volume.localdomain.com:8776/v3/

Response Example

{
  "versions": [
    {
      "min_version": "",
      "media-types": [
        {
          "type": "application/vnd.openstack.volume+json;version=1",
          "base": "application/json"
        },
        {
          "type": "application/vnd.openstack.volume+xml;version=1",
          "base": "application/xml"
        }
      ],
      "links": [
        {
          "rel": "describedby",
          "href": "http://docs.openstack.org/",
          "type": "text/html"
        },
        {
          "rel": "self",
          "href": "https://evs.localdomain.com/v2"
        }
      ],
      "id": "v3.0",
      "updated": "2014-06-28T12:20:21Z",
      "version": "",
      "status": "CURRENT"
    }
  ]
}

Error Code

See section Processing Return Code.