Updated on 2023-07-24 GMT+08:00

Querying Information of an API Version

Function

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

URI

  • URI format

    GET /{api_version}

  • Parameter description

    Parameter

    Type

    Description

    api_version

    String

    Specifies the target API version.

    The value can be v1 or v2.

Request

  • Example request
    GET https://{endpoint}/v2

Response

  • Parameter description

    Parameter

    Type

    Description

    versions

    Array of objects

    Specifies the API version information. For details, see Parameters in the versions field.

  • Parameters in the versions field

    Parameter

    Type

    Description

    min_version

    String

    Specifies the minimum microversion supported. If this version does not support microversions, the value is an empty string.

    media-types

    Array of objects

    Specifies the request message type of the API version. For details, see Parameters in the media-types field.

    links

    Array of objects

    Specifies the URI of the API version. For details, see Parameters in the links field.

    id

    String

    Specifies the ID of the API version.

    updated

    String

    Specifies the last time when the API version was updated.

    Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

    version

    String

    Specifies the maximum microversion supported. If this version does not support microversions, the value is an empty string.

    status

    String

    Specifies the API version status. The value can be as follows:

    • CURRENT: EVS custom APIs provide multiple versions. For the APIs offering same functions, you are recommended to use the v2 APIs.
    • SUPPORTED: indicates an earlier version which is still supported.
    • DEPRECATED: indicates a deprecated version that may be deleted later.
  • Parameters in the media-types field

    Parameter

    Type

    Description

    type

    String

    Specifies the response type.

    base

    String

    Specifies the text type.

  • Parameters in the links field

    Parameter

    Type

    Description

    rel

    String

    Specifies the domain name description.

    href

    String

    Specifies the domain name.

    type

    String

    Specifies the response type.

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

  • Normal

    200

Error Codes

For details, see Error Codes.