All Products
Search
Document Center

API Gateway:DescribePurchasedApiGroups

Last Updated:Jul 31, 2025

Queries the API groups purchased from Alibaba Cloud Marketplace.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:DescribePurchasedApiGroupsget
*ApiGroup
acs:apigateway:{#regionId}:{#accountId}:apigroup/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
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: 100. Default value: 10.

20

Response parameters

ParameterTypeDescriptionExample
object
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

36BBBAD4-1CFB-489F-841A-8CA52EEA787E
PageSizeinteger

The number of entries returned on each page.

20
TotalCountinteger

The total number of entries returned.

2
PurchasedApiGroupAttributesarray<object>

The attributes of the API group.

PurchasedApiGroupAttributeobject

The attributes of the API group.

Statusstring

The status of the API group.

  • NORMAL: The API group is normal.
  • DELETE: The API group is deleted.
NORMAL
PurchasedTimestring

The time when the API group was purchased.

2021-12-19T00:00:00
ExpireTimestring

The time when the API group expires.

2021-12-19T00:00:00
Descriptionstring

The description of the API group.

1
GroupNamestring

The name of the API group.

group1
GroupIdstring

The ID of the API group.

8e91f23f88f94348855b82c9a73209f3
InvokeTimesMaxlong

The maximum number of calls.

10
InvokeTimesNowlong

The current number of calls.

10
BillingTypestring

The billing method.

POSTPAID
RegionIdstring

The ID of the region where the API group is located.

cn-shanghai

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "36BBBAD4-1CFB-489F-841A-8CA52EEA787E",
  "PageSize": 20,
  "TotalCount": 2,
  "PurchasedApiGroupAttributes": {
    "PurchasedApiGroupAttribute": [
      {
        "Status": "NORMAL",
        "PurchasedTime": "2021-12-19T00:00:00",
        "ExpireTime": "2021-12-19T00:00:00",
        "Description": 1,
        "GroupName": "group1",
        "GroupId": "8e91f23f88f94348855b82c9a73209f3",
        "InvokeTimesMax": 10,
        "InvokeTimesNow": 10,
        "BillingType": "POSTPAID",
        "RegionId": "cn-shanghai"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-11-14API Description UpdateView Change Details