更新时间:2024-03-21 GMT+08:00

查询API版本的详细信息

功能介绍

查询API版本的详细信息。

URI

  • GET /{api_version}/
  • 参数说明

    参数

    是否必选

    参数类型

    描述

    api_version

    String

    API版本号。值为v1或v2。

请求消息头

该操作消息头与普通请求一样,请参见表3

请求消息

  • 参数说明

  • 请求样例

    GET https://{endpoint}/v2/

响应消息

  • 参数说明

    参数

    参数类型

    描述

    versions

    Object

    所有可用的API版本列表对象。

    • version字段说明:

      参数

      参数类型

      描述

      id

      String

      所使用版本的公用名称。

      updated

      String

      接口最后修改的UTC时间,格式为YYYY-MM-DDTHH:MM:SSZ

      status

      String

      API 版本的状态。其值为:

      • CURRENT:当前API使用的首选版本。
      • SUPPORTED:表示该版本为老版本,但当前还在继续支持。
      • DEPRECATED:表示该版本为废弃版本,存在后续删除的可能。

      links

      Array of objects

      共享链接。参见links字段说明。

      media-types

      Array of objects

      API支持的媒介类型,参见media-types字段说明

      version

      String

      如果当前版本的API支持microversions,此处为支持的microversion的最大版本。如果不支持microversions,这将会是空字符串。

      min_version

      String

      如果当前版本的API支持microversions, 此处为支持的microversion的最小版本。如果不支持microversions, 这将会是空字符串。

    • links字段说明:

      参数

      参数类型

      描述

      href

      String

      API接口访问路径,作为参考。

      type

      String

      参考接口返回的信息文本类型。

      rel

      String

      链接附加描述。

    • media-types字段说明:

      参数

      参数类型

      描述

      base

      String

      文本基础类型。

      type

      String

      文本类型。

  • 响应样例
    {
      "versions": [
        {
          "status": "CURRENT",
          "updated": "2015-08-27T11:33:21Z",
          "links": [
            {
              "href": "http://docs.openstack.org/",
              "type": "text/html",
              "rel": "describedby"
            },
            {
              "href": "https://sfs.region.www.t-systems.com/v2/",
              "rel": "self"
            }
          ],
          "min_version": "2.0",
          "version": "2.28",
          "media-types": [
            {
              "base": "application/json",
              "type": "application/vnd.openstack.share+json;version=1"
            }
          ],
          "id": "v2.0"
        }
      ]
    }

状态码

  • 正常

    200

  • 异常

    状态码

    说明

    400 Bad Request

    服务器未能处理请求。

    400 Bad Request

    无效输入:缩容后的大小必须大于0并小于当前大小(当前:XX,新大小:XX)

    400 Bad Request

    无效输入:扩容后的大小必须大于当前大小(当前:XX,新大小:XX)

    401 Unauthorized

    被请求的页面需要用户名和密码。

    403 Forbidden

    对被请求页面的访问被禁止。

    404 Not Found

    服务器无法找到被请求的页面。

    405 Method Not Allowed

    请求中指定的方法不被允许。

    406 Not Acceptable

    服务器生成的响应无法被客户端所接受。

    407 Proxy Authentication Required

    用户必须首先使用代理服务器进行验证,这样请求才会被处理。

    408 Request Timeout

    请求超出了服务器的等待时间。

    409 Conflict

    由于冲突,请求无法被完成。

    500 Internal Server Error

    请求未完成。服务异常。

    501 Not Implemented

    请求未完成。服务器不支持所请求的功能。

    502 Bad Gateway

    请求未完成。服务器从上游服务器收到一个无效的响应。

    503 Service Unavailable

    请求未完成。系统暂时异常。

    504 Gateway Timeout

    网关超时。