edit-icon download-icon

Query the list of released APIs

Last Updated: May 17, 2017

Description

For querying the list of APIs released to a specified stage, that is, querying the list of APIs running in the specified stage.

  • This function is intended for API activators.

Request parameters

Name Type Required? Description
Action String Yes Operation interface, which is a required parameter; value: DescribeDeployedApis.
GroupId String No ID of the specified group.
StageName String Yes Stage name; values:
  • RELEASE: Online
  • TEST: Test
ApiId String No ID of the specified API.
ApiName String No API name (fuzzy matching).
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.
DeployedApis DeployedApiItem Returned API information, in an array consisting of DeployedApiItem.

Examples

Request example

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

Response example

XML format

  1. <DescribeDeployedApisResponse>
  2. <DeployedApis>
  3. <DeployedApiItem>
  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. <StageName>release</StageName>
  10. <Visibility>public</Visibility>
  11. <Description> Display the object list on multiple pages</Description>
  12. <DeployedTime>2016-07-23T08:28:48Z</DeployedTime>
  13. </DeployedApiItem>
  14. <DeployedApiItem>
  15. <RegionId>cn-qingdao</RegionId>
  16. <GroupId>1084f9034c744137901057206b39d2b6</GroupId>
  17. <GroupName>myGroup2</GroupName>
  18. <ApiId>5af418828f0344a3b588c0cc1331a3bc</ApiId>
  19. <ApiName> Create object</ApiName>
  20. <StageName>release</StageName>
  21. <Visibility>public</Visibility>
  22. <Description> Create object interface</Description>
  23. <DeployedTime>2016-07-20T08:28:48Z</DeployedTime>
  24. </DeployedApiItem>
  25. </DeployedApis>
  26. <PageNumber>3</PageNumber>
  27. <PageSize>15</PageSize>
  28. <TotalCount>32</TotalCount>
  29. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ002</RequestId>
  30. </DescribeDeployedApisResponse>

JSON format

  1. {
  2. "DeployedApis": {
  3. "DeployedApiItem": [
  4. {
  5. "RegionId": "cn-qingdao",
  6. "GroupId": "63be9002440b4778a61122f14c2b2bbb",
  7. "GroupName": "myGroup3",
  8. "ApiId": "c076144d7878437b8f82fb85890ce6a0",
  9. "ApiName": " Obtain the object list",
  10. "StageName": "release",
  11. "Visibility": "public",
  12. "Description": " Display the object list on multiple pages",
  13. "DeployedTime": "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. "StageName": "release",
  22. "Visibility": "public",
  23. "Description": " Create object interface",
  24. "DeployedTime": "2016-07-20T08: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.