全部产品
云市场

查询 API 历史版本列表

更新时间:2018-08-09 18:04:55

描述

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

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

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:DescribeApiHistories
GroupId String 指定的分组编号
ApiId String 指定的API编号
ApiName String API名称(模糊匹配)
StageName String 环境名称,可选值:
  • RELEASE:线上
  • TEST:测试
PageSize Integer 指定分页查询时每页行数,最大值100,默认值为10
PageNumber Integer 指定要查询的页码,默认是1,起始是1

返回参数

名称 类型 描述
RequestId String 本次请求编号
TotalCount Integer 返回结果的总条数
PageNumber Integer 返回指定的页码
PageSize Integer 返回指定的每页条数
ApiHisItems ApiHisItem 由 ApiHisItem 组成的数组格式,返回API的信息

示例

请求示例

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApiHistories
  2. &ApiName=weather
  3. &pageSize=15
  4. &pageNumber=3
  5. &<公共请求参数>

返回示例

XML格式

  1. <DescribeApiHistoriesResponse>
  2. <ApiHisItems>
  3. <ApiHisItem>
  4. <RegionId>cn-qingdao</RegionId>
  5. <GroupId>63be9002440b4778a61122f14c2b2bbb</GroupId>
  6. <GroupName>myGroup3</GroupName>
  7. <ApiId>c076144d7878437b8f82fb85890ce6a0</ApiId>
  8. <ApiName>获取对象列表</ApiName>
  9. <StageName>release</StageName>
  10. <HistoryVersion>20160705104552292</HistoryVersion>
  11. <Status>DISABLE</Status>
  12. <Description>分页显示对象列表</Description>
  13. <DeployedTime>2016-07-23T08:28:48Z</DeployedTime>
  14. </ApiHisItem>
  15. <ApiHisItem>
  16. <RegionId>cn-qingdao</RegionId>
  17. <GroupId>1084f9034c744137901057206b39d2b6</GroupId>
  18. <GroupName>myGroup2</GroupName>
  19. <ApiId>5af418828f0344a3b588c0cc1331a3bc</ApiId>
  20. <ApiName>创建对象</ApiName>
  21. <StageName>release</StageName>
  22. <HistoryVersion>20160705104552393</HistoryVersion>
  23. <Status>DISABLE</Status>
  24. <Description>创建对象接口</Description>
  25. <DeployedTime>2016-07-20T08:28:48Z</DeployedTime>
  26. </ApiHisItem>
  27. </ApiHisItems>
  28. <PageNumber>3</PageNumber>
  29. <PageSize>15</PageSize>
  30. <TotalCount>32</TotalCount>
  31. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ003</RequestId>
  32. </DescribeApiHistoriesResponse>

JSON格式

  1. {
  2. "ApiHisItems": {
  3. "ApiHisItem": [
  4. {
  5. "RegionId": "cn-qingdao",
  6. "GroupId": "63be9002440b4778a61122f14c2b2bbb",
  7. "GroupName": "myGroup3",
  8. "ApiId": "c076144d7878437b8f82fb85890ce6a0",
  9. "ApiName": "获取对象列表",
  10. "StageName": "release",
  11. "HistoryVersion": "20160705104552292",
  12. "Status": "DISABLE",
  13. "Description": "分页显示对象列表",
  14. "DeployedTime": "2016-07-23T08:28:48Z"
  15. },
  16. {
  17. "RegionId": "cn-qingdao",
  18. "GroupId": "1084f9034c744137901057206b39d2b6",
  19. "GroupName": "myGroup2",
  20. "ApiId": "5af418828f0344a3b588c0cc1331a3bc",
  21. "ApiName": "创建对象",
  22. "StageName": "release",
  23. "HistoryVersion": "20160705104552393",
  24. "Status": "DISABLE",
  25. "Description": "创建对象接口",
  26. "DeployedTime": "2016-07-20T08:28:48Z"
  27. }
  28. ]
  29. },
  30. "PageNumber": 3,
  31. "PageSize": 15,
  32. "TotalCount": 32,
  33. "RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ003"
  34. }