全部产品

查询 API 分组列表

更新时间:2017-07-05 15:14:31

描述

用于查询当前存在的API分组列表及基本信息

  • 此功能面向API提供者

请求参数

名称 类型 是否必须 描述
Action String 接口名称,系统规定参数,取值:DescribeApiGroups
GroupId String API分组 ID,系统生成,全局唯一
GroupName String API组名称中,可指定的关键字
PageNumber Integer 指定要查询的页码,默认是1,起始是1
PageSize Integer 指定分页查询时每页行数,最大值50,默认值为10

返回参数

名称 类型 描述
RequestId String 请求唯一标识
TotalCount Integer 返回结果的总条数
PageNumber Integer 返回指定的页码
PageSize Integer 返回指定的每页条数
ApiGroupAttributes ApiGroupAttribute 返回分组集合

示例

请求示例

  1. http://apigateway.cn-hangzhou.aliyuncs.com?Action=DescribeApiGroups
  2. &<公共请求参数>

返回示例

XML格式

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

JSON格式

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