5.1.1 查询 API 所有版本
功能介绍
查询云监控支持的API所有版本号。
URI
GET /
请求消息
请求样例
GET https://{云监控的终端节点}/
响应消息
● 响应参数
表5-1 要素说明
名称 参数类型 说明
versions Array of
objects 描述version相关对象的列表。
详细参数说明请参见表5-2。
表5-2 versions 字段数据结构说明
名称 参数类型 说明
id String 版本ID（版本号），如v1。
links Array of
objects API的URL地址。
详细参数说明请参见表5-3。
version String 若该版本API支持微版本，该参数表示支持的最大 微版本号，如果不支持微版本，则为空。
status String 版本状态，为如下3种：
CURRENT：表示该版本为主推版本。
SUPPORTED：表示为老版本，但是现在还继续支 持。
DEPRECATED：表示为废弃版本，存在后续删除 的可能。
updated String 版本发布时间，采用UTC时间表示。如v1发布的时 间2014-06-28T12:20:21Z。
min_versio
n String 若该版本API 支持微版本，该参数表示支持的最小 微版本号， 如果不支持微版本，则为空。
表5-3 links 字段数据结构说明
名称 参数类型 说明
href String 当前API版本的引用地址。
rel String 当前API版本和被引用地址的关系。
● 响应样例
{ "versions": [ {
"id": "V1.0", "links": [ {
"href": "https://x.x.x.x/V1.0/", "rel": "self"
} ],
"min_version": "", "status": "CURRENT",
"updated": "2018-09-30T00:00:00Z", "version": ""
} ]}
返回值
● 正常 200
● 异常
返回值 说明
400 Bad Request 请求错误。
401 Unauthorized 未提供认证信息，或认证信息错误。
403 Forbidden 请求页面被禁止访问。
408 Request Timeout 请求超出了服务器的等待时间。
429 Too Many
Requests 当前请求过多。
500 Internal Server
Error 请求未完成，服务异常。
503 Service
Unavailable 系统暂时不可用，请求受限。
错误码
请参考返回错误码说明。
5.1.2 查询 API 指定版本号
功能介绍
查询云监控API指定版本号。
URI
GET /{api_version}
● 参数说明
表5-4 参数说明
名称 是否必选 说明
api_version 是 API版本号。
● 样例
GET https://{云监控的终端节点}/V1.0
请求消息
无
响应消息
● 响应参数
表5-5 响应参数
名称 参数类型 说明
version Objects 描述version 相关对象。
详细参数说明请参见表5-6。
表5-6 versions 字段数据结构说明
名称 参数类型 说明
id String 版本ID（版本号），如v1。
links Array of
objects API的URL地址。
详细参数说明请参见表5-7。
version String 若该版本API支持微版本，该参数表示支持的最大 微版本号，如果不支持微版本，则为空。
status String 版本状态，为如下3种：
CURRENT：表示该版本为主推版本。
SUPPORTED：表示为老版本，但是现在还继续支 持。
DEPRECATED：表示为废弃版本，存在后续删除 的可能。
updated String 版本发布时间，采用UTC时间表示。如v1发布的 时间2014-06-28T12:20:21Z。
min_version String 若该版本API 支持微版本，该参数表示支持的最 小微版本号， 如果不支持微版本，则为空。
表5-7 links 字段数据结构说明
名称 参数类型 说明
href String 当前API版本的引用地址。
rel String 当前API版本和被引用地址的关系。
● 响应样例
{ "version": { "id": "V1.0", "links": [ {
"href": "https://x.x.x.x/V1.0/", "rel": "self"
} ],
"min_version": "", "status": "CURRENT",
"updated": "2018-09-30T00:00:00Z",
"version": ""
} }
返回值
● 正常 200
● 异常
返回值 说明
400 Bad Request 请求错误。
401 Unauthorized 未提供认证信息，或认证信息错误。
403 Forbidden 请求页面被禁止访问。
408 Request Timeout 请求超出了服务器的等待时间。
429 Too Many
Requests 当前请求过多。
500 Internal Server
Error 请求未完成，服务异常。
503 Service
Unavailable 系统暂时不可用，请求受限。
错误码
请参考返回错误码说明。