DescribePurchasedApiGroups API Reference - API Gateway - Alibaba Cloud - API Gateway

Queries API groups purchased from Alibaba Cloud Marketplace.

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:DescribePurchasedApiGroups

get

*ApiGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	20

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The page number.	1
RequestId	string	The request ID.	36BBBAD4-1CFB-489F-841A-8CA52EEA787E
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries.	2
PurchasedApiGroupAttributes	object
PurchasedApiGroupAttribute	array<object>	The attributes of the API group.
	object	The attributes of the API group.
Status	string	The status of the API group. NORMAL: The API group is normal. DELETE: The API group is deleted.	NORMAL
PurchasedTime	string	The purchase time of the API group.	2021-12-19T00:00:00
ExpireTime	string	The expiration time of the API group.	2021-12-19T00:00:00
Description	string	The description of the API group.	1
GroupName	string	The name of the API group.	group1
GroupId	string	The ID of the API group.	8e91f23f88f94348855b82c9a73209f3
InvokeTimesMax	integer	The maximum number of API calls allowed.	10
InvokeTimesNow	integer	The current number of API calls made.	10
BillingType	string	The billing method.	POSTPAID
RegionId	string	The region ID of the API group.	cn-shanghai

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.