更新时间:2022-12-08 GMT+08:00

查询API版本号详情

功能介绍

查询指定的企业项目API版本号详情。

URI

GET /{api_version}

请求消息

  • 要素说明
    表1 请求样例要素说明

    名称

    是否必选

    参数类型

    说明

    api_version

    String

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

  • 请求样例
    GET https://{EPS的Endpoint}/v1.0

响应消息

  • 要素说明
    表2 响应样例要素说明

    名称

    参数类型

    说明

    version

    Object

    描述version相关对象。

    详细参数请参见表3

  • versions字段数据结构说明
    表3 versions字段数据结构说明

    名称

    参数类型

    说明

    id

    String

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

    links

    List<Link>

    API的URL地址。

    详细参数请参见表4

    version

    String

    如果该版本API支持微版本,则返回支持的最大微版本号,如果不支持微版本,则返回空。

    status

    String

    版本状态,为如下3种:

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

    updated

    String

    版本发布时间,采用UTC时间表示。如v1.0发布的时间2016-12-09T00:00:00Z。

    min_version

    String

    如果该版本API 支持微版本,则返回支持的最小微版本号, 如果不支持微版本,则返回空。

  • Link字段数据结构说明
    表4 Link字段数据结构说明

    名称

    参数类型

    说明

    href

    String

    API的URL地址。

    rel

    String

    self。

  • 响应样例
    {
        "version": {
            "id": "v1.0",
            "links": [
                {
                    "rel": "self",
                    "href": "https://API的URL地址/v1.0"
                }
            ],
            "version": "",
            "status": "CURRENT",
            "updated": "2016-12-09T00:00:00Z",
            "min_version": ""
        }
    }

状态码

请参考状态码

错误码

请参考错误码