All Products
Search
Document Center

API Gateway:DescribePurchasedApiGroup

Last Updated:Jul 31, 2025

Queries the details about an API group 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:DescribePurchasedApiGroupget
*ApiGroup
acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdstringYes

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

102b631ae1094e33a77c45312226184e

Response parameters

ParameterTypeDescriptionExample
object
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
RequestIdstring

The ID of the request.

61A16D46-EC04-5288-8A18-811B0F536CC2
GroupIdstring

The ID of the API group.

48977d7b96074966a7c9c2a8872d7e06
GroupNamestring

The name of the API group.

Weather
Descriptionstring

The description of the API group.

api group description
RegionIdstring

The region where the API group is located.

cn-qingdao
Domainsarray<object>

The list of domain names.

DomainItemobject

The list of domain names.

DomainNamestring

The domain name.

test_domain.com

Examples

Sample success responses

JSONformat

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

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

Change history

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