调用DescribeApiHistories查询API历史发布的版本列表_API 网关(API Gateway)-阿里云帮助中心

查询指定API历次历史发布的版本列表。

接口说明

此功能面向开放 API 的用户，有过发布的 API 才有历史版本记录
调用该接口能获取 API 历史版本号数据，用于其他接口的调用

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribeApiHistories	get	ApiGroup acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}	无	无

请求参数

名称	类型	必填	描述	示例值
GroupId	string	是	指定的分组编号	1084f9034c744137901057206b39d2b6
StageName	string	否	环境名称，可选值： RELEASE：线上 TEST：测试	RELEASE
ApiId	string	否	指定的 API 编号	c076144d7878437b8f82fb85890ce6a0
ApiName	string	否	API 名称（模糊匹配）	weather
PageSize	string	否	指定分页查询时每页行数，最大值 100，默认值为 10	10
PageNumber	string	否	指定要查询的页码，默认是 1，起始是 1	1

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	返回指定的页码	3
RequestId	string	请求 ID	CEF72CEB-54B6-4AE8-B225-F876FF7BZ003
PageSize	integer	返回指定的每页条数	15
TotalCount	integer	返回结果的总条数	32
ApiHisItems	array<object>	由 ApiHisItem 组成的数组格式，返回 API 的信息
ApiHisItem	object
Status	string	对应版本的 API 是否生效，取值为：ONLINE、OFFLINE，分别表示有效、无效。	ONLINE
ApiId	string	API 编号	5af418828f0344a3b588c0cc1331a3bc
Description	string	API 描述	创建对象接口
GroupName	string	API 分组名称	myGroup2
GroupId	string	API 分组编号	1084f9034c744137901057206b39d2b6
DeployedTime	string	发布时间(格林威治时间)	2016-07-20T08:28:48Z
StageName	string	环境名称，可选值： RELEASE: 线上 TEST: 测试	RELEASE
HistoryVersion	string	API 定义的历史版本	20160705104552393
ApiName	string	API 名称	创建对象
RegionId	string	所在的 region	cn-qingdao

示例

正常返回示例

JSON格式

{
  "PageNumber": 3,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ003",
  "PageSize": 15,
  "TotalCount": 32,
  "ApiHisItems": {
    "ApiHisItem": [
      {
        "Status": "ONLINE",
        "ApiId": "5af418828f0344a3b588c0cc1331a3bc",
        "Description": "创建对象接口",
        "GroupName": "myGroup2",
        "GroupId": "1084f9034c744137901057206b39d2b6",
        "DeployedTime": "2016-07-20T08:28:48Z",
        "StageName": "RELEASE",
        "HistoryVersion": "20160705104552393",
        "ApiName": "创建对象",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

JSON格式

{
  "PageNumber": 3,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ003",
  "PageSize": 15,
  "TotalCount": 32,
  "ApiHisItems": {
    "ApiHisItem": [
      {
        "Status": "ONLINE",
        "ApiId": "5af418828f0344a3b588c0cc1331a3bc",
        "Description": "创建对象接口",
        "GroupName": "myGroup2",
        "GroupId": "1084f9034c744137901057206b39d2b6",
        "DeployedTime": "2016-07-20T08:28:48Z",
        "StageName": "RELEASE",
        "HistoryVersion": "20160705104552393",
        "ApiName": "创建对象",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史