Build and Bind Custom Plugins via API Gateway - API Gateway

Operation description

This operation is intended for API providers.
The number of plug-ins of the same type that each user can create is limited. Different limits apply to different plug-in types.
The plug-in definitions for advanced features are restricted.
Plug-ins must be bound to APIs to take effect. After a plug-in is bound, it takes effect on that API immediately.

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

apigateway:CreatePlugin

create

*Plugin

acs:apigateway:{#regionId}:{#accountId}:plugin/*

None

Request parameters

Parameter	Type	Required	Description	Example
PluginName	string	Yes	The name of the plug-in. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (_). However, it cannot start with an underscore.	NewCors
PluginType	string	Yes	The type of the plug-in. Valid values: ipControl: IP address-based access control trafficControl: throttling backendSignature: backend signature jwtAuth :JWT (OpenId Connect) authentication cors :cross-origin resource sharing (CORS) caching	cors
PluginData	string	Yes	The plug-in definition. Supported formats: JSON and YAML.	--- unit: SECOND apiDefault: 1000 userDefault: 30 appDefault: 30 specials: - type: "APP" policies: - key: 10123123 value: 10 - key: 10123123 value: 10
Description	string	No	The description of the plug-in. The description can contain a maximum of 200 characters in length.	createPlugin
Tag	array<object>	No	The tag of objects that match the rule. You can specify multiple tags.	Key， Value
	object	No
Key	string	Yes	The key of the tag. N can be an integer from 1 to 20.``	env
Value	string	Yes	The value of the tag. N can be an integer from 1 to 20.``	' '

Response elements

Element	Type	Description	Example
	object
PluginId	string	The ID of the plug-in.	1f3bde29b43d4d53989248327ff737f2
TagStatus	boolean	Indicates whether the plug-in is successfully marked.	true
RequestId	string	The ID of the request.	EF924FE4-2EDD-4CD3-89EC-34E4708574E7

Examples

Success response

JSON format

{
  "PluginId": "1f3bde29b43d4d53989248327ff737f2",
  "TagStatus": true,
  "RequestId": "EF924FE4-2EDD-4CD3-89EC-34E4708574E7"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.