查询指定API版本信息

功能介绍

查询存储容灾指定API版本信息。

约束与限制

无

URI

• URI格式

  GET /{api_version}

• 参数说明

  参数名	是否必选	说明
  api_version	是	API版本号。例如：v1。

请求消息

• 请求参数

  无

• 请求样例

  GET https://{endpoint}/v1

响应

• 要素说明

  参数名称	参数类型	说明
  version	Object	API版本信息。 详情请参见表1。

  表1 version字段说明

  参数名称	参数类型	说明
  id	String	版本ID（版本号），如v1。
  links	Array of objects	API的URL地址。 详情请参见表2。
  version	String	若该版本API支持微版本，则返回支持的最大微版本号，如果不支持微版本，则返回空。
  status	String	版本状态，为如下3种： CURRENT：表示该版本为主推版本 SUPPORTED：表示为老版本，但是现在还继续支持 DEPRECATED：表示为废弃版本，存在后续删除的可能
  updated	String	版本发布时间，采用UTC时间表示。如v1发布的时间2018-05-30T15:00:00Z。
  min_version	String	若该版本API支持微版本，则返回支持的最小微版本号，如果不支持微版本，则返回空。

  表2 links参数信息

  参数名	参数类型	说明
  rel	String	链接的描述
  href	String	版本号查询链接

• 响应样例

  {
      "version": {
          "id": "v1",
          "links": [
              {
                  "href": "https://sdrs.localdomain.com/v1",
                  "rel": "self"
              }
          ],
          "status": "CURRENT",
          "updated": "2018-05-30T00:00:00Z",
          "version": "",
          "min_version": ""
      }
  }

  或

  {  
        "error": {  
            "message": "XXXX",   
            "code": "XXX"  
        }  
    }

  其中error是泛指的错误，有badrequest、itemNotFound等，如报错为：

  {  
        "badrequest": {  
            "message": "XXXX",   
            "code": "XXX"  
        }  
    }

返回值

• 正常

  返回值	说明
  200	服务器已接受请求。

• 异常

  返回值	说明
  400 Bad Request	服务器未能处理请求。
  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	网关超时。