All Products
Search

This Product

    Query the API group list

    Document Center
    Product Details

    Query the API group list

    Last Updated: May 17, 2017

    Description

    This function is for querying the existing API group list and basic information.

    • This function is intended for API providers.

    Request parameters

    Name Type Required? Description
    Action String Yes Interface name, which is a required parameter; value: DescribeApiGroups.
    GroupId String No API group ID, which is generated by the system and globally unique.
    GroupName String No Specified keyword of the API group name.
    PageNumber Integer No The page number specified for query; default value: 1; the starting number: 1.
    PageSize Integer No Number of lines per page set for paging query; maximum value: 50; default value: 10.

    Returned parameters

    Name Type Description
    RequestId String Unique request ID.
    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.
    ApiGroupAttributes ApiGroupAttribute Returned group set.

    Examples

    Request example

     
      
  
    1. http://apigateway.cn-hangzhou.aliyuncs.com?Action=DescribeApiGroups
      2. 
  
    2. &<Public request parameters>
      3.

    Response example

    XML format

     
      
  
    1. <DescribeApiGroupsResponse>
      2. 
  
    2.     <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>
      3. 
  
    3.     <TotalCount>2</TotalCount>
      4. 
  
    4.     <PageSize>10</PageSize>
      5. 
  
    5.     <PageNumber>1</PageNumber>
      6. 
  
    6.         <ApiGroupAttributes>
      7. 
  
    7.             <ApiGroupAttribute>
      8. 
  
    8.                 <GroupId>be6d2abcc0dd4f749fc2d2edd6567164</GroupId>
      9. 
  
    9.                 <GroupName>Traffic</GroupName>
      10. 
  
    10.                 <SubDomain>be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com</SubDomain>
      11. 
  
    11.                 <Description>TrafficInformations.</Description>
      12. 
  
    12.                   <CreatedTime>2016-08-01T08:45:15Z</CreatedTime>
      13. 
  
    13.                   <ModifiedTime>2016-08-01T08:45:15Z</ModifiedTime>
      14. 
  
    14.                   <RegionId>cn-hangzhou</RegionId>
      15. 
  
    15.                   <TrafficLimit>500</TrafficLimit>
      16. 
  
    16.                   <BillingStatus>NORMAL</BillingStatus>
      17. 
  
    17.                   <IllegalStatus>NORMAL</IllegalStatus>
      18. 
  
    18.             </ApiGroupAttribute>
      19. 
  
    19.             <ApiGroupAttribute>
      20. 
  
    20.                 <GroupId>927d50c0f2e54b359919923d908bb015</GroupId>
      21. 
  
    21.                 <GroupName>NewWeather</GroupName>
      22. 
  
    22.                   <SubDomain>927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com</SubDomain>
      23. 
  
    23.                   <Description>NewWeatherInformations.</Description>
      24. 
  
    24.                   <CreatedTime>2016-08-01T06:54:32Z</CreatedTime>
      25. 
  
    25.                   <ModifiedTime>2016-08-01T06:54:32Z</ModifiedTime>
      26. 
  
    26.                   <RegionId>cn-hangzhou</RegionId>
      27. 
  
    27.                   <TrafficLimit>500</TrafficLimit>
      28. 
  
    28.                   <BillingStatus>NORMAL</BillingStatus>
      29. 
  
    29.                   <IllegalStatus>NORMAL</IllegalStatus>
      30. 
  
    30.             </ApiGroupAttribute>
      31. 
  
    31.         </ApiGroupAttributes>
      32. 
  
    32. </DescribeApiGroupsResponse>
      33.

    JSON format

     
      
  
    1.  {
      2. 
  
    2.     "RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
      3. 
  
    3.     "TotalCount": "2",
      4. 
  
    4.     "PageSize": "10",
      5. 
  
    5.     "PageNumber": "1",
      6. 
  
    6.     "ApiGroupAttributes": {
      7. 
  
    7.       "ApiGroupAttribute": [
      8. 
  
    8.         {
      9. 
  
    9.           "GroupId": "be6d2abcc0dd4f749fc2d2edd6567164",
      10. 
  
    10.           "GroupName": "Traffic",
      11. 
  
    11.           "SubDomain": "be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com",
      12. 
  
    12.           "Description": "TrafficInformations.",
      13. 
  
    13.           "CreatedTime": "2016-08-01T08:45:15Z",
      14. 
  
    14.           "ModifiedTime": "2016-08-01T08:45:15Z",
      15. 
  
    15.           "RegionId": "cn-hangzhou",
      16. 
  
    16.           "TrafficLimit": "500",
      17. 
  
    17.           "BillingStatus": "NORMAL",
      18. 
  
    18.           "IllegalStatus": "NORMAL"
      19. 
  
    19.         },
      20. 
  
    20.         {
      21. 
  
    21.           "GroupId": "927d50c0f2e54b359919923d908bb015",
      22. 
  
    22.           "GroupName": "NewWeather",
      23. 
  
    23.           "SubDomain": "927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com",
      24. 
  
    24.           "Description": "NewWeatherInformations.",
      25. 
  
    25.           "CreatedTime": "2016-08-01T06:54:32Z",
      26. 
  
    26.           "ModifiedTime": "2016-08-01T06:54:32Z",
      27. 
  
    27.           "RegionId": "cn-hangzhou",
      28. 
  
    28.           "TrafficLimit": "500",
      29. 
  
    29.           "BillingStatus": "NORMAL",
      30. 
  
    30.           "IllegalStatus": "NORMAL"
      31. 
  
    31.         }
      32. 
  
    32.       ]
      33. 
  
    33.     }
      34. 
  
    34. }
      35.
    Free Trial Free Trial