文档首页/业务恢复服务 BRS/API参考/API/API版本信息/查询API版本信息 - ListApiVersions

更新时间：2025-11-26 GMT+08:00

查询API版本信息 - ListApiVersions

功能介绍

查询业务恢复服务当前所有可用的版本信息列表。

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /

请求参数

无

响应参数

状态码： 200

表1 响应Body参数
参数	参数类型	描述
versions	Array of ShowApiVersionParams objects	API版本信息列表。

表2 ShowApiVersionParams
参数	参数类型	描述
id	String	版本ID（版本号），如v1。
links	Array of ShowApiVersionLinksParams objects	版本号查询链接
version	String	若该版本API支持微版本，则返回支持的最大微版本号，如果不支持微版本，则返回空。
status	String	版本状态，为如下3种： CURRENT：表示该版本为主推版本 SUPPORTED：表示为老版本，但是现在还继续支持 DEPRECATED：表示为废弃版本，存在后续删除的可能枚举值： CURRENT SUPPORTED DEPRECATED
updated	String	版本发布时间，采用UTC时间表示。如v1发布的时间2018-05-30T15:00:00Z。
min_version	String	若该版本API 支持微版本，则返回支持的最小微版本号，如果不支持微版本，则返回空。

表3 ShowApiVersionLinksParams
参数	参数类型	描述
rel	String	链接的描述
href	String	版本号查询链接

状态码： 400

表4 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

表5 ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 403

表6 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

表7 ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 404

表8 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

表9 ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 405

**表10** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表11** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 406

**表12** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表13** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 407

**表14** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表15** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 408

**表16** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表17** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 409

**表18** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表19** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 500

**表20** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表21** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 501

**表22** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表23** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 502

**表24** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表25** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 503

**表26** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表27** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

状态码： 504

**表28** 响应Body参数
参数	参数类型	描述
error	ErrorInfo object	失败返回结构

**表29** ErrorInfo
参数	参数类型	描述
message	String	错误信息
code	String	错误码

请求示例

GET https://{endpoint}/

响应示例

状态码： 200

{
  "versions" : [ {
    "id" : "v1",
    "links" : [ {
      "href" : "https://sdrs.localdomain.com/v1",
      "rel" : "self"
    } ],
    "status" : "CURRENT",
    "updated" : "2018-05-30T15:00:00Z",
    "version" : "",
    "min_version" : ""
  } ]
}

状态码

状态码	描述
200	OK
400	Bad Request
403	Forbidden
404	Not Found
405	Method Not Allowed
406	Not Acceptable
407	Proxy Authentication Required
408	Request Timeout
409	Conflict
500	Internal Server Error
501	Not Implemented
502	Bad Gateway
503	Service Unavailable
504	Gateway Timeout