全部产品
云市场

查询定义中的 API 列表

更新时间:2018-09-12 20:23:08

描述

查询定义中的API列表。

  • 此功能面向开放API的用户
  • 接口返回所有定义中的API列表,以及概况信息
  • 请注意是返回所有编辑中的API定义信息,跟环境无关,也可能跟环境中正在运行的定义不同,是最新的编辑结果

请求参数

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

返回参数

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

示例

请求示例

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

返回示例

XML格式

  1. <DescribeApisResponse>
  2. <ApiSummarys>
  3. <ApiSummary>
  4. <RegionId>cn-qingdao</RegionId>
  5. <GroupId>63be9002440b4778a61122f14c2b2bbb</GroupId>
  6. <GroupName>myGroup3</GroupName>
  7. <ApiId>c076144d7878437b8f82fb85890ce6a0</ApiId>
  8. <ApiName>获取对象列表</ApiName>
  9. <Visibility>public</Visibility>
  10. <Description>分页显示对象列表</Description>
  11. <CreatedTime>2016-06-20T18:18:25Z</CreatedTime>
  12. <ModifiedTime>2016-07-23T08:28:48Z</ModifiedTime>
  13. </ApiSummary>
  14. <ApiSummary>
  15. <RegionId>cn-qingdao</RegionId>
  16. <GroupId>1084f9034c744137901057206b39d2b6</GroupId>
  17. <GroupName>myGroup2</GroupName>
  18. <ApiId>5af418828f0344a3b588c0cc1331a3bc</ApiId>
  19. <ApiName>创建对象</ApiName>
  20. <Visibility>public</Visibility>
  21. <Description>创建对象接口</Description>
  22. <CreatedTime>2016-05-20T18:18:25Z</CreatedTime>
  23. <ModifiedTime>2016-07-23T08:28:48Z</ModifiedTime>
  24. </ApiSummary>
  25. </ApiSummarys>
  26. <PageNumber>3</PageNumber>
  27. <PageSize>15</PageSize>
  28. <TotalCount>32</TotalCount>
  29. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ002</RequestId>
  30. </DescribeApisResponse>

JSON格式

  1. {
  2. "ApiSummarys": {
  3. "ApiSummary": [
  4. {
  5. "RegionId": "cn-qingdao",
  6. "GroupId": "63be9002440b4778a61122f14c2b2bbb",
  7. "GroupName": "myGroup3",
  8. "ApiId": "c076144d7878437b8f82fb85890ce6a0",
  9. "ApiName": "获取对象列表",
  10. "Visibility": "public",
  11. "Description": "分页显示对象列表",
  12. "CreatedTime": "2016-06-20T18:18:25Z",
  13. "ModifiedTime": "2016-07-23T08:28:48Z"
  14. },
  15. {
  16. "RegionId": "cn-qingdao",
  17. "GroupId": "1084f9034c744137901057206b39d2b6",
  18. "GroupName": "myGroup2",
  19. "ApiId": "5af418828f0344a3b588c0cc1331a3bc",
  20. "ApiName": "创建对象",
  21. "Visibility": "public",
  22. "Description": "创建对象接口",
  23. "CreatedTime": "2016-05-20T18:18:25Z",
  24. "ModifiedTime": "2016-07-23T08:28:48Z"
  25. }
  26. ]
  27. },
  28. "PageNumber": "3",
  29. "PageSize": "15",
  30. "TotalCount": "32",
  31. "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ002"
  32. }