文档首页/ 消息通知服务 SMN/ API参考/ API/ 查询版本操作/ 查询SMN支持的API版本号信息
更新时间：2024-09-06 GMT+08:00
在线调试
CLI示例
查看PDF
分享

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

功能介绍

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

调用方法

请参见如何调用API。

URI

GET /

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

versions

Array of VersionItem objects

描述version相关对象的列表。
表3 VersionItem

参数

参数类型

描述

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

Array of LinksItem objects

API的URL地址。
表4 LinksItem

参数

参数类型

描述

href

String

对应快捷链接。

rel

String

快捷链接标记名称。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码： 403

表6 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码： 404

表7 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

请求示例

GET https://{SMN_Endpoint}/

null

响应示例

状态码： 200

OK

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

状态码

状态码

描述

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 查询版本操作

相关文档