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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
GroupId String 1084f9034c744137901057206b39d2b6

指定的分组编号

Action String DescribeApiHistories

操作接口名,系统规定参数,取值:DescribeApiHistories

ApiId String c076144d7878437b8f82fb85890ce6a0

指定的API编号

ApiName String weather

API名称(模糊匹配)

PageNumber String 1

指定要查询的页码,默认是1,起始是1

PageSize String 10

指定分页查询时每页行数,最大值100,默认值为10

StageName String RELEASE

环境名称,可选值:

  • RELEASE:线上
  • TEST:测试

返回数据

名称 类型 示例值 描述
ApiHisItems Array

由 ApiHisItem 组成的数组格式,返回API的信息

ApiHisItem

由 ApiHisItem 组成的数组格式,返回API的信息

ApiId String 5af418828f0344a3b588c0cc1331a3bc

API编号

ApiName String 创建对象

API名称

DeployedTime String 2016-07-20T08:28:48Z

发布时间(格林威治时间)

Description String 创建对象接口

API描述

GroupId String 1084f9034c744137901057206b39d2b6

API分组编号

GroupName String myGroup2

API分组名称

HistoryVersion String 20160705104552393

API定义的历史版本

RegionId String cn-qingdao

所在的region

StageName String RELEASE

环境名称,可选值:

  • RELEASE: 线上
  • TEST: 测试
Status String ONLINE

对应版本的API是否生效,取值为:ONLINEOFFLINE,分别表示有效、无效。

PageNumber Integer 3

返回指定的页码

PageSize Integer 15

返回指定的每页条数

RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BZ003

请求ID

TotalCount Integer 32

返回结果的总条数

示例

请求示例


http(s)://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApiHistories
&GroupId=1084f9034c744137901057206b39d2b6
&<公共请求参数>

正常返回示例

XML 格式

<DescribeApiHistoriesResponse>
      <ApiHisItems>
            <ApiHisItem>
                  <RegionId>cn-qingdao</RegionId>
                  <GroupId>63be9002440b4778a61122f14c2b2bbb</GroupId>
                  <GroupName>myGroup3</GroupName>
                  <ApiId>c076144d7878437b8f82fb85890ce6a0</ApiId>
                  <ApiName>获取对象列表</ApiName>
                  <StageName>release</StageName>
                  <HistoryVersion>20160705104552292</HistoryVersion>
                  <Status>DISABLE</Status>
                  <Description>分页显示对象列表</Description>
                  <DeployedTime>2016-07-23T08:28:48Z</DeployedTime>
            </ApiHisItem>
            <ApiHisItem>
                  <RegionId>cn-qingdao</RegionId>
                  <GroupId>1084f9034c744137901057206b39d2b6</GroupId>
                  <GroupName>myGroup2</GroupName>
                  <ApiId>5af418828f0344a3b588c0cc1331a3bc</ApiId>
                  <ApiName>创建对象</ApiName>
                  <StageName>release</StageName>
                  <HistoryVersion>20160705104552393</HistoryVersion>
                  <Status>DISABLE</Status>
                  <Description>创建对象接口</Description>
                  <DeployedTime>2016-07-20T08:28:48Z</DeployedTime>
            </ApiHisItem>
      </ApiHisItems>
      <PageNumber>3</PageNumber>
      <PageSize>15</PageSize>
      <TotalCount>32</TotalCount>
      <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ003</RequestId>        
</DescribeApiHistoriesResponse>

JSON 格式

{
	"ApiHisItems":{
		"ApiHisItem":[
			{
				"Status":"DISABLE",
				"StageName":"release",
				"Description":"分页显示对象列表",
				"HistoryVersion":"20160705104552292",
				"ApiName":"获取对象列表",
				"GroupName":"myGroup3",
				"DeployedTime":"2016-07-23T08:28:48Z",
				"RegionId":"cn-qingdao",
				"GroupId":"63be9002440b4778a61122f14c2b2bbb",
				"ApiId":"c076144d7878437b8f82fb85890ce6a0"
			},
			{
				"Status":"DISABLE",
				"StageName":"release",
				"Description":"创建对象接口",
				"HistoryVersion":"20160705104552393",
				"ApiName":"创建对象",
				"GroupName":"myGroup2",
				"DeployedTime":"2016-07-20T08:28:48Z",
				"RegionId":"cn-qingdao",
				"GroupId":"1084f9034c744137901057206b39d2b6",
				"ApiId":"5af418828f0344a3b588c0cc1331a3bc"
			}
		]
	},
	"PageNumber":3,
	"TotalCount":32,
	"PageSize":15,
	"RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ003"
}

错误码

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