edit-icon download-icon

Query the API list in definition

Last Updated: May 17, 2017

Description

For querying the API list in definition.

  • This function is intended for API activators.
  • The interface returns the list of all APIs in definition along with the brief introduction.
  • Note that the definitions of APIs being edited in whatever stage are returned. The definitions may be different from those running in the stage, and are the latest results after editing.

Request parameters

Name Type Required? Description
Action String Yes Operation interface, which is a required parameter; value: DescribeApis.
GroupId String No ID of the specified group.
ApiId String No ID of the specified API.
ApiName String No API name (fuzzy matching).
CatalogId String No Catalog number.
PageSize Integer No Number of lines per page set at paging query; maximum value: 100; default value: 10.
PageNumber Integer No The page number specified for query; default value: 1; the starting number: 1.

Return parameters

Name Type Description
RequestId String ID of the current request.
TotalCount Integer Total number of returned results.
PageNumber Integer Page number specified to be returned.
PageSize Integer Specified total number of results returned per page.
ApiSummarys ApiSummary Returned API definition, in an array consisting of ApiSummary.

Examples

Request example

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApis
  2. &ApiName=weather
  3. &pageSize=15
  4. &pageNumber=3
  5. &<Public request parameters>

Response example

XML format

  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> Obtain the object list</ApiName>
  9. <Visibility>public</Visibility>
  10. <Description> Display the object list on multiple pages</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> Create object</ApiName>
  20. <Visibility>public</Visibility>
  21. <Description> Create object interface</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 format

  1. {
  2. "ApiSummarys": {
  3. "ApiSummary": [
  4. {
  5. "RegionId": "cn-qingdao",
  6. "GroupId": "63be9002440b4778a61122f14c2b2bbb",
  7. "GroupName": "myGroup3",
  8. "ApiId": "c076144d7878437b8f82fb85890ce6a0",
  9. "ApiName": " Obtain the object list",
  10. "Visibility": "public",
  11. "Description": " Display the object list on multiple pages",
  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": " Create object",
  21. "Visibility": "public",
  22. "Description": " Create object interface",
  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. }
Thank you! We've received your feedback.