All Products
Search

This Product

    API Gateway:ListPluginClasses

    Document Center

    API Gateway:ListPluginClasses

    Last Updated:Mar 30, 2026

    Obtains a plugin.

    Operation description

    create multiple services at a time.

    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.
    Operation Access level Resource type Condition key Associated operation
    apig:ListPluginClasses none
    *All Resources
    *
      none
    		 none

    Request syntax

    GET /v1/plugin-classes HTTP/1.1

    Request parameters

    Parameter Type Required Description Example
    nameLike string No

    The plugin name for a fuzzy search.

    		 oauth
    aliasLike string No

    The alias keyword for a fuzzy search.
    type string No

    The type of the plugin.

    		 Auth
    source string No

    The plugin source. Valid values:

    • HigressOfficial
    • HigressCommunity
    • 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

    Indicates whether the plugin is installed.

    		 false
    direction string No

    The traffic direction. Valid values:

    • OutBound
    • InBound
    • Both
    		 InBound
    excludeBuiltinAiProxy boolean No

    Specifies whether to exclude built-in plugins.

    		 true
    gatewayType string No

    The instance type. Valid values: AI and API.

    		 API

    Response parameters

    Parameter Type Description Example
    object

    The returned data.
    requestId string

    The ID of the request

    		 61EBF577-1601-51E1-B136-9CD6xxxxxxxx
    code string

    The status code.

    		 200
    message string

    The returned message.

    		 success
    data object

    The response parameters.
    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 plugin details.
    items object

    The information about the plugin.
    pluginClassId string

    The plugin type ID.

    		 pls-d4ghv6em1hkixxxxxxxx
    name string

    The plugin name.

    		 oauth
    alias string

    The alias of the plugin.
    description string

    The description of the plugin.
    version string

    The version.

    		 1.0.0
    type string

    The type of the plugin.

    		 Auth
    source string

    The source of the plugin.

    		 HigressOfficial
    supportedMinGatewayVersion string

    The minimum version of the gateway supported by the plugin.

    		 2.0.0
    publishStatus string

    The publishing status.

    		 Success
    pluginId string

    The plugin ID.

    		 pl-cvu6r4um1hkoxxxxxxxx
    installed boolean

    Indicates whether the plugin is installed.

    		 true

    Examples

    Sample success responses

    JSONformat

    {
  "requestId": "61EBF577-1601-51E1-B136-9CD6xxxxxxxx",
  "code": 200,
  "message": "success",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalSize": 10,
    "items": [
      {
        "pluginClassId": "pls-d4ghv6em1hkixxxxxxxx",
        "name": "oauth",
        "alias": "",
        "description": "",
        "version": "1.0.0",
        "type": "Auth",
        "source": "HigressOfficial",
        "supportedMinGatewayVersion": "2.0.0",
        "publishStatus": "Success",
        "pluginId": "pl-cvu6r4um1hkoxxxxxxxx",
        "installed": true
      }
    ]
  }
}

    Error codes

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

    Change history

    Change time Summary of changes Operation
    2026-01-05 Add Operation View Change Details