DescribeApiGroups API Reference - API Gateway - Alibaba Cloud - API Gateway

Queries a list of existing API groups and their basic information.

Operation description

This operation is intended for API providers.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:DescribeApiGroups

get

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/*

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	No	The ID of the API group. This ID is generated by the system and globally unique.	be6d2abcc0dd4f749fc2d2edd6567164
GroupName	string	No	The keyword that can be used to filter API groups by name.	Traffic
PageNumber	integer	No	The page number to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 50. Default value: 10.	10
EnableTagAuth	boolean	No	Whether to enable tag verification.	true
InstanceId	string	No	The ID of the instance.	apigateway-cn-v6419k43245xx
Sort	string	No	The sort order. Valid values: asc and desc. Default value: desc. asc: API groups are sorted in ascending order of modification time. desc: API groups are sorted in descending order of modification time.	desc
Tag	array<object>	No	The list of tags.
	object	No
Key	string	No	The key of the tag.	key
Value	string	No	The value of the tag.	value
BasePath	string	No	The root path of the API.	/edmdgp/service20250116management01/v1

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The request ID.	D6E46F10-F26C-4AA0-BB69-FE2743D9AE62
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries returned.	2
ApiGroupAttributes	object
ApiGroupAttribute	array<object>	The returned API group set.
	array<object>
BasePath	string	The base path.	/v2/
BillingStatus	string	The billing status of the API group. Valid values: NORMAL: The API group is normal. LOCKED: The API group is locked due to overdue payments.	NORMAL
TrafficLimit	integer	The upper QPS limit of the API group. Default value: 500. You can request an increase by submitting a ticket.	500
InstanceId	string	The ID of the instance.	apigateway-cn-v6419k43245xx
InstanceType	string	The type of the instance.	VPC_SHARED
RegionId	string	The region where the API group resides.	cn-hangzhou
ModifiedTime	string	The last modification time of the API group in UTC.	2016-08-01T08:45:15Z
GroupId	string	The ID of the API group. This ID is generated by the system and globally unique.	be6d2abcc0dd4f749fc2d2edd6567164
GroupName	string	The name of the API group.	Traffic
Description	string	The description of the API group.	TrafficInformations.
IllegalStatus	string	The validity status of the API group. Valid values: NORMAL: The API group is valid. LOCKED: The API group is locked because it is not valid.	NORMAL
HttpsPolicy	string	The HTTPS security policy.	HTTPS2_TLS1_0
SubDomain	string	The second-level domain name corresponding to the API group, used as the CNAME target for custom domain names.	be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com
CreatedTime	string	The creation time of the API group in UTC.	2016-08-01T08:45:15Z
Tags	object
TagInfo	array<object>	The list of tags.
	object
Key	string	The key of the tag.	key
Value	string	The value of the tag.	value

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
  "PageSize": 10,
  "TotalCount": 2,
  "ApiGroupAttributes": {
    "ApiGroupAttribute": [
      {
        "BasePath": "/v2/",
        "BillingStatus": "NORMAL",
        "TrafficLimit": 500,
        "InstanceId": "apigateway-cn-v6419k43245xx",
        "InstanceType": "VPC_SHARED",
        "RegionId": "cn-hangzhou",
        "ModifiedTime": "2016-08-01T08:45:15Z",
        "GroupId": "be6d2abcc0dd4f749fc2d2edd6567164",
        "GroupName": "Traffic",
        "Description": "TrafficInformations.",
        "IllegalStatus": "NORMAL",
        "HttpsPolicy": "HTTPS2_TLS1_0",
        "SubDomain": "be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com",
        "CreatedTime": "2016-08-01T08:45:15Z",
        "Tags": {
          "TagInfo": [
            {
              "Key": "key",
              "Value": "value"
            }
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.