ListPluginClasses-阿里云帮助中心

Retrieves plug-ins.

Operation description

The operation supports creating multiple services.

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

apig:ListPluginClasses

none

*All Resource

*

None

Request syntax

GET /v1/plugin-classes HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
nameLike	string	No	The plug-in name. Fuzzy match is supported.	oauth
aliasLike	string	No	The plug-in alias. Fuzzy match is supported.	OAuth2 认证
type	string	No	The plug-in type.	Auth
source	string	No	The plug-in source. Valid values: HigressOfficial: Higress official. HigressCommunity: Higress community. Custom: custom.	HigressOfficial
pageSize	integer	No	The number of entries per page.	10
pageNumber	integer	No	The page number. Default value: 1.	1
gatewayId	string	No	The gateway ID.	gw-d1j8tjum1hkhxxxxxxxx
installed	boolean	No	Specifies whether the plug-in is installed.	false
direction	string	No	The inbound or outbound direction. Valid values: OutBound: outbound. InBound: inbound. Both: both directions.	InBound
excludeBuiltinAiProxy	boolean	No	Specifies whether to exclude built-in plug-ins.	true
gatewayType	string	No	The gateway type filter. Currently, AI and API gateway types are supported.	API

Response elements

Element	Type	Description	Example
	object	The response information.
requestId	string	The request ID.	61EBF577-1601-51E1-B136-9CD6xxxxxxxx
code	string	The response status code.	200
message	string	The error message.	success
data	object	The response data.
pageNumber	integer	The page number.	1
pageSize	integer	The number of entries per page.	10
totalSize	integer	The total number of entries.	10
items	array<object>	The result objects.
	object	The plug-in information.
pluginClassId	string	The plug-in type ID.	pls-d4ghv6em1hkixxxxxxxx
name	string	The plug-in name.	oauth
alias	string	The plug-in alias.	OAuth2 认证
description	string	The plug-in description.	基于 OAuth2 实现身份认证和鉴权。
version	string	The plug-in version.	1.0.0
type	string	The plug-in type.	Auth
source	string	The plug-in source.	HigressOfficial
supportedMinGatewayVersion	string	The minimum gateway version supported by the plug-in.	2.0.0
publishStatus	string	The publish status.	Success
pluginId	string	The plug-in ID.	pl-cvu6r4um1hkoxxxxxxxx
installed	boolean	Indicates whether the plug-in is installed.	true

Examples

Success response

JSON format

{
  "requestId": "61EBF577-1601-51E1-B136-9CD6xxxxxxxx",
  "code": "200",
  "message": "success",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalSize": 10,
    "items": [
      {
        "pluginClassId": "pls-d4ghv6em1hkixxxxxxxx",
        "name": "oauth",
        "alias": "OAuth2 认证",
        "description": "基于 OAuth2 实现身份认证和鉴权。",
        "version": "1.0.0",
        "type": "Auth",
        "source": "HigressOfficial",
        "supportedMinGatewayVersion": "2.0.0",
        "publishStatus": "Success",
        "pluginId": "pl-cvu6r4um1hkoxxxxxxxx",
        "installed": true
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.