All Products
Search
Document Center

API Gateway:ListPlugins

Last Updated:Dec 17, 2025

Queries plug-ins.

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.
OperationAccess levelResource typeCondition keyAssociated operation
apig:ListPluginsnone
*All Resources
*
    none
none

Request syntax

GET /v1/plugins HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
gatewayIdstringNo

The gateway instance ID for filtering.

gw-csrhgn6m1hkt65qbxxgg
pluginClassIdstringNo

The plug-in type ID for filtering.

pls-dn82a9djd8z****
pageNumberintegerNo

The page number to return. Pages start from 1. Default value: 1.

1
pageSizeintegerNo

The number of entries per page. Default value: 10.

10
pluginClassNamestringNo

The plug-in type name for filtering.

key-auth
withAttachmentInfobooleanNo

Specifies whether the returned results should include plug-in attachment information corresponding to the attachResourceId.

false
attachResourceIdstringNo

The resource attachment ID.

api-cuip2pum1hksng6oni3g
attachResourceTypestringNo

The resource attachment type.

  • HttpApi: HttpApi.
  • Operation: Operation of HttpApi.
  • GatewayRoute: Gateway route.
  • GatewayService: Gateway service.
  • GatewayServicePort: Gateway service port.
  • Domain: Gateway domain.
  • Gateway: Gateway.
HttpApi
gatewayTypestringNo

The instance type. Valid values: AI and API.

AI
includeBuiltinAiGatewaybooleanNo

Specifies whether to include built-in AI plug-ins in the returned results. Default: false.

false

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

The request ID.

168BA42D-F822-569D-A67F-FC59E6ABC2B1
codestring

The status code.

Ok
messagestring

The status message.

success
dataobject

The response payload.

pageNumberinteger

The page number.

1
pageSizeinteger

The page size.

10
totalSizeinteger

The total number of entries returned.

10
itemsarray<object>

The list of plug-in information.

itemsobject

The plug-in information.

pluginIdstring

The plug-in ID.

pl-cvu6r4um1hko3b3ti0a0
gatewayInfoobject

The gateway instance information.

gatewayIdstring

The instance ID.

gw-cq7og15lhtxx6qasrj60
namestring

The instance name.

apitest-gw
pluginClassInfoobject

The plug-in type information.

versionstring

The version.

2.0.3
versionDescriptionstring

The description of the version.

version description
executeStagestring

The execution stage.

AUTHZ
executePrioritystring

The execution priority.

999
namestring

The name of the plug-in.

key-rate-limit
aliasstring

The alias.

key-based rate limit
sourcestring

The source of the plug-in.

HigressOfficial
pluginClassIdstring

The plug-in type ID.

pls-cqebrgh46ppatmpri
attachmentInfoobject

The attachment information.

pluginAttachmentIdstring

The attachment ID.

pa-ct2irn6m1hkreaen0t40
enablestring

Indicates if enabled.

false

Examples

Sample success responses

JSONformat

{
  "requestId": "168BA42D-F822-569D-A67F-FC59E6ABC2B1",
  "code": "Ok",
  "message": "success",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalSize": 10,
    "items": [
      {
        "pluginId": "pl-cvu6r4um1hko3b3ti0a0",
        "gatewayInfo": {
          "gatewayId": "gw-cq7og15lhtxx6qasrj60",
          "name": "apitest-gw"
        },
        "pluginClassInfo": {
          "version": "2.0.3",
          "versionDescription": "version description",
          "executeStage": "AUTHZ",
          "executePriority": 999,
          "name": "key-rate-limit",
          "alias": "key-based rate limit",
          "source": "HigressOfficial",
          "pluginClassId": "pls-cqebrgh46ppatmpri"
        },
        "attachmentInfo": {
          "pluginAttachmentId": "pa-ct2irn6m1hkreaen0t40",
          "enable": false
        }
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-06-03The request parameters of the API has changedView Change Details