GetPlugins - 获取插件列表 - 微服务引擎MSE

获取插件市场插件。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
mse:GetPlugins	get	*Gateway `acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}`	无	无

请求参数

名称	类型	必填	描述	示例值
GatewayUniqueId	string	是	网关 ID。	gw-0adf3ad751284cc69fcf9669fba*****
Category	integer	否	插件类型：自定义：0 认证权限：1 安全防护：2 传输协议：3 流量管控：4 流量观测：5	1
EnableOnly	boolean	否	是否已启用。	true
Name	string	否	插件名称。	key-auth
AcceptLanguage	string	否	返回信息的语言类型： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object	返回数据。
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	array<object>	返回数据。
Data	object	对象。
Id	long	插件 ID。	1
PrimaryUser	string	创建人 ID。	123
Category	integer	插件类型：自定义：0 认证权限：1 安全防护：2 传输协议：3 流量管控：4 流量观测：5	0
Name	string	插件名称。	key-auth
Version	string	插件版本。	v1
Summary	string	插件概要。	这是一个插件
Phase	integer	插件执行阶段：默认阶段：0 认证阶段：1 鉴权阶段：2 统计阶段：3	1
Priority	integer	插件执行优先级。数值越大，优先级越高。	1
ConfigCheck	string	配置校验。	# 配置必须字段的校验，如下例所示，要求插件配置必须存在 "name"、"age"、“friends” 字段 name: John age: 18 friends: - David - Anne
WasmLang	integer	Wasm 实现语言： C++：0 TinyGo：1 Rust：2 AssemblyScript：3 Zig：4	0
PublishState	integer	发布状态： 0：成功 1：发布中 2：发布失败	1
WasmFile	string	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
Status	string	启用状态。未启用：0 启用：1	1
Mode	integer	插件语言： 0：WASM 插件 2：LUA 插件	0
MaxVersion	string	最新版本。	1.0.0
NewVersionPublishingFlag	boolean	最新版本是否正在发布中。	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": "这是一个插件",
      "SummaryEn": "",
      "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	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s

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

变更历史

变更时间	变更内容概要	操作
2024-12-03	OpenAPI 返回结构发生变更	查看变更详情