文档

GetPlugins - 获取插件列表

更新时间:

获取插件市场插件。

调试

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

授权信息

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

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

请求参数

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

网关 ID。

gw-0adf3ad751284cc69fcf9669fba*****
Categoryinteger

插件类型:

  • 自定义:0

  • 认证权限:1

  • 安全防护:2

  • 传输协议:3

  • 流量管控:4

  • 流量观测:5

1
EnableOnlyboolean

是否已启用。

true
Namestring

插件名称。

key-auth
AcceptLanguagestring

返回信息的语言类型:

zh:中文 en:英文

zh

返回参数

名称类型描述示例值
object

返回数据。

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
Categoryinteger

插件类型:

自定义:0

认证权限:1

安全防护:2

传输协议:3

流量管控:4

流量观测:5

0
Namestring

插件名称。

key-auth
Versionstring

插件版本。

v1
Summarystring

插件概要。

这是一个插件
Phaseinteger

插件执行阶段:

  • 默认阶段:0

  • 认证阶段:1

  • 鉴权阶段:2

  • 统计阶段:3

1
Priorityinteger

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

1
ConfigCheckstring

配置校验。

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

Wasm 实现语言:

  • C++:0

  • TinyGo:1

  • Rust:2

  • AssemblyScript:3

  • Zig:4

0
PublishStateinteger

发布状态:

  • 0:成功
  • 1:发布中
  • 2:发布失败
1
WasmFilestring

Wasm 插件 OSS。

https://mse-shared-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/cfg/import/1917515******/gw-0adf3ad751284cc69fcf9669fba*****/2022/11/02/4d390496-2c17-4b42-a479-f9068ba****/16673573***5.wasm
Statusstring

启用状态。

  • 未启用:0

  • 启用:1

1
Modeinteger

插件语言:

  • 0:WASM 插件
  • 2:LUA 插件
0
MaxVersionstring

最新版本。

1.0.0
NewVersionPublishingFlagboolean

最新版本是否正在发布中。

false

示例

正常返回示例

JSON格式

{
  "RequestId": "03A3E2F4-6804-5663-9D5D-2EC47A1*****\n",
  "Success": true,
  "Code": 200,
  "ErrorCode": "500",
  "HttpStatusCode": 200,
  "Message": "success",
  "DynamicCode": "code",
  "DynamicMessage": "message",
  "Data": [
    {
      "Id": 1,
      "PrimaryUser": "123",
      "Category": 0,
      "Name": "key-auth",
      "Version": "v1",
      "Summary": "这是一个插件",
      "Phase": 1,
      "Priority": 1,
      "ConfigCheck": "# 配置必须字段的校验,如下例所示,要求插件配置必须存在 \"name\"、\"age\"、“friends” 字段\nname: John\nage: 18\nfriends:\n- David\n- Anne\n",
      "WasmLang": 0,
      "PublishState": 1,
      "WasmFile": "https://mse-shared-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/cfg/import/1917515******/gw-0adf3ad751284cc69fcf9669fba*****/2022/11/02/4d390496-2c17-4b42-a479-f9068ba****/16673573***5.wasm",
      "Status": "1",
      "Mode": 0,
      "MaxVersion": "1.0.0",
      "NewVersionPublishingFlag": false
    }
  ]
}

错误码

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

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

  • 本页导读 (1)
文档反馈