获取插件列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
apig:ListPlugins |
none |
*全部资源
|
无 | 无 |
请求语法
GET /v1/plugins HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| gatewayId |
string |
否 |
网关实例 id 过滤参数 |
gw-csrhgn6m1hkt65qbxxgg |
| pluginClassId |
string |
否 |
插件类型 id 过滤参数 |
pls-dn82a9djd8z**** |
| pageNumber |
integer |
否 |
分页页码。 |
1 |
| pageSize |
integer |
否 |
分页大小 |
10 |
| pluginClassName |
string |
否 |
插件类型名称过滤参数 |
key-auth |
| withAttachmentInfo |
boolean |
否 |
返回结果是否需要包含 attachResourceId 对应的插件挂载信息 |
false |
| attachResourceId |
string |
否 |
挂载资源 ID |
api-cuip2pum1hksng6oni3g |
| attachResourceType |
string |
否 |
策略支持挂载点类型。
|
HttpApi |
| gatewayType |
string |
否 |
网关类型过滤，目前支持 AI、API 两种网关类型。 |
AI |
| includeBuiltinAiGateway |
boolean |
否 |
返回结果是否需要包含系统内置安装的 AI 插件，默认 false |
false |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
请求 ID。 |
168BA42D-F822-569D-A67F-FC59E6ABC2B1 |
| code |
string |
响应状态码。 |
Ok |
| message |
string |
响应消息。 |
success |
| data |
object |
返回数据 |
|
| pageNumber |
integer |
分页页码。 |
1 |
| pageSize |
integer |
分页大小。 |
10 |
| totalSize |
integer |
总数量。 |
10 |
| items |
array<object> |
插件列表信息。 |
|
|
array<object> |
插件信息。 |
||
| pluginId |
string |
插件 ID |
pl-cvu6r4um1hko3b3ti0a0 |
| gatewayInfo |
object |
网关信息。 |
|
| gatewayId |
string |
网关 id。 |
gw-cq7og15lhtxx6qasrj60 |
| name |
string |
网关名称。 |
apitest-gw |
| pluginClassInfo |
object |
插件类型信息 |
|
| pluginClassId |
string |
插件类型 ID |
pls-cqebrgh46ppatmpri |
| name |
string |
插件名称 |
key-rate-limit |
| version |
string |
版本。 |
2.0.3 |
| versionDescription |
string |
版本描述 |
版本描述 |
| executeStage |
string |
执行阶段。 |
AUTHZ |
| executePriority |
string |
执行优先级。 |
999 |
| alias |
string |
别名 |
基于 Key 限流 |
| source |
string |
插件来源 |
HigressOfficial |
| attachmentInfo |
object |
插件挂载信息 |
|
| pluginAttachmentId |
string |
插件挂载 ID。 |
pa-ct2irn6m1hkreaen0t40 |
| enable |
string |
是否启用。 |
false |
示例
正常返回示例
JSON格式
{
"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": {
"pluginClassId": "pls-cqebrgh46ppatmpri",
"name": "key-rate-limit",
"version": "2.0.3",
"versionDescription": "版本描述",
"executeStage": "AUTHZ",
"executePriority": "999",
"alias": "基于 Key 限流",
"source": "HigressOfficial"
},
"attachmentInfo": {
"pluginAttachmentId": "pa-ct2irn6m1hkreaen0t40",
"enable": "false"
}
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。