更新时间:2024-04-16 GMT+08:00

查询指定API版本信息

功能介绍

返回专属主机指定版本的信息。

URI

GET /{api_version}

参数说明请参见表1

表1 参数说明

参数

是否必选

描述

api_version

API版本号。例如:v1.0

请求消息

响应消息

表2 响应参数

参数

参数类型

描述

version

Object

专属主机指定API版本信息。

表3 version字段数据结构说明

参数

参数类型

描述

id

String

API版本ID。

links

Array of objects

API的url地址。

min_version

String

若该版本API支持微版本,则为支持的最小微版本号;如果不支持微版本,则为空。

status

String

API版本状态:

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

updated

String

API版本更新时间。

version

String

若该版本API支持微版本,则为支持的最大微版本号;如果不支持微版本,则为空。

表4 links字段数据结构说明

参数

参数类型

描述

href

String

API的url地址。

rel

String

API的url地址依赖。

请求示例

查询专属主机API版本v1.0的信息。

GET /v1.0

响应示例

{
    "version": {
        "id": "v1.0",
        "links": [
            {
                "href": "https//deh.xxx.com/v1.0/",
                "rel": "self"
            }
        ],
        "min_version": "",
        "status": "SUPPORTED",
        "updated": "2016-12-01T11:33:21Z",
        "version": ""
    }
}

返回值

请参见状态码