调用DescribeHistoryApis查询API发布版本定义列表_API 网关(API Gateway)-阿里云帮助中心

查询API历史发布版本列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
GroupId	string	是	分组编号	0ccb66aadb5345b78a40f57d192d8aa4
StageName	string	否	环境名称，可选值： RELEASE：线上 TEST：测试	RELEASE
ApiId	string	否	指定要查询的 Api 编号	a12068f555964ca8a0c9c33288f1e5a7
ApiName	string	否	API 名称（模糊匹配）	getPersonInfo
PageSize	string	否	分页参数：每页显示条数。	10
PageNumber	string	否	分页参数：当前页码。	2

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	返回指定的页码	1
RequestId	string	请求 ID。	6C87A26A-6A18-4B8E-8099-705278381A2C
PageSize	integer	指定分页查询时每页行数，最大值 50，默认值为 10	10
TotalCount	integer	返回结果的总条数	20
ApiHisItems	array<object>	由 ApiHisItem 组成的数组格式，返回 API 的信息
ApiHisItem	object
Status	string	对应版本的 API 是否生效，取值为：ONLINE、OFFLINE，分别表示有效、无效。	ONLINE
ApiId	string	API 的 ID。	5af418828f0344a3b588c0cc1331a3bc
Description	string	API 描述	创建对象接口
GroupName	string	API 分组名称	myGroup2
GroupId	string	API 分组 ID	1084f9034c744137901057206b39d2b6
DeployedTime	string	发布时间(格林威治时间)	2016-07-20T08:28:48Z
StageName	string	环境名称，可选值： RELEASE: 线上 TEST: 测试	RELEASE
StageAlias	string	环境别名	线上
HistoryVersion	string	API 定义的历史版本	20210915101416294
ApiName	string	API 名称	v2_role_assign
RegionId	string	地域 ID	cn-qingdao

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "6C87A26A-6A18-4B8E-8099-705278381A2C",
  "PageSize": 10,
  "TotalCount": 20,
  "ApiHisItems": {
    "ApiHisItem": [
      {
        "Status": "ONLINE",
        "ApiId": "5af418828f0344a3b588c0cc1331a3bc",
        "Description": "创建对象接口",
        "GroupName": "myGroup2",
        "GroupId": "1084f9034c744137901057206b39d2b6",
        "DeployedTime": "2016-07-20T08:28:48Z",
        "StageName": "RELEASE",
        "StageAlias": "线上",
        "HistoryVersion": "20210915101416294",
        "ApiName": "v2_role_assign",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-11-14	OpenAPI 描述信息更新	查看变更详情
2024-03-21	OpenAPI 返回结构发生变更	查看变更详情