Query the list of released APIs - Developer Guide| Alibaba Cloud Documentation Center

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

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

Response example

XML format

 
  <DescribeDeployedApisResponse>
      <DeployedApis>
          <DeployedApiItem>
              <RegionId>cn-qingdao</RegionId>
              <GroupId>63be9002440b4778a61122f14c2b2bbb</GroupId>
              <GroupName>myGroup3</GroupName>
              <ApiId>c076144d7878437b8f82fb85890ce6a0</ApiId>
              <ApiName> Obtain the object list</ApiName>
              <StageName>release</StageName>
              <Visibility>public</Visibility>
              <Description> Display the object list on multiple pages</Description>
              <DeployedTime>2016-07-23T08:28:48Z</DeployedTime>
          </DeployedApiItem>
          <DeployedApiItem>
              <RegionId>cn-qingdao</RegionId>
              <GroupId>1084f9034c744137901057206b39d2b6</GroupId>
              <GroupName>myGroup2</GroupName>
              <ApiId>5af418828f0344a3b588c0cc1331a3bc</ApiId>
              <ApiName> Create object</ApiName>
              <StageName>release</StageName>
              <Visibility>public</Visibility>
              <Description> Create object interface</Description>
              <DeployedTime>2016-07-20T08:28:48Z</DeployedTime>
          </DeployedApiItem>
      </DeployedApis>
      <PageNumber>3</PageNumber>
      <PageSize>15</PageSize>
      <TotalCount>32</TotalCount>
      <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ002</RequestId>        
  </DescribeDeployedApisResponse>

JSON format

 
  {
      "DeployedApis": {
          "DeployedApiItem": [
                {
                  "RegionId": "cn-qingdao",
                  "GroupId": "63be9002440b4778a61122f14c2b2bbb",
                  "GroupName": "myGroup3",
                  "ApiId": "c076144d7878437b8f82fb85890ce6a0",
                  "ApiName": " Obtain the object list",
                  "StageName": "release",
                  "Visibility": "public",
                  "Description": " Display the object list on multiple pages",
                  "DeployedTime": "2016-07-23T08:28:48Z"
                },
                {
                  "RegionId": "cn-qingdao",
                  "GroupId": "1084f9034c744137901057206b39d2b6",
                  "GroupName": "myGroup2",
                  "ApiId": "5af418828f0344a3b588c0cc1331a3bc",
                  "ApiName": " Create object",
                  "StageName": "release",
                  "Visibility": "public",
                  "Description": " Create object interface",
                  "DeployedTime": "2016-07-20T08:28:48Z"
                }
          ]
        },
      "PageNumber": 3,
        "PageSize": 15,  
        "TotalCount": 32,
      "RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ002"
  }