DescribePurchasedApis - API Gateway - Alibaba Cloud Documentation Center

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
apigateway:DescribePurchasedApis	get	*ApiGroup `acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}`	none	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.	Cz88IpQuery
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 parameters

Parameter	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	array<object>	The monitoring information about API call delays. The returned information is an array consisting of purchased APIs.
PurchasedApi	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.	test
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

Sample success responses

JSONformat

{
  "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": "test\n",
        "GroupName": "DMS_DEFAULT_GROUP_408589",
        "GroupId": "3013a55c0c44483f984d26df27120513",
        "DeployedTime": "2021-06-1113:57:38",
        "StageName": "TEST",
        "ApiName": "gw_rado_tissot_",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history