Query the API list in definition - Developer Guide| Alibaba Cloud Documentation Center

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

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

Response example

XML format

<DescribeApisResponse>
    <ApiSummarys>
        <ApiSummary>
            <RegionId>cn-qingdao</RegionId>
            <GroupId>63be9002440b4778a61122f14c2b2bbb</GroupId>
            <GroupName>myGroup3</GroupName>
            <ApiId>c076144d7878437b8f82fb85890ce6a0</ApiId>
            <ApiName> Obtain the object list</ApiName>                
            <Visibility>public</Visibility>
            <Description> Display the object list on multiple pages</Description>
            <CreatedTime>2016-06-20T18:18:25Z</CreatedTime>
            <ModifiedTime>2016-07-23T08:28:48Z</ModifiedTime>
        </ApiSummary>
        <ApiSummary>
            <RegionId>cn-qingdao</RegionId>
            <GroupId>1084f9034c744137901057206b39d2b6</GroupId>
            <GroupName>myGroup2</GroupName>
            <ApiId>5af418828f0344a3b588c0cc1331a3bc</ApiId>
            <ApiName> Create object</ApiName>                
            <Visibility>public</Visibility>
            <Description> Create object interface</Description>
            <CreatedTime>2016-05-20T18:18:25Z</CreatedTime>
            <ModifiedTime>2016-07-23T08:28:48Z</ModifiedTime>
        </ApiSummary>
    </ApiSummarys>
    <PageNumber>3</PageNumber>
    <PageSize>15</PageSize>
    <TotalCount>32</TotalCount>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ002</RequestId>        
</DescribeApisResponse>

JSON format

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