更新时间:2025-01-07 GMT+08:00

查询SMN支持的API版本号信息

功能介绍

  • 接口名称

    QueryApiSupportVersions

  • 功能描述

    查询SMN开放API支持的版本号。

URI

  • URI格式

    GET /

请求消息

  • 请求样例
    GET https://{SMN_Endpoint}/

响应消息

  • 要素说明

    名称

    参数类型

    说明

    versions

    Versions结构体数组

    描述version相关对象的列表,结构体说明请参见表1

    表1 Versions结构体

    名称

    参数类型

    说明

    id

    String

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

    min_version

    String

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

    status

    String

    版本状态,为如下3种:

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

    updated

    String

    版本发布时间,要求用UTC时间格式表示。如v2发布的时间2014-06-28T12:20:21Z。

    version

    String

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

    links

    Links结构体数组

    API的URL地址,结构体说明请参见表2

    表2 Links结构体

    名称

    参数类型

    说明

    href

    String

    对应快捷链接。

    rel

    String

    快捷链接标记名称。

  • 响应样例
    {
        "versions": [
            {
                "id": "v2",
                "links": [
                    {
                        "href": "https://127.0.0.1/v2",
                        "rel": "self"
                    }
                ],
                "min_version": "",
                "status": "CURRENT",
                "updated": "2018-09-19T00:00:00Z",
                "version": ""
            }
       ]
    }

返回值

请参考返回值

错误码

请参考错误码