API Gateway:DescribePurchasedApis - API Gateway - Alibaba Cloud - API Gateway

Queries the APIs purchased in the 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:DescribePurchasedApis

get

*ApiGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	No	The ID of the API group.	d27ad517be5f4c95ac3631780a8f4d50
StageName	string	No	The name of the runtime environment. Valid values: RELEASE PRE TEST	RELEASE
ApiId	string	No	The ID of the API.	3b81fd160f5645e097cc8855d75a1cf6
ApiName	string	No	The name of the API.	ChunzhenIPIP library query API
Visibility	string	No	Specifies whether the API is public. Valid values: PUBLIC: indicates that the API is public. If you set this parameter to PUBLIC, this API is displayed on the API List page in the console for all users after the API is published to the production environment. PRIVATE: indicates that the API is private. If you set this parameter to PRIVATE, this API is not displayed in Alibaba Cloud Marketplace after the API group to which this API belongs is made available.	PUBLIC
PageSize	integer	No	The number of entries to return on each page.	10
PageNumber	integer	No	The page number of the page to return.	1

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	CE5722A6-AE78-4741-A9B0-6C817D360510
PageSize	integer	The number of entries returned on each page.	10
TotalCount	integer	The total number of returned entries.	20
PurchasedApis	object
PurchasedApi	array<object>	The monitoring information about API call delays. The returned information is an array consisting of purchased APIs.
	object	The monitoring information about API call delays. The returned information is an array consisting of purchased APIs.
Visibility	string	Indicates whether the API is public. Valid values: PUBLIC PRIVATE	PUBLIC
PurchasedTime	string	The time when the API was purchased.	2021-06-11T13:57:38+08:00
ApiId	string	The ID of the API.	eb6e54c1576d41149746e8e69b0a0792
ModifiedTime	string	The last modification time (UTC) of the API.	2021-06-11T13:57:38+08:00
Description	string	The description of the API.	testTest
GroupName	string	The name of the API group.	DMS_DEFAULT_GROUP_408589
GroupId	string	The ID of the API group to which the API belongs. This ID is generated by the system and globally unique.	3013a55c0c44483f984d26df27120513
DeployedTime	string	The deployment time. Format: yyyy-mm-ddhh:mm:ss.	2021-06-1113:57:38
StageName	string	The name of the runtime environment. Valid values: RELEASE PRE TEST	TEST
ApiName	string	The name of the API.	gw_rado_tissot_
RegionId	string	The ID of the region in which the API is located.	cn-hangzhou

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "CE5722A6-AE78-4741-A9B0-6C817D360510",
  "PageSize": 10,
  "TotalCount": 20,
  "PurchasedApis": {
    "PurchasedApi": [
      {
        "Visibility": "PUBLIC",
        "PurchasedTime": "2021-06-11T13:57:38+08:00",
        "ApiId": "eb6e54c1576d41149746e8e69b0a0792",
        "ModifiedTime": "2021-06-11T13:57:38+08:00",
        "Description": "testTest",
        "GroupName": "DMS_DEFAULT_GROUP_408589",
        "GroupId": "3013a55c0c44483f984d26df27120513",
        "DeployedTime": "2021-06-1113:57:38",
        "StageName": "TEST",
        "ApiName": "gw_rado_tissot_",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.