Help Center/ Elastic Volume Service/ API Reference/ Cinder API/ API Version Query/ Querying Information of an API Version
Updated on 2024-02-27 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Information of an API Version

Function

This API is used to query information of an API version.

Calling Method

For details, see Calling APIs.

URI

GET /{version}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

version

Yes

String

The API version to be queried. The value can be v1, v2, or v3.

Enumeration values:

  • v1

  • v2

  • v3

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The user token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

versions

Array of Versions objects

The version information.
Table 4 Versions

Parameter

Type

Description

id

String

The API version ID.

links

Array of Link objects

The API version URI.

media-types

Array of MediaTypes objects

The request message type of the API version.

min_version

String

The minimum API version.

status

String

The API version status.

updated

String

The last time when the API version was updated.

version

String

The API version number.
Table 5 Link

Parameter

Type

Description

href

String

The corresponding shortcut link.

rel

String

The shortcut link marker name.

Default: next
Table 6 MediaTypes

Parameter

Type

Description

base

String

The text type.

type

String

The return type.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs.
Table 8 Error

Parameter

Type

Description

code

String

The error code returned if an error occurs.

For details about error codes and their meanings, see Error Codes.

message

String

The error message returned if an error occurs.

Example Requests

GET https://{endpoint}/{version}

https://{endpoint}/{version}

Example Responses

Status code: 200

The version details.

{
  "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" : "v2.0",
    "updated" : "2014-06-28T12:20:21Z",
    "version" : "",
    "status" : "SUPPORTED"
  } ]
}

Status code: 400

Bad Request

{
  "error" : {
    "code" : "string",
    "message" : "string"
  }
}

Status Codes

Status Code

Description

200

The version details.

400

Bad Request

Error Codes

See Error Codes.

Parent Topic: API Version Query