获取插件挂载列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
apig:ListPluginAttachments |
none |
*全部资源
|
无 | 无 |
请求语法
GET /v1/plugin-attachments HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| attachResourceId |
string |
否 |
挂载资源 ID |
hr-cv2h58em1hkg7c6vt43g |
| attachResourceType |
string |
否 |
插件挂载点类型，暂未启用 枚举值：
|
GatewayRoute |
| environmentId |
string |
否 |
环境 ID。 |
env-crlnqhtlhtgqflkqislg |
| pluginId |
string |
否 |
插件 ID |
pl-ct8181um1hkiqns9f6e0 |
| gatewayId |
string |
否 |
网关 ID。 |
gw-cr79f75lhtgme744084g |
| pageNumber |
integer |
否 |
页码，默认 1 |
1 |
| pageSize |
integer |
否 |
分页大小 |
10 |
| attachResourceTypes |
string |
否 |
挂载点类型，多个以逗号隔开 |
GatewayRoute |
| withParentResource |
boolean |
否 |
是否需要返回父级资源挂载 |
false |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
Id of the request |
9640D776-794A-5077-9184-A247CA4B45C1 |
| code |
string |
响应状态码。 |
Ok |
| message |
string |
响应消息。 |
success |
| data |
object |
响应数据。 |
|
| pageNumber |
integer |
页码。 |
1 |
| pageSize |
integer |
分页大小。 |
10 |
| totalSize |
integer |
总数量。 |
10 |
| items |
array<object> |
Item 详情。 |
|
|
object |
结果对象 |
||
| pluginAttachmentId |
string |
插件挂载 ID。 |
pa-d0j9t5em1hkncrlo51mg |
| parentResourceInfo | ParentResourceInfo |
父级资源信息 |
|
| resourceInfos |
array |
挂载资源信息。 |
|
| ResourceInfo |
挂载资源信息。 |
||
| environmentInfo | EnvironmentInfo |
环境信息。 |
|
| enable |
boolean |
是否启用。 |
true |
| pluginId |
string |
插件 ID |
pl-cvu6r4um1hko3b3ti0a0 |
| pluginConfig |
string |
插件配置原文的 base64 内容 |
bGltaXRfYnlfaGVhZGVyOiB4LWFwaS1rZXkKbGltaXRfa2V5czoKLSBrZXk6IGV4YW1wbGUta2V5LWEKICBxdWVyeV9wZXJfc2Vjb25kOiAxMAotIGtleTogZXhhbXBsZS1rZXktYgogIHF1ZXJ5X3Blcl9zZWNvbmQ6IDEK |
| pluginClassInfo | PluginClassInfo |
插件类型信息 |
|
| attachResourceType |
string |
插件挂载资源类型，GatewayRoute、Gateway、GatewayDomain、HttpApi、Operation |
GatewayRoute |
示例
正常返回示例
JSON格式
{
"requestId": "9640D776-794A-5077-9184-A247CA4B45C1",
"code": "Ok",
"message": "success",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalSize": 10,
"items": [
{
"pluginAttachmentId": "pa-d0j9t5em1hkncrlo51mg",
"parentResourceInfo": {
"resourceType": "Gateway"
},
"resourceInfos": [
{
"resourceType": "HttpApi",
"resourceId": "api-1nsu2d****",
"resourceName": "test1023",
"resourceVersion": "1.0.0"
}
],
"environmentInfo": {
"environmentId": "env-cq7l5s5lhtgi6qasrdc0",
"name": "test",
"alias": "测试环境",
"description": "这是xxx的xx项目测试环境",
"gatewayInfo": {
"gatewayId": "gw-cq7og15lhtgi6qasrj60",
"name": "apitest-gw",
"vpcInfo": {
"vpcId": "vpc-uf664nyle5kh***",
"name": "商品中心预发环境专有网络"
},
"engineVersion": "2.0.7",
"gatewayEdition": "MultiTenantServerless"
},
"subDomainInfos": [
{
"domainId": "d-cpudb0llhtgl2djvq2sg",
"name": "abc.com",
"protocol": "HTTP",
"networkType": "Intranet"
}
],
"default": false,
"createTimestamp": 1721116090326,
"updateTimestamp": 1721116090326,
"resourceGroupId": "rg-xxxx"
},
"enable": true,
"pluginId": "pl-cvu6r4um1hko3b3ti0a0",
"pluginConfig": "bGltaXRfYnlfaGVhZGVyOiB4LWFwaS1rZXkKbGltaXRfa2V5czoKLSBrZXk6IGV4YW1wbGUta2V5LWEKICBxdWVyeV9wZXJfc2Vjb25kOiAxMAotIGtleTogZXhhbXBsZS1rZXktYgogIHF1ZXJ5X3Blcl9zZWNvbmQ6IDEK",
"pluginClassInfo": {
"pluginClassId": "cls-xxx",
"type": "AI",
"mode": "Wasm",
"name": "ai-security-guard",
"alias": "AI安全护栏",
"description": "AI请求内容安全检测插件",
"source": "HigressOfficial",
"version": "1.0.0",
"versionDescription": "初始版本",
"executeStage": "AUTHN",
"executePriority": 100,
"configExample": "{\"checkRequest\":true}",
"imageName": "higress-registry.tencentcloudcr.com/ai-security-guard",
"wasmLanguage": "Rust",
"supportedMinGatewayVersion": "2.1.11",
"wasmUrl": "https://...",
"innerPlugin": false
},
"attachResourceType": "GatewayRoute"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。