获取插件。
接口说明
接口支持创建多个服务。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| apig:ListPluginClasses | none | *全部资源 * |
| 无 |
请求语法
GET /v1/plugin-classes HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| nameLike | string | 否 | 插件名称，模糊搜索。 | oauth |
| aliasLike | string | 否 | 插件别名，模糊搜索。 | OAuth2 认证 |
| type | string | 否 | 插件类型。 | Auth |
| source | string | 否 | 插件来源：
| HigressOfficial |
| pageSize | integer | 否 | 分页大小。 | 10 |
| pageNumber | integer | 否 | 页码，默认 1。 | 1 |
| gatewayId | string | 否 | 网关 id。 | gw-d1j8tjum1hkhxxxxxxxx |
| installed | boolean | 否 | 是否已安装。 | false |
| direction | string | 否 | 出入站方向：
| InBound |
| excludeBuiltinAiProxy | boolean | 否 | 是否排除内置的插件 | true |
| gatewayType | string | 否 | 网关类型过滤，目前支持 AI、API 两种网关类型。 | API |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "61EBF577-1601-51E1-B136-9CD6xxxxxxxx",
"code": 200,
"message": "success",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalSize": 10,
"items": [
{
"pluginClassId": "pls-d4ghv6em1hkixxxxxxxx",
"name": "oauth",
"alias": "OAuth2 认证",
"description": "基于 OAuth2 实现身份认证和鉴权。",
"version": "1.0.0",
"type": "Auth",
"source": "HigressOfficial",
"supportedMinGatewayVersion": "2.0.0",
"publishStatus": "Success",
"pluginId": "pl-cvu6r4um1hkoxxxxxxxx",
"installed": true
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2026-01-05 | 新增 OpenAPI | 查看变更详情 |