AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 微服务引擎 开发参考 API参考（mse） API参考指南 API目录 云原生网关 插件市场 GetPluginConfig - 获取插件配置

GetPluginConfig - 获取插件配置

更新时间：
产品详情
我的收藏

获取插件配置。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mse:GetPluginConfig

get

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

 无 无

请求参数

名称

类型

必填

描述

示例值
GatewayUniqueId

string

是

网关 UniqueId。

gw-ubuwqygbq4783gqb2y3f87q****

PluginId

integer

是

网关插件 ID。

123
AcceptLanguage

string

否

返回信息的语言类型：

zh：中文 en：英文

zh

返回参数

名称

类型

描述

示例值

object

RestResult

RequestId

string

请求 ID。

03A3E2F4-6804-5663-9D5D-2EC47A1*****
Success

boolean

是否成功。

true
Code

integer

Code。

200
ErrorCode

string

错误码。

500
HttpStatusCode

integer

HTTP STATUS 编码。

200
Message

string

接口信息。

success
DynamicCode

string

动态错误编码。

code
DynamicMessage

string

动态错误信息。

message
Data

object

返回数据。

Id

integer

插件 ID。

1
PrimaryUser

string

创建人 ID。

123
Type

integer

插件类型：

  • 0：http filter

  • 1：network filte

0
Category

integer

插件目录。

自定义：0

认证权限：1

安全防护：2

传输协议：3

流量管控：4

流量观测：5

0
Name

string

插件名称。

name
Version

string

插件版本。

v1
Summary

string

插件概要。

这是一个插件。
SummaryEn

string

Readme

string

README 描述。

read me
ReadmeEn

string

英文 README 描述。

read me
ConfigExample

string

插件配置样例

Phase

integer

插件执行阶段。

默认阶段：0

认证阶段：1

鉴权阶段：2

统计阶段：3

0
Priority

integer

插件执行优先级。数值越大，优先级越高。

1
ConfigCheck

string

配置校验。

# 配置必须字段的校验，如下例所示，要求插件配置必须存在 "name"、"age"、“friends” 字段 name: John age: 18 friends: - David - Anne
Mode

integer

模式。

0
WasmLang

integer

wasm 实现语言。

C++：0

TinyGo：1

Rust：2

AssemblyScript：3

Zig：4

0
ImageName

string

镜像名称。

name
PublishState

integer

发布状态。

1
Status

string

启用状态。

未启用：0

启用：1

1
GatewayConfigList

array

网关插件配置列表。

object

数据对象。

Id

integer

插件配置 ID。

1
GatewayId

integer

网关 ID。

1
GatewayUniqueId

string

网关 UniqueId。

gw-ubuwqygbq4783gqb2y3f87q****
PluginId

integer

网关插件 ID。

1
Enable

boolean

是否开启。

true
Config

string

插件配置。

# 配置必须字段的校验，如下例所示，要求插件配置必须存在 "name"、"age"、“friends” 字段 name: John age: 18 friends: - David - Anne
ConfigLevel

integer

插件应用范围。

全局：0

域名：1

路由：2

0
ResourceList

array

域名/路由资源列表（根据 ConfigLevel 区分）

object

Id

integer

Name

string

资源名称（域名/路由名）

test-route
GmtCreate

string

创建时间。

1667309705000
GmtModified

string

更新时间。

1667309705000
RouteConfigStartIndex

integer

路由级规则在 GatewayConfigList 中的起始下标。若不存在路由级规则，值为-1

0
DomainConfigStartIndex

integer

域名级规则在 GatewayConfigList 中的起始下标。若不存在域名级规则，值为-1

5
GatewayConfigStartIndex

integer

实例规则在 GatewayConfigList 中的下标。若不存在实例级规则，值为-1

7
VersionJson

string

网关插件版本信息列表。

[{"id":1, "version": "1.0.0"}]

示例

正常返回示例

JSON格式

{
  "RequestId": "03A3E2F4-6804-5663-9D5D-2EC47A1*****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "500",
  "HttpStatusCode": 200,
  "Message": "success",
  "DynamicCode": "code",
  "DynamicMessage": "message",
  "Data": {
    "Id": 1,
    "PrimaryUser": "123",
    "Type": 0,
    "Category": 0,
    "Name": "name",
    "Version": "v1",
    "Summary": "这是一个插件。",
    "SummaryEn": "",
    "Readme": "read me",
    "ReadmeEn": "read me",
    "ConfigExample": "",
    "Phase": 0,
    "Priority": 1,
    "ConfigCheck": "# 配置必须字段的校验，如下例所示，要求插件配置必须存在 \"name\"、\"age\"、“friends” 字段\nname: John\nage: 18\nfriends:\n- David\n- Anne",
    "Mode": 0,
    "WasmLang": 0,
    "ImageName": "name",
    "PublishState": 1,
    "Status": "1",
    "GatewayConfigList": [
      {
        "Id": 1,
        "GatewayId": 1,
        "GatewayUniqueId": "gw-ubuwqygbq4783gqb2y3f87q****",
        "PluginId": 1,
        "Enable": true,
        "Config": "# 配置必须字段的校验，如下例所示，要求插件配置必须存在 \"name\"、\"age\"、“friends” 字段\nname: John\nage: 18\nfriends:\n- David\n- Anne",
        "ConfigLevel": 0,
        "ResourceList": [
          {
            "Id": 0,
            "Name": "test-route"
          }
        ],
        "GmtCreate": "1667309705000",
        "GmtModified": "1667309705000"
      }
    ],
    "RouteConfigStartIndex": 0,
    "DomainConfigStartIndex": 5,
    "GatewayConfigStartIndex": 7,
    "VersionJson": "[{\"id\":1, \"version\": \"1.0.0\"}]"
  }
}

错误码

HTTP status code

错误码

错误信息

描述
400 IllegalRequest Invalid request:%s 非法请求： %s
400 InvalidParameter Parameter error:%s 请求参数错误：%s
500 InternalError Console error. Try again later:%s 控制台错误.稍后重试：%s
403 NoPermission You are not authorized to perform this operation:%s 没有权限使用此接口：%s
404 NotFound Not found:%s 资源不存在：%s

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

变更历史

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

上一篇：GetPlugins - 获取插件列表下一篇：CreatePluginConfig - 创建插件配置