文档首页/ 云硬盘 EVS/ API参考/ API版本信息查询/ 查询接口的版本信息
更新时间:2024-02-27 GMT+08:00

查询接口的版本信息

功能介绍

查询API接口的版本信息。

URI

  • URI格式

    GET /{api_version}

  • 参数说明

    参数

    参数类型

    描述

    api_version

    String

    查询的目标版本号。

    取值为:v1、v2。

请求消息

  • 请求样例:
    GET https://{endpoint}/v2

响应消息

  • 响应参数

    参数

    参数类型

    描述

    versions

    Array of objects

    接口版本信息列表,请参见•versions参数说明

  • versions参数说明

    参数

    参数类型

    描述

    min_version

    String

    接口版本支持的最小微版本号。如果该版本不支持微版本,则为空字符串。

    media-types

    Array of objects

    接口版本的请求消息类型信息,请参见•media-types参数说明

    links

    Array of objects

    接口版本信息的URI描述信息,请参见•links参数说明

    id

    String

    接口版本的ID。

    updated

    String

    接口版本更新时间。

    时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

    version

    String

    接口版本支持的最大微版本号。如果该版本不支持微版本,则为空字符串。

    status

    String

    接口版本的状态。存在以下状态:

    • CURRENT:EVS自定义API提供了多个版本。在接口功能相同的情况下,推荐您优先使用v2接口。
    • SUPPORTED:表示为老版本,但是现在还在继续支持。
    • DEPRECATED:表示为废弃版本,存在后续删除的可能。
  • media-types参数说明

    参数

    参数类型

    描述

    type

    String

    返回类型

    base

    String

    文本类型

  • links参数说明

    参数

    参数类型

    描述

    rel

    String

    域名的描述

    href

    String

    域名

    type

    String

    返回类型

  • 响应样例
    {
        "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"
            }
        ]
    }

错误码

请参见错误码