更新时间:2024-01-31 GMT+08:00

查询指定API版本信息

功能介绍

查询裸金属服务器指定API版本的信息。

URI

GET /{api_version}

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

参数

是否必选

描述

api_version

API版本号。例如:v1

请求参数

请求示例

查询v1版本的API信息。
1
GET https://{BMS Endpoint}/v1

响应参数

参数

参数类型

描述

version

Object

描述裸金属服务器API指定版本信息。详情请参见表2

表2 version字段数据结构说明

参数

参数类型

描述

id

String

API版本ID。

links

Array of objects

API的url地址。详情请参见表3

min_version

String

API支持的最小微版本号。

status

String

API版本状态:

  • CURRENT:表示该版本为主推版本。
  • SUPPORTED:表示为老版本,但是现在还在继续支持。
  • DEPRECATED:表示为废弃版本,存在后续删除的可能。

updated

String

API版本发布时间。

时间戳格式为ISO 8601:YYYY-MM-DDTHH:MM:SSZ,例如:2018-09-30T00:00:00Z

version

String

API支持的最大微版本号。

表3 links字段数据结构说明

参数

参数类型

描述

href

String

API的url地址。

rel

String

API的url地址依赖。取值为:

  • self:包含版本号的资源链接,需要立即跟踪时使用此类链接。
  • bookmark:提供了适合长期存储的资源链接。

响应示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
    "version": {
        "id": "v1",
        "links": [
            {
                "href": "http://bms.xxx.com/v1/",
                "rel": "self"
            }
        ],
        "min_version": "",
        "status": "CURRENT",
        "updated": "2018-09-30T00:00:00Z",
        "version": ""
    }
}

返回值

正常返回值:

返回值

说明

200

服务器已成功处理了请求。

其他返回值请参考状态码

错误码

请参考错误码