DescribePurchasedApiGroup Reference for Marketplace API Groups - API Gateway

Queries the details about an API group 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:DescribePurchasedApiGroup

get

*ApiGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the API group. This ID is generated by the system and globally unique.	102b631ae1094e33a77c45312226184e

Response elements

Element	Type	Description	Example
	object
Status	string	The status of the API group. NORMAL: The API group is normal. DELETE: The API group is deleted.	NORMAL
PurchasedTime	string	The time when the API group was purchased.	2021-12-19T00:00:00
RequestId	string	The ID of the request.	61A16D46-EC04-5288-8A18-811B0F536CC2
GroupId	string	The ID of the API group.	48977d7b96074966a7c9c2a8872d7e06
GroupName	string	The name of the API group.	Weather
Description	string	The description of the API group.	api group description
RegionId	string	The region where the API group is located.	cn-qingdao
Domains	object
DomainItem	array<object>	The list of domain names.
	object	The list of domain names.
DomainName	string	The domain name.	test_domain.com

Examples

Success response

JSON format

{
  "Status": "NORMAL",
  "PurchasedTime": "2021-12-19T00:00:00",
  "RequestId": "61A16D46-EC04-5288-8A18-811B0F536CC2",
  "GroupId": "48977d7b96074966a7c9c2a8872d7e06",
  "GroupName": "Weather",
  "Description": "api group description",
  "RegionId": "cn-qingdao",
  "Domains": {
    "DomainItem": [
      {
        "DomainName": "test_domain.com"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.