更新时间:2023-08-04 GMT+08:00

获取接口版本号详情

功能介绍

查询本服务的接口目标版本号详情。

URI

GET /{api_version}

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

名称

是否必选

参数类型

说明

api_version

String

目标版本号。

获取版本号请参考获取接口版本号列表

请求消息

  • 请求参数

  • 请求样例

    本示例展示了查询v1版本API的版本信息。

    GET https://{endpoint}/v1

响应消息

响应参数

响应参数如表2所示。
表2 响应参数

参数名称

类型

说明

version

Object

描述version 相关对象的列表。

id

String

版本ID(版本号),如v1。

links

Array

API的URL地址,详细信息请参考表3

version

String

该版本API支持的最大微版本。

status

String

版本状态,为如下3种:

CURRENT:表示该版本为当前推荐使用的版本。

SUPPORTED:表示为老版本,目前还在继续维护。

DEPRECATED:表示为废弃版本,已不再维护,存在后续删除的可能。

updated

String

版本发布时间。

时间格式:UTC YYYY-MM-DDTHH:MM:SS

min_version

String

该版本API 支持的最小微版本。

links参数信息

links参数信息说明如表3所示。
表3 参数说明

参数名

参数类型

说明

rel

String

链接的描述。

href

String

版本号查询链接。

  • 响应样例
    {
        "version": {
                "min_version": "", 
                 "links": [
                    {
                        "rel": "self", 
                        "href": "https://dss.localdomain.com/v1"
                    }
                ], 
                "id": "v1", 
                "updated": "2014-06-28T12:20:21Z", 
                "version": "", 
                "status": "CURRENT"
            }
    }

返回值

错误码

请参考错误码