All Products
Search
Document Center

API Gateway:DescribeApiGroups

Last Updated:Mar 01, 2024

Queries existing API groups and their basic information.

Operation description

  • This operation is intended for API providers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:DescribeApiGroupsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdstringNo

The ID of the API group. This ID is generated by the system and globally unique.

be6d2abcc0dd4f749fc2d2edd6567164
GroupNamestringNo

The keyword that can be specified in the name of the API group.

Traffic
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Maximum value: 50. Default value: 10.

10
EnableTagAuthbooleanNo

Specifies whether to enable tag verification.

true
InstanceIdstringNo

The ID of the instance.

apigateway-cn-v6419k43245xx
SortstringNo

The order. Valid values: asc and desc. Default value: desc.

  • asc: The API groups are displayed in ascending order of modification time.
  • desc: The API groups are displayed in descending order of modification time.
desc
Tagobject []No

The list of tags.

KeystringNo

The key of the tag.

key
ValuestringNo

The value of the tag.

value

Response parameters

ParameterTypeDescriptionExample
object
PageNumberinteger

The number of pages to return the results on.

1
RequestIdstring

The ID of the request.

D6E46F10-F26C-4AA0-BB69-FE2743D9AE62
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of returned entries.

2
ApiGroupAttributesobject []

The returned group set.

BasePathstring

The basepath.

/v2/
BillingStatusstring

The billing status of the API group. Valid values:

  • NORMAL: The instance is normal.
  • LOCKED: The API group is locked due to overdue payments.
NORMAL
TrafficLimitinteger

The upper QPS limit of the API group. The default value is 500. You can increase the upper limit by submitting an application.

500
InstanceIdstring

The ID of the instance.

apigateway-cn-v6419k43245xx
InstanceTypestring

The type of the instance.

VPC_SHARED
RegionIdstring

The region to which the API group belongs.

cn-hangzhou
ModifiedTimestring

The last modification time (UTC) of the API group.

2016-08-01T08:45:15Z
GroupIdstring

The ID of the API group. This ID is generated by the system and globally unique.

be6d2abcc0dd4f749fc2d2edd6567164
GroupNamestring

The name of the API group.

Traffic
Descriptionstring

Group Description

TrafficInformations.
IllegalStatusstring

The validity status of the API group. Valid values:

  • NORMAL: The instance is normal.
  • LOCKED: The API group is locked because it is not valid.
NORMAL
HttpsPolicystring

The HTTPS security policy

HTTPS2_TLS1_0
SubDomainstring

The second-level domain name that corresponds to the API group and is used by the CNAME of the custom domain name.

be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com
CreatedTimestring

The creation time (UTC) of the API group.

2016-08-01T08:45:15Z
Tagsobject []

The list of tags.

Keystring

The key of the tag.

key
Valuestring

The value of the tag.

value

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history