文档首页/API网关 APIG/API参考/共享版API（仅存量用户使用）/API管理/查询API历史版本列表
更新时间：2022-09-01 GMT+08:00
查看PDF
分享

查询API历史版本列表

功能介绍

查询某个API的历史版本。每个API在一个环境上最多存在10个历史版本。

URI

HTTP/HTTPS请求方法以及URI如下表所示。

表1 HTTP/HTTPS请求方法以及URI

请求方法

URI

GET

/v1.0/apigw/apis/publish/{api_id}[?env_id,env_name]

  • 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
  • 查询条件可为以下字段以及对应的值：env_id，env_name。

URI中的参数说明如下表所示。

表2 参数说明

名称

是否必选

类型

说明

api_id

是

String

API的编号

env_id

否

String

环境的编号

env_name

否

String

环境的名称

请求消息

无

响应消息

表3 参数说明

名称

类型

说明

total

Integer

满足条件的API历史版本总数

size

Integer

本次查询返回的列表长度

api_versions

字典数据类型

本次查询返回的API历史版本列表

表4 api_versions参数说明

参数

类型

说明

version_id

String

API历史版本的ID

version_no

String

API的版本号

api_id

String

API编号

env_id

String

发布的环境编号

env_name

String

发布的环境名称

remark

String

发布描述

publish_time

Timestamp

发布时间

status

Integer

版本状态：

  • 1、当前生效中的版本
  • 2、未生效的版本

响应消息样例：

{
  "total": 1,
  "size": 1,
  "api_versions": [
    {
      "version_id": "04c194dc7b5340ed942f2451702060da",
      "version_no": "20180722102526",
      "api_id": "acf141aa6279415088b593a4bbb55eed",
      "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
      "env_name": "RELEASE",
      "publish_time": "2018-04-14T07:32:23Z",
      "status": 2
    }
  ]
}

状态码

表5 返回消息说明

状态码

说明

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error

父主题：API管理