文档首页/ 弹性云服务器 ECS/ API参考/ 历史API/ 查询API版本信息（OpenStack Nova API）/ 查询指定API版本信息（废弃）
更新时间：2024-12-03 GMT+08:00
查看PDF
分享

查询指定API版本信息（废弃）

功能介绍

返回指定版本的信息。

为了支持功能不断扩展，Nova API支持版本号区分。Nova中有两种形式的版本号：

  • "主版本号": 具有独立的url。
  • "微版本号": 通过Http请求头X-OpenStack-Nova-API-Version来使用，从 2.27 版本开始支持新的微版本头：OpenStack-API-Version。

    如果使用OpenStack-API-Version的请求头，version对应的value取值格式为 compute 微版本号。

    例如：key为OpenStack-API-Version的时候value需要填compute 2.27。

调试

您可以在API Explorer中调试该接口。

URI

GET /{api_version}

参数说明请参见表1。
表1 参数说明

参数

是否必选

描述

api_version

是

API版本号。例如: v2

请求消息

无

响应消息

响应参数如表2所示。

表2 响应参数

参数

参数类型

描述

versions

Object

指定版本信息，详情请参见表3。
表3 versions字段数据结构说明

参数

参数类型

描述

id

string

所讨论的版本的通用名称。仅是信息性的，它没有真正的语义。

links

Object

链接到资源的问题。有关更多信息，请参见OpenStack Documentation。

详情请参见表4。

media-types

Object

媒体类型。详情请参见表5。

min_version

string
  • 如果API的这个版本支持微版本，则支持最小的微版本。
  • 如果不支持微版本，这将是空字符串。

status

string

API版本的状态：

  • CURRENT这是使用的API的首选版本；
  • SUPPORTED：这是一个较老的，但仍然支持的API版本；
  • DEPRECATED：一个被废弃的API版本，该版本将被删除

updated

string

一个有特定值的字符串。API版本为2.0时，值为2011-01-21T11:33:21Z ，API版本是2.1时，值为2013-07-23T11:33:21Z。

version

string
  • 如果API的这个版本支持微版本，则支持最大的微版本。
  • 如果不支持微版本，这将是空字符串。
表4 links字段数据结构说明

参数

参数类型

描述

href

string

相应资源的链接。

rel

string
  • self：自助链接包含版本链接的资源。立即链接后使用这些链接。
  • bookmark：书签链接提供了一个永久资源的永久链接，该链接适合于长期存储。
  • alternate：备用链接可以包含资源的替换表示形式。例如，OpenStack计算映像可能在OpenStack映像服务中有一个替代表示。
表5 media-types字段数据结构说明

参数

参数类型

描述

base

string

基础类型。

type

string

媒体类型。

请求示例

查询指定API的版本信息。

GET https://{endpoint}/v2.1

响应示例

{
    "version":{
        "min_version":"2.1",
        "media-types":[
            {
                "type":"application/vnd.openstack.compute+json;version=2.1",
                "base":"application/json"
            }
        ],
        "links":[
            {
                "rel":"self",
                "href":"https://{endpoint}/v2.1/"
            },
            {
                "rel":"describedby",
                "href":"http://docs.openstack.org/",
                "type":"text/html"
            }
        ],
        "id":"v2.1",
        "updated":"2013-07-23T11:33:21Z",
        "version":"2.60",
        "status":"CURRENT"
    }
}

返回值

请参考通用请求返回值。

相关文档