文档

GetPluginConfig - 获取插件配置

更新时间:

获取插件配置。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:GetPluginConfigRead
  • Gateway
    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

请求参数

名称类型必填描述示例值
GatewayUniqueIdstring

网关 UniqueId。

gw-ubuwqygbq4783gqb2y3f87q****
PluginIdlong

网关插件 ID。

123
AcceptLanguagestring

返回信息的语言类型:

zh:中文 en:英文

zh

返回参数

名称类型描述示例值
object

RestResult

RequestIdstring

请求 ID。

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

是否成功。

true
Codeinteger

Code。

200
ErrorCodestring

错误码。

500
HttpStatusCodeinteger

HTTP STATUS 编码。

200
Messagestring

接口信息。

success
DynamicCodestring

动态错误编码。

code
DynamicMessagestring

动态错误信息。

message
Dataobject

返回数据。

Idlong

插件 ID。

1
PrimaryUserstring

创建人 ID。

123
Typeinteger

插件类型:

  • 0:http filter
  • 1:network filte
0
Categoryinteger

插件目录。

自定义:0

认证权限:1

安全防护:2

传输协议:3

流量管控:4

流量观测:5

0
Namestring

插件名称。

name
Versionstring

插件版本。

v1
Summarystring

插件概要。

这是一个插件。
Readmestring

README 描述。

read me
ReadmeEnstring

英文 README 描述。

read me
ConfigExamplestring

插件配置样例

Phaseinteger

插件执行阶段。

默认阶段:0

认证阶段:1

鉴权阶段:2

统计阶段:3

0
Priorityinteger

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

1
ConfigCheckstring

配置校验。

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

模式。

0
WasmLanginteger

wasm 实现语言。

C++:0

TinyGo:1

Rust:2

AssemblyScript:3

Zig:4

0
ImageNamestring

镜像名称。

name
PublishStateinteger

发布状态。

1
Statusstring

启用状态。

未启用:0

启用:1

1
GatewayConfigListarray<object>

网关插件配置列表。

object

数据对象。

Idlong

插件配置 ID。

1
GatewayIdlong

网关 ID。

1
GatewayUniqueIdstring

网关 UniqueId。

gw-ubuwqygbq4783gqb2y3f87q****
PluginIdlong

网关插件 ID。

1
Enableboolean

是否开启。

true
Configstring

插件配置。

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

插件应用范围。

全局:0

域名:1

路由:2

0
ResourceListarray<object>

域名/路由资源列表(根据 ConfigLevel 区分)

object
Namestring

资源名称(域名/路由名)

test-route
GmtCreatestring

创建时间。

1667309705000
GmtModifiedstring

更新时间。

1667309705000
RouteConfigStartIndexinteger

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

0
DomainConfigStartIndexinteger

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

5
GatewayConfigStartIndexinteger

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

7
VersionJsonstring

网关插件版本信息列表。

[{"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": "这是一个插件。",
    "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错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

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

变更历史

变更时间变更内容概要操作
2024-06-03OpenAPI 返回结构发生变更查看变更详情
2023-05-18API 内部配置变更,不影响调用查看变更详情