获取插件列表
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| 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 |
返回参数
示例
正常返回示例
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": {
"version": "2.0.3",
"versionDescription": "版本描述",
"executeStage": "AUTHZ",
"executePriority": 999,
"name": "key-rate-limit",
"alias": "基于 Key 限流",
"source": "HigressOfficial",
"pluginClassId": "pls-cqebrgh46ppatmpri"
},
"attachmentInfo": {
"pluginAttachmentId": "pa-ct2irn6m1hkreaen0t40",
"enable": false
}
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-06-03 | OpenAPI 入参发生变更 | 查看变更详情 |