Queries plug-ins.
Debugging
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 Resourcesis 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:ListPlugins | none | *All Resources * |
| none |
Request syntax
GET /v1/plugins HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| gatewayId | string | No | The gateway instance ID for filtering. | gw-csrhgn6m1hkt65qbxxgg |
| pluginClassId | string | No | The plug-in type ID for filtering. | pls-dn82a9djd8z**** |
| pageNumber | integer | No | The page number to return. Pages start from 1. Default value: 1. | 1 |
| pageSize | integer | No | The number of entries per page. Default value: 10. | 10 |
| pluginClassName | string | No | The plug-in type name for filtering. | key-auth |
| withAttachmentInfo | boolean | No | Specifies whether the returned results should include plug-in attachment information corresponding to the attachResourceId. | false |
| attachResourceId | string | No | The resource attachment ID. | api-cuip2pum1hksng6oni3g |
| attachResourceType | string | No | The resource attachment type.
| HttpApi |
| gatewayType | string | No | The instance type. Valid values: AI and API. | AI |
| includeBuiltinAiGateway | boolean | No | Specifies whether to include built-in AI plug-ins in the returned results. Default: false. | false |
Response parameters
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 time | Summary of changes | Operation |
|---|---|---|
| 2025-06-03 | The request parameters of the API has changed | View Change Details |
