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
http://apigateway.cn-hangzhou.aliyuncs.com?Action=DescribeApiGroups
&<Public request parameters>
Response example
XML
format
<DescribeApiGroupsResponse>
<RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>
<TotalCount>2</TotalCount>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<ApiGroupAttributes>
<ApiGroupAttribute>
<GroupId>be6d2abcc0dd4f749fc2d2edd6567164</GroupId>
<GroupName>Traffic</GroupName>
<SubDomain>be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com</SubDomain>
<Description>TrafficInformations.</Description>
<CreatedTime>2016-08-01T08:45:15Z</CreatedTime>
<ModifiedTime>2016-08-01T08:45:15Z</ModifiedTime>
<RegionId>cn-hangzhou</RegionId>
<TrafficLimit>500</TrafficLimit>
<BillingStatus>NORMAL</BillingStatus>
<IllegalStatus>NORMAL</IllegalStatus>
</ApiGroupAttribute>
<ApiGroupAttribute>
<GroupId>927d50c0f2e54b359919923d908bb015</GroupId>
<GroupName>NewWeather</GroupName>
<SubDomain>927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com</SubDomain>
<Description>NewWeatherInformations.</Description>
<CreatedTime>2016-08-01T06:54:32Z</CreatedTime>
<ModifiedTime>2016-08-01T06:54:32Z</ModifiedTime>
<RegionId>cn-hangzhou</RegionId>
<TrafficLimit>500</TrafficLimit>
<BillingStatus>NORMAL</BillingStatus>
<IllegalStatus>NORMAL</IllegalStatus>
</ApiGroupAttribute>
</ApiGroupAttributes>
</DescribeApiGroupsResponse>
JSON
format
{
"RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
"TotalCount": "2",
"PageSize": "10",
"PageNumber": "1",
"ApiGroupAttributes": {
"ApiGroupAttribute": [
{
"GroupId": "be6d2abcc0dd4f749fc2d2edd6567164",
"GroupName": "Traffic",
"SubDomain": "be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com",
"Description": "TrafficInformations.",
"CreatedTime": "2016-08-01T08:45:15Z",
"ModifiedTime": "2016-08-01T08:45:15Z",
"RegionId": "cn-hangzhou",
"TrafficLimit": "500",
"BillingStatus": "NORMAL",
"IllegalStatus": "NORMAL"
},
{
"GroupId": "927d50c0f2e54b359919923d908bb015",
"GroupName": "NewWeather",
"SubDomain": "927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com",
"Description": "NewWeatherInformations.",
"CreatedTime": "2016-08-01T06:54:32Z",
"ModifiedTime": "2016-08-01T06:54:32Z",
"RegionId": "cn-hangzhou",
"TrafficLimit": "500",
"BillingStatus": "NORMAL",
"IllegalStatus": "NORMAL"
}
]
}
}