Use GetPlugins to retrieve plugins from the plugin marketplace - Microservices Engine - Alibaba Cloud - Microservices Engine

Retrieves plugins from the plugin marketplace.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:GetPlugins

get

*Gateway

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

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayUniqueId	string	Yes	The unique ID of the gateway.	gw-0adf3ad751284cc69fcf9669fba*****
Category	integer	No	The category of the plugin. Valid values: 0: user-defined 1: authentication and authorization 2: security protection 3: transport protocol 4: traffic control 5: traffic monitoring	1
EnableOnly	boolean	No	If true, returns only enabled plugins.	true
Name	string	No	The name of the plugin.	key-auth
AcceptLanguage	string	No	The language of the response. Valid values: zh (Chinese) and en (English).	zh

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	03A3E2F4-6804-5663-9D5D-2EC47A1*****
Success	boolean	Indicates whether the operation was successful.	true
Code	integer	The response code.	200
ErrorCode	string	The error code.	500
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	success
DynamicCode	string	The placeholder in the dynamic error message.	code
DynamicMessage	string	The dynamic error message.	message
Data	array<object>	A list of plugins.
	object	The details of the plugin.
Id	integer	The plugin ID.	1
PrimaryUser	string	The ID of the creator.	123
Category	integer	The plugin category. Valid values: 0: user-defined 1: authentication and authorization 2: security protection 3: transport protocol 4: traffic control 5: traffic monitoring	0
Name	string	The plugin name.	key-auth
Version	string	The plugin version.	v1
Summary	string	The plugin summary.	这是一个插件
SummaryEn	string	The English summary.
Phase	integer	The plugin execution phase. Valid values: 0: default phase 1: authentication phase 2: authorization phase 3: statistics phase	1
Priority	integer	The plugin execution priority. A higher value indicates a higher priority.	1
ConfigCheck	string	The configuration validation schema.	# 配置必须字段的校验，如下例所示，要求插件配置必须存在 "name"、"age"、“friends” 字段 name: John age: 18 friends: - David - Anne
WasmLang	integer	The language in which the Wasm plugin is implemented. Valid values: 0: C++ 1: TinyGo 2: Rust 3: AssemblyScript 4: Zig	0
PublishState	integer	The publishing status. Valid values: 0: Succeeded 1: Publishing 2: Failed	1
WasmFile	string	The OSS URL of the Wasm plugin.	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	The plugin status. Valid values: 0: disabled 1: enabled	1
Mode	integer	The plugin type. Valid values: 0: Wasm plugin 2: Lua plugin	0
MaxVersion	string	The latest version.	1.0.0
NewVersionPublishingFlag	boolean	Indicates whether the latest version is being published.	false

Examples

Success response

JSON format

{
  "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
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.