DescribePluginApis - API Gateway - Alibaba Cloud Documentation Center

Queries the APIs to which a specified plug-in is bound.

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

get

*Plugin

acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}

None

Request parameters

Parameter	Type	Required	Description	Example
PluginId	string	Yes	The ID of the gateway plug-in.	bf6583efcef44c51adb00c4e********
GroupId	string	No	The ID of the API group.	231a4bb81ee94da785733c29********
ApiId	string	No	The ID of the API.	c6b0dd188b0e4e408e12f926********
ApiName	string	No	The name of the API.	API名称
Path	string	No	The request path of the API.	/sendVerifyCode
Method	string	No	The request HTTP method of the API.	GET
Description	string	No	The description of the API.	API描述信息
PageSize	integer	No	The number of entries returned per page. Default value:10.	10
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object	The response parameters.
PageNumber	integer	The page number of the page to return.	1
RequestId	string	The request ID.	F9C5C4A5-BC6C-57A3-839F-AB08********
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	7
ApiSummarys	object
ApiPluginSummary	array<object>	The information about APIs.
	object
ApiId	string	The API ID.	accc8c68b7294b1cb4928741********
Description	string	The API description.	API描述信息
GroupName	string	The API group to which the API belongs.	myGroup2
GroupId	string	The ID of the API group.	5f51f89261854fd9ad5116be********
Path	string	The request path of the API.	/mqTest
Method	string	The HTTP method of the API.	GET
StageName	string	The environment to which the API is published. Valid values: RELEASE: the production environment PRE: the pre-release environment TEST: the test environment	RELEASE
ApiName	string	The API name.	fhosQueryDayOfStock_V2
RegionId	string	The ID of the region in which the API resides.	cn-shanghai
StageAlias	string	The environment alias.	线上

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "F9C5C4A5-BC6C-57A3-839F-AB08********",
  "PageSize": 10,
  "TotalCount": 7,
  "ApiSummarys": {
    "ApiPluginSummary": [
      {
        "ApiId": "accc8c68b7294b1cb4928741********",
        "Description": "API描述信息",
        "GroupName": "myGroup2",
        "GroupId": "5f51f89261854fd9ad5116be********",
        "Path": "/mqTest",
        "Method": "GET",
        "StageName": "RELEASE",
        "ApiName": "fhosQueryDayOfStock_V2",
        "RegionId": "cn-shanghai",
        "StageAlias": "线上"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.