Configure MSE Gateway Plugin via CreatePluginConfig API - MSE - Alibaba Cloud - Microservices Engine

Creates a plug-in configuration.

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:CreatePluginConfig

create

*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-ubuwqygbq4783gqb2y3f87q****
PluginId	integer	Yes	The ID of the gateway plug-in.	20
ConfigLevel	integer	Yes	The application scope of the plug-in. Valid values: 0: Global. 1: Route. 2: Domain name.	1
Config	string	No	The plug-in configuration. The configuration content of a Wasm plug-in is in YAML format, and the configuration content of a Lua plug-in is Lua code.	name: John age: 18 friends: - David - Anne
Enable	boolean	Yes	Specifies whether to enable the plug-in.	true
ResourceIdList	array	No	The list of domain name IDs or route IDs. The specific type depends on the value of ConfigLevel.
	integer	No	The ID.	200
AcceptLanguage	string	No	The language in which the response is displayed. Valid values: zh: Chinese. This is the default value. en: English.	zh

Response elements

Element	Type	Description	Example
	object	RestResult
RequestId	string	The request ID.	03A3E2F4-6804-5663-9D5D-2EC47A1*****
PluginConfigID	integer	The ID of the plug-in configuration.	10

Examples

Success response

JSON format

{
  "RequestId": "03A3E2F4-6804-5663-9D5D-2EC47A1*****",
  "PluginConfigID": 10
}

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.