GetPlugins - Microservices Engine - Alibaba Cloud Documentation Center

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 gateway ID.	gw-0adf3ad751284cc69fcf9669fba*****
Category	integer	No	The plugin type: 0: user-defined 1: permission authorization 2: security protection 3: transport protocol 4: traffic control 5: traffic observation	1
EnableOnly	boolean	No	Specifies whether to enable the plug-in.	true
Name	string	No	The name of the plug-in.	key-auth
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Parameter	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	03A3E2F4-6804-5663-9D5D-2EC47A1*****
Success	boolean	Indicates whether the request was successful.	true
Code	integer	The code.	200
ErrorCode	string	The error code.	500
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The operation.	success
DynamicCode	string	The dynamic part in the error message.	code
DynamicMessage	string	The dynamic error message.	message
Data	array	The response data.
	object	The information about the array object.
Id	integer	The plug-in ID.	1
PrimaryUser	string	The creator ID.	123
Category	integer	The plugin type: 0: user-defined 1: permission authorization 2: security protection 3: transport protocol 4: traffic control 5: traffic observation	0
Name	string	The name of the plug-in.	key-auth
Version	string	The version of the plug-in.	v1
Summary	string	The summary of the plug-in.	This is a plug-in.
SummaryEn	string
Phase	integer	The execution phase of the plug-in: 0: default phase 1: authentication phase 2: authorization phase 3: statistics phase	1
Priority	integer	The execution priority of the plug-in. A greater value specifies a higher priority.	1
ConfigCheck	string	The information about the configuration check.	\# The configuration includes the fields required for checking, such as name, age, and friends. Sample configuration: name: John age: 18 friends: - David - Anne
WasmLang	integer	The implementation language of WebAssembly (Wasm): 0: C++ 1: TinyGo 2: Rust 3: AssemblyScript 4: Zig	0
PublishState	integer	The publishing status: 0: The operation is successful 1: Publishing in progress 2: Publishing failed	1
WasmFile	string	The OSS of the Wasm plug-in.	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	Indicates whether the plug-in is enabled. 0: disabled 1: enabled	1
Mode	integer	The plug-in language: 0: WASM plug-in 2: LUA plug-in	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": "This is a plug-in.\n",
      "SummaryEn": "",
      "Phase": 1,
      "Priority": 1,
      "ConfigCheck": "\\# The configuration includes the fields required for checking, such as name, age, and friends. Sample configuration: name: John age: 18 friends: - David - 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.