调用GetPluginAttachment查询插件挂载-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

查询插件挂载。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:GetPluginAttachment

get

*全部资源

*

无

请求语法

GET /v1/plugin-attachments/{pluginAttachmentId} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
pluginAttachmentId	string	否	插件挂载 ID。	pa-cvl541em1hkk7n8vq810

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object	Schema of Response
code	string	响应状态码。	Ok
data	object	响应数据。
enable	boolean	是否启用。	true
environmentInfo	EnvironmentInfo	环境信息。
gatewayInfo	GatewayInfo	网关信息。
parentResourceInfo	ParentResourceInfo	父级挂载资源信息。
pluginAttachmentId	string	插件挂载 ID。	pa-d05f1tmm1hku195dd8j0
pluginClassInfo	PluginClassInfo	插件类型信息
pluginConfig	string	插件配置原文的 base64 内容	cHJlcGVuZDoKLSByb2xlOiBzeXN0ZW0KICBjb250ZW50OiDor7fkvb/nlKjoi7Hor63lm57nrZTpl67popgKYXBwZW5kOgotIHJvbGU6IHVzZXIKICBjb250ZW50OiDmr4/mrKHlm57nrZTlrozpl67popjvvIzlsJ3or5Xov5vooYzlj43pl64K
pluginId	string	插件 ID	pl-cvo8ub6m1hkvgv03r3k0
resourceInfos	array	挂载资源信息列表。
	ResourceInfo	挂载资源信息。
message	string	响应消息。	success
requestId	string	Id of the request	C61E30D3-579A-5B43-994E-31E02EDC9129

示例

正常返回示例

JSON格式

{
  "code": "Ok",
  "data": {
    "enable": true,
    "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"
    },
    "gatewayInfo": {
      "gatewayId": "gw-cq7og15lhtgi6qasrj60",
      "name": "apitest-gw",
      "vpcInfo": {
        "vpcId": "vpc-uf664nyle5kh***",
        "name": "商品中心预发环境专有网络"
      },
      "engineVersion": "2.0.7",
      "gatewayEdition": "MultiTenantServerless"
    },
    "parentResourceInfo": {
      "resourceType": "Gateway"
    },
    "pluginAttachmentId": "pa-d05f1tmm1hku195dd8j0",
    "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
    },
    "pluginConfig": "cHJlcGVuZDoKLSByb2xlOiBzeXN0ZW0KICBjb250ZW50OiDor7fkvb/nlKjoi7Hor63lm57nrZTpl67popgKYXBwZW5kOgotIHJvbGU6IHVzZXIKICBjb250ZW50OiDmr4/mrKHlm57nrZTlrozpl67popjvvIzlsJ3or5Xov5vooYzlj43pl64K",
    "pluginId": "pl-cvo8ub6m1hkvgv03r3k0",
    "resourceInfos": [
      {
        "resourceType": "HttpApi",
        "resourceId": "api-1nsu2d****",
        "resourceName": "test1023",
        "resourceVersion": "1.0.0"
      }
    ]
  },
  "message": "success",
  "requestId": "C61E30D3-579A-5B43-994E-31E02EDC9129"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。